ui.tree.TreeControl Extends goog.ui.tree.BaseNode
This creates a TreeControl object. A tree control provides a way to view a hierarchical set of data.

Inheritance

Constructor

goog.ui.tree.TreeControl(html, opt_config, opt_domHelper)

Parameters

html :
string
The HTML content of the node label.
opt_config :
(Object | null | undefined)
The configuration for the tree. See goog.ui.tree.TreeControl.DefaultConfig. If not specified, a default config will be used.
opt_domHelper :
(goog.dom.DomHelper | null | undefined)
Optional DOM helper.

Instance Methods

Public Protected Private
Defined in goog.ui.tree.TreeControl
attachEvents_()
Adds the event listeners to the tree.
code »
clearTypeAhead()
Clear the typeahead buffer.
code »
createNode(html) ⇒
(goog.ui.tree.TreeNode | null)
Creates a new tree node using the same config as the root.
Arguments:
html :
string
The html content of the node label.
Returns: 
(goog.ui.tree.TreeNode | null)
  The new item.
code »
detachEvents_()
Removes the event listeners from the tree.
code »
enterDocument()
No description.
code »
exitDocument()
No description.
code »
getCalculatedIconClass() ⇒
string
Returns the source for the icon.
Returns: 
string
  Src for the icon.
code »
getDepth()
No description.
code »
getExpandIconElement()
No description.
code »
getExpandIconHtml()
No description.
code »
getExpanded()
No description.
code »
getIconElement()
No description.
code »
getNodeFromEvent_(e) ⇒
(goog.ui.tree.BaseNode | null)
Finds the containing node given an event.
Arguments:
e :
goog.events.BrowserEvent
The browser event.
Returns: 
(goog.ui.tree.BaseNode | null)
  The containing node or null if no node is found.
code »
getRowClassName()
No description.
code »
getSelectedItem() ⇒
(goog.ui.tree.BaseNode | null)
Returns the selected item.
Returns: 
(goog.ui.tree.BaseNode | null)
  The currently selected item.
code »
getShowExpandIcons() ⇒
boolean
No description.
Returns: 
boolean
  Whether to show expand icons.
code »
getShowLines() ⇒
boolean
No description.
Returns: 
boolean
  Whether to show lines.
code »
getShowRootLines() ⇒
boolean
No description.
Returns: 
boolean
  Whether to show root lines.
code »
getShowRootNode() ⇒
boolean
No description.
Returns: 
boolean
  Whether to show the root node.
code »
getTree()
No description.
code »
handleBlur_(e)
Handles blur on the tree.
Arguments:
e :
goog.events.BrowserEvent
The browser event.
code »
handleFocus_(e)
Handles focus on the tree.
Arguments:
e :
goog.events.BrowserEvent
The browser event.
code »
handleKeyEvent(e) ⇒
boolean
Handles key down on the tree.
Arguments:
e :
goog.events.BrowserEvent
The browser event.
Returns: 
boolean
  The handled value.
code »
handleMouseEvent_(e)
Handles mouse events.
Arguments:
e :
goog.events.BrowserEvent
The browser event.
code »
hasFocus() ⇒
boolean
No description.
Returns: 
boolean
  Whether the tree has keyboard focus.
code »
initAccessibility()
Add roles and states.
code »
removeNode(node)
Allows the caller to notify that the given node is being removed from the tree.
Arguments:
node :
(goog.ui.tree.BaseNode | null)
Node being removed.
code »
reveal()
Expands the parent chain of this node so that it is visible.
code »
setExpanded(expanded)
No description.
Arguments:
expanded :
No description.
code »
setNode(node)
Allows the caller to notify that the given node has been added or just had been updated in the tree.
Arguments:
node :
(goog.ui.tree.BaseNode | null)
New node being added or existing node that just had been updated.
code »
setSelectedItem(node)
Sets the selected item.
Arguments:
node :
(goog.ui.tree.BaseNode | null)
The item to select.
code »
setShowExpandIcons(b)
Sets whether to show expand icons.
Arguments:
b :
boolean
Whether to show expand icons.
code »
setShowLines(b)
Sets whether to show lines.
Arguments:
b :
boolean
Whether to show lines.
code »
setShowRootLines(b)
Sets whether to show root lines.
Arguments:
b :
boolean
Whether to show root lines.
code »
setShowRootNode(b)
Sets whether to show the root node.
Arguments:
b :
boolean
Whether to show the root node.
code »
updateExpandIcon()
No description.
code »
updateLinesAndExpandIcons_()
Updates the lines after the tree has been drawn.
code »
Defined in goog.ui.tree.BaseNode
add(child, opt_before) ⇒
(goog.ui.tree.BaseNode | null)
Adds a node as a child to the current node.
Arguments:
child :
(goog.ui.tree.BaseNode | null)
The child to add.
opt_before :
(goog.ui.tree.BaseNode | null | undefined)
If specified, the new child is added as a child before this one. If not specified, it's appended to the end.
Returns: 
(goog.ui.tree.BaseNode | null)
  The added child.
