goog.ui.tree.TreeControl Classgoog.ui.tree.TreeControl
> goog.ui.tree.BaseNode
> goog.ui.Component
> goog.events.EventTarget
> goog.Disposable
goog.ui.tree.TreeControl(html, opt_config, opt_domHelper)This creates a TreeControl object. A tree control provides a way to view a hierarchical set of data.
html {string}
opt_config {Object=}
opt_domHelper {goog.dom.DomHelper=}
.add(child, opt_before)Inherited from goog.ui.tree.BaseNode .
Adds a node as a child to the current node.
child {goog.ui.tree.BaseNode}
opt_before {goog.ui.tree.BaseNode=}
goog.ui.tree.BaseNode}
.addChild(child, opt_render)Inherited from goog.ui.Component .
Adds the specified component as the last child of this component. See {@link goog.ui.Component#addChildAt} for detailed semantics.
child {goog.ui.Component}
opt_render {boolean=}
.addChildAt(child, index, opt_render)Inherited from goog.ui.tree.BaseNode .
The method assumes that the child doesn't have parent node yet. The {@code opt_render} argument is not used. If the parent node is expanded, the child node's state will be the same as the parent's. Otherwise the child's DOM tree won't be created.
child {goog.ui.Component}
index {number}
opt_render {boolean=}
void}
.addEventListener(type, handler, opt_capture, opt_handlerScope)Inherited from goog.events.EventTarget .
Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.
type {string}
handler {Function|Object}
opt_capture {boolean=}
opt_handlerScope {Object=}
.addOnDisposeCallback(callback, opt_scope)Inherited from goog.Disposable .
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
callback {!Function}
opt_scope {Object=}
.canDecorate(element)Inherited from goog.ui.Component .
Determines if a given element can be decorated by this type of component. This method should be overridden by inheriting objects.
element {Element}
boolean}
.clearTypeAhead()Clear the typeahead buffer.
.collapse()Inherited from goog.ui.tree.BaseNode .
Collapses the node.
.collapseAll()Inherited from goog.ui.tree.BaseNode .
Collapses the children and the node.
.collapseChildren()Inherited from goog.ui.tree.BaseNode .
Collapses the children of the node.
.contains(node)Inherited from goog.ui.tree.BaseNode .
Returns true if the node is a descendant of this node
node {goog.ui.tree.BaseNode}
boolean}
.createDom()Inherited from goog.ui.tree.BaseNode .
Creates the initial DOM representation for the component. The default implementation is to set this.element_ = div.
.createNode(html)Creates a new tree node using the same config as the root.
html {string}
goog.ui.tree.TreeNode}
.creationStack {string}Inherited from goog.Disposable .
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
.decorate(element)Inherited from goog.ui.Component .
Decorates the element for the UI component.
element {Element}
.decorateInternal(element) [protected]Inherited from goog.ui.Component .
Actually decorates the element. Should be overridden by inheriting objects. This method can assume there are checks to ensure the component has not already been rendered have occurred and that enter document will be called afterwards. This method is considered protected.
element {Element}
.defaultConfigA default configuration for the tree.
.deselect [deprecated]Deprecated. Use {@code tree.setSelectedItem(null)}.
Inherited from goog.ui.tree.BaseNode .
Originally it was intended to deselect the node but never worked.
.dispatchEvent(e)Inherited from goog.events.EventTarget .
Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.
e {string|Object|goog.events.Event}
boolean}
.dispose()Inherited from goog.Disposable .
Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
void}
.disposeInternal() [protected]Inherited from goog.ui.tree.BaseNode .
Disposes of the component. Calls {@code exitDocument}, which is expected to remove event handlers and clean up the component. Propagates the call to the component's children, if any. Removes the component's DOM from the document unless it was decorated.
.dom_ [protected] {!goog.dom.DomHelper}Inherited from goog.ui.Component .
DomHelper used to interact with the document, allowing components to be created in a different window.
.enterDocument()Called when the component's element is known to be in the document. Anything using document.getElementById etc. should be done at this stage. If the component contains child components, this call is propagated to its children.
.exitDocument()Called by dispose to clean up the elements and listeners created by a component, or by a parent component/application who has removed the component from the document but wants to reuse it later. If the component contains child components, this call is propagated to its children. It should be possible for the component to be rendered again once this method has been called.
.expand()Inherited from goog.ui.tree.BaseNode .
Expands the node.
.expandAll()Inherited from goog.ui.tree.BaseNode .
Expands the children and the node.
.expandChildren()Inherited from goog.ui.tree.BaseNode .
Expands the children of the node.
.forEachChild(f, opt_obj)Inherited from goog.ui.Component .
Calls the given function on each of this component's children in order. If {@code opt_obj} is provided, it will be used as the 'this' object in the function when called. The function should take two arguments: the child component and its 0-based index. The return value is ignored.
f {Function}
opt_obj {Object=}
.getAfterLabelElement()Inherited from goog.ui.tree.BaseNode .
Element}
.getAfterLabelHtml()Inherited from goog.ui.tree.BaseNode .
Returns the html that appears after the label. This is useful if you want to put extra UI on the row of the label but not inside the anchor tag.
string}
.getCalculatedIconClass() [protected]Returns the source for the icon.
string}
.getChild(id)Inherited from goog.ui.Component .
Returns the child with the given ID, or null if no such child exists.
id {string}
goog.ui.Component?}
.getChildAtInherited from goog.ui.tree.BaseNode .
index {number}
goog.ui.tree.BaseNode}
.getChildCount()Inherited from goog.ui.Component .
Returns the number of children of this component.
number}
.getChildIds()Inherited from goog.ui.Component .
Returns an array containing the IDs of the children of this component, or an empty array if the component has no children.
Array.<string>}
.getChildren()Inherited from goog.ui.tree.BaseNode .
Returns the children of this node.
Array.<!goog.ui.tree.BaseNode>}
.getChildrenElement() [protected]Inherited from goog.ui.tree.BaseNode .
Element}
.getClientData [deprecated]Deprecated. Use {@link #getModel} instead.
Inherited from goog.ui.tree.BaseNode .
.getConfig()Inherited from goog.ui.tree.BaseNode .
Object}
.getContentElement()Inherited from goog.ui.Component .
Returns the DOM element into which child components are to be rendered, or null if the component itself hasn't been rendered yet. This default implementation returns the component's root element. Subclasses with complex DOM structures must override this method.
Element}
.getDepth()Returns the depth of the node in the tree. Should not be overridden.
number}
.getDisposed [deprecated]Deprecated. Use {@link #isDisposed} instead.
Inherited from goog.Disposable .
boolean}
.getDomHelper()Inherited from goog.ui.Component .
Returns the dom helper that is being used on this component.
goog.dom.DomHelper}
.getElement()Inherited from goog.ui.tree.BaseNode .
Gets the component's element.
Element}
.getElementByClass(className)Inherited from goog.ui.Component .
Returns the first element in this component's DOM with the provided className.
className {string}
Element}
.getElementByFragment(idFragment)Inherited from goog.ui.Component .
Helper function for returning an element in the document with a unique id generated using makeId().
idFragment {string}
Element}
.getElementsByClass(className)Inherited from goog.ui.Component .
Returns an array of all the elements in this component's DOM with the provided className.
className {string}
goog.array.ArrayLike}
.getExpandIconClass() [protected]Inherited from goog.ui.tree.BaseNode .
string}
.getExpandIconElement() [protected]Element}
.getExpandIconHtml() [protected]string}
.getExpanded()boolean}
.getExpandedIconClass()Inherited from goog.ui.tree.BaseNode .
Gets the icon class for when the node is expanded.
string}
.getFirstChild()Inherited from goog.ui.tree.BaseNode .
goog.ui.tree.BaseNode}
.getFragmentFromId(id)Inherited from goog.ui.Component .
Helper function for returning the fragment portion of an id generated using makeId().
id {string}
string}
.getHandler() [protected]Inherited from goog.ui.Component .
Returns the event handler for this component, lazily created the first time this method is called.
goog.events.EventHandler}
.getHtml()Inherited from goog.ui.tree.BaseNode .
Returns the html of the label.
string}
.getIconClass()Inherited from goog.ui.tree.BaseNode .
Gets the icon class for the node.
string}
.getIconElement() [protected]Element}
.getIconHtml() [protected]Inherited from goog.ui.tree.BaseNode .
string}
.getId()Inherited from goog.ui.Component .
Gets the unique ID for the instance of this component. If the instance doesn't already have an ID, generates one on the fly.
string}
.getLabelElement()Inherited from goog.ui.tree.BaseNode .
Element}
.getLabelHtml() [protected]Inherited from goog.ui.tree.BaseNode .
string}
.getLastChild()Inherited from goog.ui.tree.BaseNode .
goog.ui.tree.BaseNode}
.getLastShownDescendant()Inherited from goog.ui.tree.BaseNode .
goog.ui.tree.BaseNode}
.getLineStyle()Inherited from goog.ui.tree.BaseNode .
string}
.getLineStyle2()Inherited from goog.ui.tree.BaseNode .
string}
.getModel()Inherited from goog.ui.Component .
Returns the model associated with the UI component.
.getNextShownNode()Inherited from goog.ui.tree.BaseNode .
goog.ui.tree.BaseNode}
.getNextSibling()Inherited from goog.ui.tree.BaseNode .
goog.ui.tree.BaseNode}
.getParent()Inherited from goog.ui.Component .
Returns the component's parent, if any.
goog.ui.Component?}
.getParentEventTarget()Inherited from goog.events.EventTarget .
Returns the parent of this event target to use for bubbling.
goog.events.EventTarget}
.getPreviousShownNode()Inherited from goog.ui.tree.BaseNode .
goog.ui.tree.BaseNode}
.getPreviousSibling()Inherited from goog.ui.tree.BaseNode .
goog.ui.tree.BaseNode}
.getRowClassName() [protected]string}
.getRowElement()Inherited from goog.ui.tree.BaseNode .
Element}
.getRowHtml() [protected]Inherited from goog.ui.tree.BaseNode .
string}
.getSelectedItem()Returns the selected item.
goog.ui.tree.BaseNode}
.getShowExpandIcons()boolean}
.getShowLines()boolean}
.getShowRootLines()boolean}
.getShowRootNode()boolean}
.getText()Inherited from goog.ui.tree.BaseNode .
Returns the text of the label. If the text was originally set as HTML, the return value is unspecified.
string}
.getToolTip()Inherited from goog.ui.tree.BaseNode .
Returns the text of the tooltip.
string}
.getTree()Returns the tree.
.handleKeyEvent(e)Handles key down on the tree.
e {!goog.events.BrowserEvent}
boolean}
.hasChildren()Inherited from goog.ui.Component .
Returns true if the component has children.
boolean}
.hasFocus()boolean}
.indexOfChild(child)Inherited from goog.ui.Component .
Returns the 0-based index of the given child component, or -1 if no such child is found.
child {goog.ui.Component?}
number}
.initAccessibility() [protected]Add roles and states.
.isDisposed()Inherited from goog.Disposable .
boolean}
.isInDocument()Inherited from goog.ui.Component .
Determines whether the component has been added to the document.
boolean}
.isLastSibling()Inherited from goog.ui.tree.BaseNode .
boolean}
.isRightToLeft()Inherited from goog.ui.Component .
Returns true if the component is rendered right-to-left, false otherwise. The first time this function is invoked, the right-to-left rendering property is set if it has not been already.
boolean}
.isSelected()Inherited from goog.ui.tree.BaseNode .
boolean}
.isUserCollapsible()Inherited from goog.ui.tree.BaseNode .
boolean}
.makeId(idFragment)Inherited from goog.ui.Component .
Helper function for subclasses that gets a unique id for a given fragment, this can be used by components to generate unique string ids for DOM elements.
idFragment {string}
string}
.makeIds(object)Inherited from goog.ui.Component .
Makes a collection of ids. This is a convenience method for makeId. The object's values are the id fragments and the new values are the generated ids. The key will remain the same.
object {Object}
Object}
.onClick_ [protected]Inherited from goog.ui.tree.BaseNode .
Handles a click event.
e {!goog.events.BrowserEvent}
.onDoubleClick_(e) [protected]Inherited from goog.ui.tree.BaseNode .
Handles a double click event.
e {!goog.events.BrowserEvent}
.onKeyDown(e) [protected]Inherited from goog.ui.tree.BaseNode .
Handles a key down event.
e {!goog.events.BrowserEvent}
boolean}
.onMouseDown(e) [protected]Inherited from goog.ui.tree.BaseNode .
Handles mouse down event.
e {!goog.events.BrowserEvent}
.registerDisposable(disposable)Inherited from goog.Disposable .
Associates a disposable object with this object so that they will be disposed together.
disposable {goog.disposable.IDisposable}
.removeChild(childNode, opt_unrender)Inherited from goog.ui.tree.BaseNode .
Removes a child. The caller is responsible for disposing the node.
childNode {goog.ui.Component|string}
opt_unrender {boolean=}
goog.ui.tree.BaseNode}
.removeChildAt(index, opt_unrender)Inherited from goog.ui.Component .
Removes the child at the given index from this component, and returns it. Throws an error if the argument is out of bounds, or if the specified child isn't found in the parent. See {@link goog.ui.Component#removeChild} for detailed semantics.
index {number}
opt_unrender {boolean=}
goog.ui.Component}
.removeChildren(opt_unrender)Inherited from goog.ui.Component .
Removes every child component attached to this one and returns them.
opt_unrender {boolean=}
Array.<goog.ui.Component>|undefined}
.removeEventListener(type, handler, opt_capture, opt_handlerScope)Inherited from goog.events.EventTarget .
Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.
type {string}
handler {Function|Object}
opt_capture {boolean=}
opt_handlerScope {Object=}
.removeNode(node)Allows the caller to notify that the given node is being removed from the tree.
node {goog.ui.tree.BaseNode}
.render(opt_parentElement)Inherited from goog.ui.Component .
Renders the component. If a parent element is supplied, the component's element will be appended to it. If there is no optional parent element and the element doesn't have a parentNode then it will be appended to the document body. If this component has a parent component, and the parent component is not in the document already, then this will not call {@code enterDocument} on this component. Throws an Error if the component is already rendered.
opt_parentElement {Element=}
.renderBefore(sibling)Inherited from goog.ui.Component .
Renders the component before another element. The other element should be in the document already. Throws an Error if the component is already rendered.
sibling {Node}
.reveal()Expands the parent chain of this node so that it is visible.
.select()Inherited from goog.ui.tree.BaseNode .
Selects the node.
.setAfterLabelHtml(html)Inherited from goog.ui.tree.BaseNode .
Sets the html that appears after the label. This is useful if you want to put extra UI on the row of the label but not inside the anchor tag.
html {string}
.setClientData [deprecated]Deprecated. Use {@link #setModel} instead.
Inherited from goog.ui.tree.BaseNode .
Sets client data to associate with the node.
data {*}
.setElementInternal(element) [protected]Inherited from goog.ui.Component .
Sets the component's root element to the given element. Considered protected and final. This should generally only be called during createDom. Setting the element does not actually change which element is rendered, only the element that is associated with this UI component.
element {Element}
.setExpanded(expanded)Sets the node to be expanded.
expanded {boolean}
.setExpandedIconClass(s)Inherited from goog.ui.tree.BaseNode .
Sets the icon class for when the node is expanded.
s {string}
.setExpandedInternal(expanded)Inherited from goog.ui.tree.BaseNode .
Sets the node to be expanded internally, without state change events.
expanded {boolean}
.setHtml(s)Inherited from goog.ui.tree.BaseNode .
Sets the html of the label.
s {string}
.setIconClass(s)Inherited from goog.ui.tree.BaseNode .
Sets the icon class for the node.
s {string}
.setId(id)Inherited from goog.ui.Component .
Assigns an ID to this component instance. It is the caller's responsibility to guarantee that the ID is unique. If the component is a child of a parent component, then the parent component's child index is updated to reflect the new ID; this may throw an error if the parent already has a child with an ID that conflicts with the new ID.
id {string}
.setIsUserCollapsible(isCollapsible)Inherited from goog.ui.tree.BaseNode .
Sets whether the node will allow the user to collapse it.
isCollapsible {boolean}
.setModel(obj)Inherited from goog.ui.Component .
Sets the model associated with the UI component.
obj {*}
.setNode(node)Allows the caller to notify that the given node has been added or just had been updated in the tree.
node {goog.ui.tree.BaseNode}
.setParent(parent)Inherited from goog.ui.Component .
Sets the parent of this component to use for event bubbling. Throws an error if the component already has a parent or if an attempt is made to add a component to itself as a child. Callers must use {@code removeChild} or {@code removeChildAt} to remove components from their containers before calling this method.
parent {goog.ui.Component}
.setParentEventTarget(parent)Inherited from goog.ui.Component .
Overrides {@link goog.events.EventTarget#setParentEventTarget} to throw an error if the parent component is set, and the argument is not the parent.
parent {goog.events.EventTarget?}
.setRightToLeft(rightToLeft)Inherited from goog.ui.Component .
Set is right-to-left. This function should be used if the component needs to know the rendering direction during dom creation (i.e. before {@link #enterDocument} is called and is right-to-left is set).
rightToLeft {boolean}
.setSelectedInternal(selected) [protected]Inherited from goog.ui.tree.BaseNode .
Called from the tree to instruct the node change its selection state.
selected {boolean}
.setSelectedItem(node)Sets the selected item.
node {goog.ui.tree.BaseNode}
.setShowExpandIcons(b)Sets whether to show expand icons.
b {boolean}
.setShowLines(b)Sets whether to show lines.
b {boolean}
.setShowRootLines(b)Sets whether to show root lines.
b {boolean}
.setShowRootNode(b)Sets whether to show the root node.
b {boolean}
.setText(s)Inherited from goog.ui.tree.BaseNode .
Sets the text of the label.
s {string}
.setToolTip(s)Inherited from goog.ui.tree.BaseNode .
Sets the text of the tooltip.
s {string}
.setTreeInternal(tree)Inherited from goog.ui.tree.BaseNode .
Internal method that is used to set the tree control on the node.
tree {goog.ui.tree.TreeControl}
.toHtml(sb)Inherited from goog.ui.tree.BaseNode .
Returns the html for the node.
sb {goog.string.StringBuffer}
.toggle()Inherited from goog.ui.tree.BaseNode .
Toggles the expanded state of the node.
.updateExpandIcon()Updates the expand icon of the node.
.updateRow()Inherited from goog.ui.tree.BaseNode .
Updates the row styles.
.wasDecorated()Inherited from goog.ui.Component .
boolean}