code »
addChildAt(child, index, opt_render)
The method assumes that the child doesn't have parent node yet. The 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.
Arguments:
child :
No description.
index :
No description.
opt_render :
No description.
code »
collapse()
Collapses the node.
code »
collapseAll()
Collapses the children and the node.
code »
collapseChildren()
Collapses the children of the node.
code »
computeDepth_() ⇒
number
Computes the depth of the node in the tree. Called only by getDepth, when the depth hasn't already been cached.
Returns: 
number
  The non-negative depth of this node (the root is zero).
code »
contains(node) ⇒
boolean
Returns true if the node is a descendant of this node
Arguments:
node :
(goog.ui.tree.BaseNode | null)
The node to check.
Returns: 
boolean
  True if the node is a descendant of this node, false otherwise.
code »
createDom()
No description.
code »
deselect()
Use tree.setSelectedItem(null). Originally it was intended to deselect the node but never worked.
code »
disposeInternal()
No description.
code »
enterDocument()
No description.
code »
exitDocument()
No description.
code »
expand()
Expands the node.
code »
expandAll()
Expands the children and the node.
code »
expandChildren()
Expands the children of the node.
code »
getAfterLabelElement() ⇒
(Element | null)
No description.
Returns: 
(Element | null)
  The element after the label.
code »
getAfterLabelHtml() ⇒
string
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.
Returns: 
string
  The html.
code »
getChildAt(index) ⇒
(goog.ui.tree.BaseNode | null)
No description.
Arguments:
index :
number
0-based index.
Returns: 
(goog.ui.tree.BaseNode | null)
  The child at the given index; null if none.
code »
getChildren() ⇒
Array
Returns the children of this node.
Returns: 
Array
  The children.
code »
getChildrenElement() ⇒
(Element | null)
No description.
Returns: 
(Element | null)
  The div containing the children.
code »
getClientData() ⇒
*
Use #getModel instead. No description.
Returns: 
*
  Data set by the client.
code »
getConfig() ⇒
(Object | null)
No description.
Returns: 
(Object | null)
  The configuration for the tree.
code »
getDepth() ⇒
number
Returns the depth of the node in the tree. Should not be overridden.
Returns: 
number
  The non-negative depth of this node (the root is zero).
code »
getElement() ⇒
(Element | null)
No description.
Returns: 
(Element | null)
  The element for the tree node.
code »
getExpandIconClass() ⇒
string
No description.
Returns: 
string
  The class names of the icon used for expanding the node.
code »
getExpandIconElement() ⇒
(Element | null)
No description.
Returns: 
(Element | null)
  The expanded icon element.
code »
getExpandIconHtml() ⇒
string
No description.
Returns: 
string
  The source for the icon.
code »
getExpanded() ⇒
boolean
No description.
Returns: 
boolean
  Whether the node is expanded.
code »
getExpandedIconClass() ⇒
string
Gets the icon class for when the node is expanded.
Returns: 
string
  The class.
code »
getFirstChild() ⇒
(goog.ui.tree.BaseNode | null)
No description.
Returns: 
(goog.ui.tree.BaseNode | null)
  The first child of this node.
code »
getHtml() ⇒
string
Returns the html of the label.
Returns: 
string
  The html string of the label.
code »
getIconClass() ⇒
string
Gets the icon class for the node.
Returns: 
string
  s The icon source.
code »
getIconElement() ⇒
(Element | null)
No description.
Returns: 
(Element | null)
  The icon element.
code »
getIconHtml() ⇒
string
No description.
Returns: 
string
  The html for the icon.
code »
getLabelElement() ⇒
(Element | null)
No description.
Returns: 
(Element | null)
  The label element.
code »
getLabelHtml() ⇒
string
No description.
Returns: 
string
  The html for the label.
code »
getLastChild() ⇒
(goog.ui.tree.BaseNode | null)
No description.
Returns: 
(goog.ui.tree.BaseNode | null)
  The last child of this node.
code »
getLastShownDescendant() ⇒
(goog.ui.tree.BaseNode | null)
No description.
Returns: 
(goog.ui.tree.BaseNode | null)
  The last shown descendant.
code »
getLineStyle() ⇒
string
No description.
Returns: 
string
  The line style.
code »
getLineStyle2() ⇒
string
No description.
Returns: 
string
  The line style.
code »
getNextShownNode() ⇒
(goog.ui.tree.BaseNode | null)
No description.
Returns: 
(goog.ui.tree.BaseNode | null)
  The next node to show or null if there isn't a next node to show.
code »
getNextSibling() ⇒
(goog.ui.tree.BaseNode | null)
No description.
Returns: 
(goog.ui.tree.BaseNode | null)
  The next sibling of this node.
code »
getPixelIndent_() ⇒
number
No description.
Returns: 
number
  The pixel indent of the row.
code »
getPreviousShownNode() ⇒
(goog.ui.tree.BaseNode | null)
No description.
Returns: 
(goog.ui.tree.BaseNode | null)
  The previous node to show.
code »
getPreviousSibling() ⇒
(goog.ui.tree.BaseNode | null)
No description.
Returns: 
(goog.ui.tree.BaseNode | null)
  The previous sibling of this node.
code »
getRowClassName() ⇒
string
No description.
Returns: 
string
  The class name for the row.
code »
getRowElement() ⇒
(Element | null)
No description.
Returns: 
(Element | null)
  The row is the div that is used to draw the node without the children.
code »
getRowHtml() ⇒
string
No description.
Returns: 
string
  The html for the row.
code »
getText() ⇒
string
Returns the text of the label. If the text was originally set as HTML, the return value is unspecified.
Returns: 
string
  The plain text of the label.
code »
getToolTip() ⇒
(null | string)
Returns the text of the tooltip.
Returns: 
(null | string)
  The tooltip text.
code »
initAccessibility()
Adds roles and states.
code »
isLastSibling() ⇒
boolean
No description.
Returns: 
boolean
  Whether the node is the last sibling.
code »
isSelected() ⇒
boolean
No description.
Returns: 
boolean
  Whether the node is selected.
code »
isUserCollapsible() ⇒
boolean
No description.
Returns: 
boolean
  Whether the node is collapsible by user actions.
code »
onClick_(e)
Handles a click event.
Arguments:
e :
goog.events.BrowserEvent
The browser event.
code »
onDoubleClick_(e)
Handles a double click event.
Arguments:
e :
goog.events.BrowserEvent
The browser event.
code »
onKeyDown(e) ⇒
boolean
Handles a key down event.
Arguments:
e :
goog.events.BrowserEvent
The browser event.
Returns: 
boolean
  The handled value.
code »
onKeyPress_(e)
Handles a key down event.
Arguments:
e :
goog.events.BrowserEvent
The browser event.
code »
onMouseDown(e)
Handles mouse down event.
Arguments:
e :
goog.events.BrowserEvent
The browser event.
code »
onTimeoutSelect_()
Handler for setting focus asynchronously.
code »
remove()
Use #removeChild. No description.
code »
removeChild(childNode, opt_unrender) ⇒
(goog.ui.tree.BaseNode | null)
Removes a child. The caller is responsible for disposing the node.
Arguments:
childNode :
(goog.ui.Component | null | string)
The child to remove. Must be a goog.ui.tree.BaseNode.
opt_unrender :
(boolean | undefined)
Unused. The child will always be unrendered.
Returns: 
(goog.ui.tree.BaseNode | null)
  The child that was removed.
code »
reveal()
Expands the parent chain of this node so that it is visible.
code »
select()
Selects the node.
code »
setAfterLabelHtml(html)
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.
Arguments:
html :
string
The html.
code »
setClientData(data)
Use #setModel instead. Sets client data to associate with the node.
Arguments:
data :
*
The client data to associate with the node.
code »
setDepth_(depth)
Changes the depth of a node (and all its descendants).
Arguments:
depth :
number
The new nesting depth; must be non-negative.
code »
setExpanded(expanded)
Sets the node to be expanded.
Arguments:
expanded :
boolean
Whether to expand or close the node.
code »
setExpandedIconClass(s)
Sets the icon class for when the node is expanded.
Arguments:
s :
string
The expanded icon class.
code »
setExpandedInternal(expanded)
Sets the node to be expanded internally, without state change events.
Arguments:
expanded :
boolean
Whether to expand or close the node.
code »
setHtml(s)
Sets the html of the label.
Arguments:
s :
string
The html string for the label.
code »
setIconClass(s)
Sets the icon class for the node.
Arguments:
s :
string
The icon class.
code »
setIsUserCollapsible(isCollapsible)
Sets whether the node will allow the user to collapse it.
Arguments:
isCollapsible :
boolean
Whether to allow node collapse.
code »
setSelectedInternal(selected)
Called from the tree to instruct the node change its selection state.
Arguments:
selected :
boolean
The new selection state.
code »
setText(s)
Sets the text of the label.
Arguments:
s :
string
The plain text of the label.
code »
setToolTip(s)
Sets the text of the tooltip.
Arguments:
s :
string
The tooltip text to set.
code »
setTreeInternal(tree)
Internal method that is used to set the tree control on the node.
Arguments:
tree :
(goog.ui.tree.TreeControl | null)
The tree control.
code »
toHtml(sb)
Returns the html for the node.
Arguments:
sb :
(goog.string.StringBuffer | null)
A string buffer to append the HTML to.
code »
toggle()
Toggles the expanded state of the node.
code »
updateExpandIcon()
Updates the expand icon of the node.
code »
updateIcon_()
Updates the icon of the node. Assumes that this.getElement() is created.
code »
updateRow()
Updates the row styles.
code »
Defined in goog.ui.Component
addChild(child, opt_render)
Adds the specified component as the last child of this component. See goog.ui.Component#addChildAt for detailed semantics.
Arguments:
child :
(goog.ui.Component | null)
The new child component.
opt_render :
(boolean | undefined)
If true, the child component will be rendered into the parent.
code »
addChildAt(child, index, opt_render) ⇒
undefined
Adds the specified component as a child of this component at the given 0-based index. Both addChild and addChildAt assume the following contract between parent and child components:
  • the child component's element must be a descendant of the parent component's element, and
  • the DOM state of the child component must be consistent with the DOM state of the parent component (see isInDocument).
In particular, parent.addChild(child) will throw an error if the child component is already in the document, but the parent isn't. Clients of this API may call addChild and addChildAt with opt_render set to true. If opt_render is true, calling these methods will automatically render the child component's element into the parent component's element. However, parent.addChild(child, true) will throw an error if:
  • the parent component has no DOM (i.e. parent.getElement() is null), or
  • the child component is already in the document, regardless of the parent's DOM state.
If opt_render is true and the parent component is not already in the document, enterDocument will not be called on this component at this point. Finally, this method also throws an error if the new child already has a different parent, or the given index is out of bounds.
Arguments:
child :
(goog.ui.Component | null)
The new child component.
index :
number
0-based index at which the new child component is to be added; must be between 0 and the current child count (inclusive).
opt_render :
(boolean | undefined)
If true, the child component will be rendered into the parent.
Returns: 
undefined
  Nada.
code »
canDecorate(element) ⇒
boolean
Determines if a given element can be decorated by this type of component. This method should be overridden by inheriting objects.
Arguments:
element :
(Element | null)
Element to decorate.
Returns: 
boolean
  True if the element can be decorated, false otherwise.
code »
createDom()
Creates the initial DOM representation for the component. The default implementation is to set this.element_ = div.
code »
decorate(element)
Decorates the element for the UI component.
Arguments:
element :
(Element | null)
Element to decorate.
code »
decorateInternal(element)
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.
Arguments:
element :
(Element | null)
Element to decorate.
code »
disposeInternal()
Disposes of the component. Calls 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.
code »
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.
code »
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.
code »
forEachChild(f, opt_obj)
Calls the given function on each of this component's children in order. If 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.
Arguments:
f :
(Function | null)
The function to call for every child component; should take 2 arguments (the child and its index).
opt_obj :
(Object | null | undefined)
Used as the 'this' object in f when called.
code »
getChild(id) ⇒
(goog.ui.Component | null)
Returns the child with the given ID, or null if no such child exists.
Arguments:
id :
string
Child component ID.
Returns: 
(goog.ui.Component | null)
  The child with the given ID; null if none.
code »
getChildAt(index) ⇒
(goog.ui.Component | null)
Returns the child at the given index, or null if the index is out of bounds.
Arguments:
index :
number
0-based index.
Returns: 
(goog.ui.Component | null)
  The child at the given index; null if none.
code »
getChildCount() ⇒
number
Returns the number of children of this component.
Returns: 
number
  The number of children.
code »
getChildIds() ⇒
(Array | null)
Returns an array containing the IDs of the children of this component, or an empty array if the component has no children.
Returns: 
(Array | null)
  Child component IDs.
code »
getContentElement() ⇒
(Element | null)
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.
Returns: 
(Element | null)
  Element to contain child elements (null if none).
code »
getDomHelper() ⇒
goog.dom.DomHelper
Returns the dom helper that is being used on this component.
Returns: 
goog.dom.DomHelper
  The dom helper used on this component.
code »
getElement() ⇒
(Element | null)
Gets the component's element.
Returns: 
(Element | null)
  The element for the component.
code »
getElementByClass(className) ⇒
(Element | null)
Returns the first element in this component's DOM with the provided className.
Arguments:
className :
string
The name of the class to look for.
Returns: 
(Element | null)
  The first item with the class name provided.
code »
getElementByFragment(idFragment) ⇒
(Element | null)
Helper function for returning an element in the document with a unique id generated using makeId().
Arguments:
idFragment :
string
The partial id.
Returns: 
(Element | null)
  The element with the unique id, or null if it cannot be found.
code »
getElementsByClass(className) ⇒
{length: number}
Returns an array of all the elements in this component's DOM with the provided className.
Arguments:
className :
string
The name of the class to look for.
Returns: 
{length: number}
  The items found with the class name provided.
code »
getFragmentFromId(id) ⇒
string
Helper function for returning the fragment portion of an id generated using makeId().
Arguments:
id :
string
Id generated with makeId().
Returns: 
string
  Fragment.
code »
getHandler() ⇒
goog.events.EventHandler
Returns the event handler for this component, lazily created the first time this method is called.
Returns: 
goog.events.EventHandler
  Event handler for this component.
code »
getId() ⇒
string
Gets the unique ID for the instance of this component. If the instance doesn't already have an ID, generates one on the fly.
Returns: 
string
  Unique component ID.
code »
getModel() ⇒
*
Returns the model associated with the UI component.
Returns: 
*
  The model.
code »
getParent() ⇒
(goog.ui.Component | null)
Returns the component's parent, if any.
Returns: 
(goog.ui.Component | null)
  The parent component.
code »
hasChildren() ⇒
boolean
Returns true if the component has children.
Returns: 
boolean
  True if the component has children.
code »
indexOfChild(child) ⇒
number
Returns the 0-based index of the given child component, or -1 if no such child is found.
Arguments:
child :
(goog.ui.Component | null)
The child component.
Returns: 
number
  0-based index of the child component; -1 if not found.
code »
isInDocument() ⇒
boolean
Determines whether the component has been added to the document.
Returns: 
boolean
  TRUE if rendered. Otherwise, FALSE.
code »
isRightToLeft() ⇒
boolean
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.
Returns: 
boolean
  Whether the control is rendered right-to-left.
code »
makeId(idFragment) ⇒
string
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.
Arguments:
idFragment :
string
A partial id.
Returns: 
string
  Unique element id.
code »
makeIds(object) ⇒
(Object | null)
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.
Arguments:
object :
(Object | null)
The object that will be used to create the ids.
Returns: 
(Object | null)
  An object of id keys to generated ids.
code »
removeChild(child, opt_unrender) ⇒
(goog.ui.Component | null)
Removes the given child from this component, and returns it. Throws an error if the argument is invalid or if the specified child isn't found in the parent component. The argument can either be a string (interpreted as the ID of the child component to remove) or the child component itself. If opt_unrender is true, calls goog.ui.component#exitDocument on the removed child, and subsequently detaches the child's DOM from the document. Otherwise it is the caller's responsibility to clean up the child component's DOM.
Arguments:
child :
(goog.ui.Component | null | string)
The ID of the child to remove, or the child component itself.
opt_unrender :
(boolean | undefined)
If true, calls exitDocument on the removed child component, and detaches its DOM from the document.
Returns: 
(goog.ui.Component | null)
  The removed component, if any.
code »
removeChildAt(index, opt_unrender) ⇒
(goog.ui.Component | null)
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 goog.ui.Component#removeChild for detailed semantics.
Arguments:
index :
number
0-based index of the child to remove.
opt_unrender :
(boolean | undefined)
If true, calls exitDocument on the removed child component, and detaches its DOM from the document.
Returns: 
(goog.ui.Component | null)
  The removed component, if any.
code »
removeChildren(opt_unrender)
Removes every child component attached to this one.
Arguments:
opt_unrender :
(boolean | undefined)
If true, calls #exitDocument on the removed child components, and detaches their DOM from the document.
code »
render(opt_parentElement)
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 enterDocument on this component. Throws an Error if the component is already rendered.
Arguments:
opt_parentElement :
(Element | null | undefined)
Optional parent element to render the component into.
code »
renderBefore(sibling)
Renders the component before another element. The other element should be in the document already. Throws an Error if the component is already rendered.
Arguments:
sibling :
(Node | null)
Node to render the component before.
code »
render_(opt_parentElement, opt_beforeNode)
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 enterDocument on this component. Throws an Error if the component is already rendered.
Arguments:
opt_parentElement :
(Element | null | undefined)
Optional parent element to render the component into.
opt_beforeNode :
(Node | null | undefined)
Node before which the component is to be rendered. If left out the node is appended to the parent element.
code »
setElementInternal(element)
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.
Arguments:
element :
(Element | null)
Root element for the component.
code »
setId(id)
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.
Arguments:
id :
string
Unique component ID.
code »
setModel(obj)
Sets the model associated with the UI component.
Arguments:
obj :
*
The model.
code »
setParent(parent)
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 removeChild or removeChildAt to remove components from their containers before calling this method.
Arguments:
parent :
(goog.ui.Component | null)
The parent component.
code »
setParentEventTarget(parent)
Overrides goog.events.EventTarget#setParentEventTarget to throw an error if the parent component is set, and the argument is not the parent.
Arguments:
parent :
No description.
code »
setRightToLeft(rightToLeft)
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 #enterDocument is called and is right-to-left is set).
Arguments:
rightToLeft :
boolean
Whether the component is rendered right-to-left.
code »
wasDecorated() ⇒
boolean
No description.
Returns: 
boolean
  Whether the component was decorated.
code »
Defined in goog.events.EventTarget
addEventListener(type, handler, opt_capture, opt_handlerScope)
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.
Arguments:
type :
string
The type of the event to listen for.
handler :
(Object | null)
The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
opt_capture :
(boolean | undefined)
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope :
(Object | null | undefined)
Object in whose scope to call the listener.
code »
dispatchEvent(e) ⇒
boolean
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.
Arguments:
e :
(Object | goog.events.Event | null | string)
Event object.
Returns: 
boolean
  If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.
code »
disposeInternal()
Unattach listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners, it should be something like this: 
MyClass.prototype.disposeInternal = function() {
MyClass.superClass_.disposeInternal.call(this);
// Dispose logic for MyClass
};
code »
getParentEventTarget() ⇒
(goog.events.EventTarget | null)
Returns the parent of this event target to use for bubbling.
Returns: 
(goog.events.EventTarget | null)
  The parent EventTarget or null if there is no parent.
code »
removeEventListener(type, handler, opt_capture, opt_handlerScope)
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.
Arguments:
type :
string
The type of the event to listen for.
handler :
(Object | null)
The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
opt_capture :
(boolean | undefined)
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope :
(Object | null | undefined)
Object in whose scope to call the listener.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for bubbling.
Arguments:
parent :
(goog.events.EventTarget | null)
Parent EventTarget (null if none).
code »
Defined in goog.Disposable
dispose() ⇒
undefined
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: 
undefined
  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example: 
mypackage.MyClass = function() {
goog.base(this);
// Constructor logic specific to MyClass.
...
};
goog.inherits(mypackage.MyClass, goog.Disposable);

mypackage.MyClass.prototype.disposeInternal = function() {
goog.base(this, 'disposeInternal');
// Dispose logic specific to MyClass.
...
};
code »
getDisposed() ⇒
boolean
Use #isDisposed instead. No description.
Returns: 
boolean
  Whether the object has been disposed of.
code »
isDisposed() ⇒
boolean
No description.
Returns: 
boolean
  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable :
(goog.disposable.IDisposable | null)
that will be disposed when this object is disposed.
code »

Instance Properties

Defined in goog.ui.tree.TreeControl
focusHandler_ :
(goog.events.FocusHandler | null)
The object handling focus events.
Code »
focusedNode_ :
(goog.ui.tree.BaseNode | null)
Child node that currently has focus.
Code »
focused_ :
boolean
Whether the tree is focused.
Code »
keyHandler_ :
(goog.events.KeyHandler | null)
The object handling keyboard events.
Code »
logger_ :
(goog.debug.Logger | null)
Logger
Code »
showExpandIcons_ :
boolean
Whether to show expanded lines.
Code »
showLines_ :
boolean
Whether to show lines.
Code »
showRootLines_ :
boolean
Whether to show the root lines.
Code »
showRootNode_ :
boolean
Whether to show the root node.
Code »
typeAhead_ :
goog.ui.tree.TypeAhead
Used for typeahead support.
Code »
Defined in goog.ui.tree.BaseNode
afterLabelHtml_ :
string
HTML that can appear after the label (so not inside the anchor).
Code »
config_ :
(Object | null)
The configuration for the tree.
Code »
depth_ :
number
Nesting depth of this node; cached result of computeDepth_. -1 if value has not been cached.
Code »
expanded_ :
boolean
Whether the tree node is expanded.
Code »
html_ :
string
HTML content of the node label.
Code »
isUserCollapsible_ :
boolean
Whether to allow user to collapse this node.
Code »
selected_ :
boolean
Whether the tree item is selected.
Code »
toolTip_ :
(null | string)
Tooltip for the tree item
Code »
Defined in goog.ui.Component
childIndex_ :
(Object | null)
Map of child component IDs to child components. Used for constant-time random access to child components by ID. Lazily initialized on first use. Must be kept in sync with children_. This property is strictly private and must not be accessed directly outside of this class! We use a plain Object, not a goog.structs.Map, for simplicity. This means components can't have children with IDs such as 'constructor' or 'valueOf', but this shouldn't really be an issue in practice, and if it is, we can always fix it later without changing the API.
Code »
children_ :
(Array | null)
Array of child components. Lazily initialized on first use. Must be kept in sync with childIndex_. This property is strictly private and must not be accessed directly outside of this class!
Code »
dom_ :
goog.dom.DomHelper
DomHelper used to interact with the document, allowing components to be created in a different window.
Code »
element_ :
(Element | null)
The DOM element for the component.
Code »
googUiComponentHandler_ :
(goog.events.EventHandler | null)
Event handler. TODO(user): rename it to handler_ after all component subclasses in inside Google have been cleaned up. Code search: http://go/component_code_search
Code »
idGenerator_ :
(goog.ui.IdGenerator | null)
Generator for unique IDs.
Code »
id_ :
(null | string)
Unique ID of the component, lazily initialized in goog.ui.Component#getId if needed. This property is strictly private and must not be accessed directly outside of this class!
Code »
inDocument_ :
boolean
Whether the component is in the document.
Code »
model_ :
*
Arbitrary data object associated with the component. Such as meta-data.
Code »
parent_ :
(goog.ui.Component | null)
Parent component to which events will be propagated. This property is strictly private and must not be accessed directly outside of this class!
Code »
rightToLeft_ :
(boolean | null)
Whether the component is rendered right-to-left. Right-to-left is set lazily when #isRightToLeft is called the first time, unless it has been set by calling #setRightToLeft explicitly.
Code »
wasDecorated_ :
boolean
Flag used to keep track of whether a component decorated an already existing element or whether it created the DOM itself. If an element is decorated, dispose will leave the node in the document. It is up to the app to remove the node. If an element was rendered, dispose will remove the node automatically.
Code »
Defined in goog.events.EventTarget
customEvent_ :
boolean
Used to tell if an event is a real event in goog.events.listen() so we don't get listen() calling addEventListener() and vice-versa.
Code »
parentEventTarget_ :
(goog.events.EventTarget | null)
Parent event target, used during event bubbling.
Code »
Defined in goog.Disposable
dependentDisposables_ :
(Array | null)
Disposables that should be disposed when this object is disposed.
Code »
disposed_ :
boolean
Whether the object has been disposed of.
Code »

Package ui.tree

Package Reference