Package com.google.gwt.user.client.ui
Class Tree
java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Tree
- All Implemented Interfaces:
HasAllFocusHandlers
,HasAllKeyHandlers
,HasAllMouseHandlers
,HasBlurHandlers
,HasFocusHandlers
,HasKeyDownHandlers
,HasKeyPressHandlers
,HasKeyUpHandlers
,HasMouseDownHandlers
,HasMouseMoveHandlers
,HasMouseOutHandlers
,HasMouseOverHandlers
,HasMouseUpHandlers
,HasMouseWheelHandlers
,HasAttachHandlers
,HasCloseHandlers<TreeItem>
,HasOpenHandlers<TreeItem>
,HasSelectionHandlers<TreeItem>
,HasHandlers
,EventListener
,Focusable
,HasAnimation
,HasFocus
,HasTreeItems
,HasTreeItems.ForIsWidget
,HasVisibility
,HasWidgets
,HasWidgets.ForIsWidget
,IsWidget
,SourcesFocusEvents
,SourcesKeyboardEvents
,SourcesMouseEvents
,SourcesTreeEvents
,Iterable<Widget>
public class Tree
extends Widget
implements HasTreeItems.ForIsWidget, HasWidgets.ForIsWidget, SourcesTreeEvents, HasFocus, HasAnimation, HasAllKeyHandlers, HasAllFocusHandlers, HasSelectionHandlers<TreeItem>, HasOpenHandlers<TreeItem>, HasCloseHandlers<TreeItem>, SourcesMouseEvents, HasAllMouseHandlers
A standard hierarchical tree widget. The tree contains a hierarchy of
TreeItems
that the user can
open, close, and select.
CSS Style Rules
- .gwt-Tree
- the tree itself
- .gwt-Tree .gwt-TreeItem
- a tree item
- .gwt-Tree .gwt-TreeItem-selected
- a selected tree item
Example
public class TreeExample implements EntryPoint { @Override public void onModuleLoad() { // Create a tree with a few items in it. TreeItem root = new TreeItem(); root.setText("root"); root.addTextItem("item0"); root.addTextItem("item1"); root.addTextItem("item2"); // Add a CheckBox to the tree TreeItem item = new TreeItem(new CheckBox("item3")); root.addItem(item); Tree t = new Tree(); t.addItem(root); // Add it to the root panel. RootPanel.get().add(t); } }
-
Nested Class Summary
Modifier and TypeClassDescription(package private) static class
There are several ways of configuring images for the Tree widget due to deprecated APIs.static interface
A ClientBundle that provides images for this widget.Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasTreeItems
HasTreeItems.ForIsWidget
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets
HasWidgets.ForIsWidget
-
Field Summary
Fields inherited from class com.google.gwt.user.client.ui.Widget
eventsToSink
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX, MISSING_ELEMENT_ERROR, SETELEMENT_TWICE_ERROR
-
Constructor Summary
ConstructorDescriptionTree()
Constructs an empty tree.Tree
(Tree.Resources resources) Constructs a tree that uses the specified ClientBundle for images.Tree
(Tree.Resources resources, boolean useLeafImages) Constructs a tree that uses the specified ClientBundle for images.Tree
(TreeImages images) Deprecated.Tree
(TreeImages images, boolean useLeafImages) Deprecated.replaced byTree(Resources, boolean)
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Overloaded version for IsWidget.void
Adds the widget as a root tree item.addBlurHandler
(BlurHandler handler) Adds aBlurEvent
handler.addCloseHandler
(CloseHandler<TreeItem> handler) Adds aCloseEvent
handler.addFocusHandler
(FocusHandler handler) Adds aFocusEvent
handler.void
addFocusListener
(FocusListener listener) Deprecated.Adds a simple tree item containing the specified html.void
addItem
(IsTreeItem isItem) Adds an item to the root level of this tree.Overloaded version for IsWidget.void
Adds an item to the root level of this tree.Adds a new tree item containing the specified widget.void
addKeyboardListener
(KeyboardListener listener) addKeyDownHandler
(KeyDownHandler handler) Adds aKeyDownEvent
handler.addKeyPressHandler
(KeyPressHandler handler) Adds aKeyPressEvent
handler.addKeyUpHandler
(KeyUpHandler handler) Adds aKeyUpEvent
handler.addMouseDownHandler
(MouseDownHandler handler) Adds aMouseDownEvent
handler.void
addMouseListener
(MouseListener listener) Deprecated.UseaddMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler)
addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler)
,addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler)
,addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler)
andaddMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler)
insteadaddMouseMoveHandler
(MouseMoveHandler handler) Adds aMouseMoveEvent
handler.addMouseOutHandler
(MouseOutHandler handler) Adds aMouseOutEvent
handler.addMouseOverHandler
(MouseOverHandler handler) Adds aMouseOverEvent
handler.addMouseUpHandler
(MouseUpHandler handler) Adds aMouseUpEvent
handler.addMouseWheelHandler
(MouseWheelHandler handler) Adds aMouseWheelEvent
handler.final HandlerRegistration
addOpenHandler
(OpenHandler<TreeItem> handler) Adds anOpenEvent
handler.addSelectionHandler
(SelectionHandler<TreeItem> handler) Adds aSelectionEvent
handler.addTextItem
(String itemText) Adds a simple tree item containing the specified text.void
addTreeListener
(TreeListener listener) Deprecated.UseaddSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler<com.google.gwt.user.client.ui.TreeItem>)
,addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler<com.google.gwt.user.client.ui.TreeItem>)
, andaddCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.TreeItem>)
instead(package private) void
void
clear()
Clears all tree items from the current tree.protected void
If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and callWidget.onAttach()
for each of its child widgets.protected void
If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and callWidget.onDetach()
for each of its child widgets.void
Ensures that the currently-selected item is visible, opening its parents and scrolling the tree as necessary.(package private) void
fireStateChanged
(TreeItem item, boolean open) (package private) Tree.ImageAdapter
getItem
(int index) Gets the top-level tree item at the specified index.int
Gets the number of items contained at the root of this tree.Gets the currently selected item.int
Gets the widget's position in the tab index.insertItem
(int beforeIndex, SafeHtml itemHtml) Inserts a child tree item at the specified index containing the specified html.void
insertItem
(int beforeIndex, TreeItem item) Inserts an item into the root level of this tree.insertItem
(int beforeIndex, Widget widget) Inserts a child tree item at the specified index containing the specified widget.insertTextItem
(int beforeIndex, String itemText) Inserts a child tree item at the specified index containing the specified text.boolean
Returns true if animations are enabled, false if not.protected boolean
isKeyboardNavigationEnabled
(TreeItem currentItem) Indicates if keyboard navigation is enabled for the Tree and for a given TreeItem.boolean
Determines whether selecting a tree item will scroll it into view.iterator()
Gets an iterator for the contained widgets.(package private) void
maybeUpdateSelection
(TreeItem itemThatChangedState, boolean isItemOpening) void
onBrowserEvent
(Event event) Fired whenever a browser event is received.protected void
onEnsureDebugId
(String baseID) Affected Elements: -root = The rootTreeItem
.protected void
onLoad()
This method is called immediately after a widget becomes attached to the browser's document.(package private) void
boolean
Overloaded version for IsWidget.boolean
Removes a child widget.void
removeFocusListener
(FocusListener listener) Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned byaddFocusHandler(com.google.gwt.event.dom.client.FocusHandler)
insteadvoid
removeItem
(IsTreeItem isItem) Removes an item from the root level of this tree.void
removeItem
(TreeItem item) Removes an item from the root level of this tree.void
Removes all items from the root level of this tree.void
removeKeyboardListener
(KeyboardListener listener) Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadvoid
removeMouseListener
(MouseListener listener) Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadvoid
removeTreeListener
(TreeListener listener) Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadvoid
setAccessKey
(char key) Sets the widget's 'access key'.void
setAnimationEnabled
(boolean enable) Enable or disable animations.void
setFocus
(boolean focus) Explicitly focus/unfocus this widget.void
setScrollOnSelectEnabled
(boolean enable) Enable or disable scrolling a tree item into view when it is selected.void
setSelectedItem
(TreeItem item) Selects a specified item.void
setSelectedItem
(TreeItem item, boolean fireEvents) Selects a specified item.void
setTabIndex
(int index) Sets the widget's position in the tab index.(package private) static boolean
(package private) void
showClosedImage
(TreeItem treeItem) Called only fromTreeItem
: Shows the closed image on that tree item.(package private) void
showLeafImage
(TreeItem treeItem) Called only fromTreeItem
: Shows the leaf image on a tree item.(package private) void
showOpenImage
(TreeItem treeItem) Called only fromTreeItem
: Shows the open image on a tree item.Iterator of tree items.Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, ensureHandlers, fireEvent, getHandlerCount, getHandlerManager, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onUnload, removeFromParent, replaceElement, setLayoutData, setParent, sinkEvents, unsinkEvents
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
Tree
public Tree()Constructs an empty tree. -
Tree
Constructs a tree that uses the specified ClientBundle for images.- Parameters:
resources
- a bundle that provides tree specific images
-
Tree
Constructs a tree that uses the specified ClientBundle for images. If this tree does not use leaf images, the width of the Resources's leaf image will control the leaf indent.- Parameters:
resources
- a bundle that provides tree specific imagesuseLeafImages
- use leaf images from bundle
-
Tree
Deprecated.replaced byTree(Resources)
Constructs a tree that uses the specified image bundle for images.- Parameters:
images
- a bundle that provides tree specific images
-
Tree
Deprecated.replaced byTree(Resources, boolean)
Constructs a tree that uses the specified image bundle for images. If this tree does not use leaf images, the width of the TreeImage's leaf image will control the leaf indent.- Parameters:
images
- a bundle that provides tree specific imagesuseLeafImages
- use leaf images from bundle
-
-
Method Details
-
shouldTreeDelegateFocusToElement
-
add
Adds the widget as a root tree item.- Specified by:
add
in interfaceHasWidgets
- Parameters:
widget
- widget to add.- See Also:
-
add
Overloaded version for IsWidget.- Specified by:
add
in interfaceHasWidgets.ForIsWidget
- See Also:
-
addBlurHandler
Description copied from interface:HasBlurHandlers
Adds aBlurEvent
handler.- Specified by:
addBlurHandler
in interfaceHasBlurHandlers
- Parameters:
handler
- the blur handler- Returns:
HandlerRegistration
used to remove this handler
-
addFocusHandler
Description copied from interface:HasFocusHandlers
Adds aFocusEvent
handler.- Specified by:
addFocusHandler
in interfaceHasFocusHandlers
- Parameters:
handler
- the focus handler- Returns:
HandlerRegistration
used to remove this handler
-
addFocusListener
Deprecated.Description copied from interface:SourcesFocusEvents
Adds a listener interface to receive focus events.- Specified by:
addFocusListener
in interfaceSourcesFocusEvents
- Parameters:
listener
- the listener interface to add
-
addItem
Adds an item to the root level of this tree.- Specified by:
addItem
in interfaceHasTreeItems
- Parameters:
item
- the item to be added
-
addItem
Adds an item to the root level of this tree.- Specified by:
addItem
in interfaceHasTreeItems
- Parameters:
isItem
- the wrapper of item to be added
-
addItem
Adds a new tree item containing the specified widget.- Specified by:
addItem
in interfaceHasTreeItems
- Parameters:
widget
- the widget to be added- Returns:
- the new item
-
addItem
Overloaded version for IsWidget.- Specified by:
addItem
in interfaceHasTreeItems.ForIsWidget
- See Also:
-
addKeyboardListener
Deprecated.Description copied from interface:SourcesKeyboardEvents
Adds a listener interface to receive keyboard events.- Specified by:
addKeyboardListener
in interfaceSourcesKeyboardEvents
- Parameters:
listener
- the listener interface to add
-
addKeyDownHandler
Description copied from interface:HasKeyDownHandlers
Adds aKeyDownEvent
handler.- Specified by:
addKeyDownHandler
in interfaceHasKeyDownHandlers
- Parameters:
handler
- the key down handler- Returns:
HandlerRegistration
used to remove this handler
-
addKeyPressHandler
Description copied from interface:HasKeyPressHandlers
Adds aKeyPressEvent
handler.- Specified by:
addKeyPressHandler
in interfaceHasKeyPressHandlers
- Parameters:
handler
- the key press handler- Returns:
HandlerRegistration
used to remove this handler
-
addKeyUpHandler
Description copied from interface:HasKeyUpHandlers
Adds aKeyUpEvent
handler.- Specified by:
addKeyUpHandler
in interfaceHasKeyUpHandlers
- Parameters:
handler
- the key up handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseDownHandler
Description copied from interface:HasMouseDownHandlers
Adds aMouseDownEvent
handler.- Specified by:
addMouseDownHandler
in interfaceHasMouseDownHandlers
- Parameters:
handler
- the mouse down handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseListener
Deprecated.UseaddMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler)
addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler)
,addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler)
,addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler)
andaddMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler)
insteadDescription copied from interface:SourcesMouseEvents
Adds a listener interface to receive mouse events.- Specified by:
addMouseListener
in interfaceSourcesMouseEvents
- Parameters:
listener
- the listener interface to add
-
addMouseMoveHandler
Description copied from interface:HasMouseMoveHandlers
Adds aMouseMoveEvent
handler.- Specified by:
addMouseMoveHandler
in interfaceHasMouseMoveHandlers
- Parameters:
handler
- the mouse move handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseOutHandler
Description copied from interface:HasMouseOutHandlers
Adds aMouseOutEvent
handler.- Specified by:
addMouseOutHandler
in interfaceHasMouseOutHandlers
- Parameters:
handler
- the mouse out handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseOverHandler
Description copied from interface:HasMouseOverHandlers
Adds aMouseOverEvent
handler.- Specified by:
addMouseOverHandler
in interfaceHasMouseOverHandlers
- Parameters:
handler
- the mouse over handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseUpHandler
Description copied from interface:HasMouseUpHandlers
Adds aMouseUpEvent
handler.- Specified by:
addMouseUpHandler
in interfaceHasMouseUpHandlers
- Parameters:
handler
- the mouse up handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseWheelHandler
Description copied from interface:HasMouseWheelHandlers
Adds aMouseWheelEvent
handler.- Specified by:
addMouseWheelHandler
in interfaceHasMouseWheelHandlers
- Parameters:
handler
- the mouse wheel handler- Returns:
HandlerRegistration
used to remove this handler
-
addTextItem
Adds a simple tree item containing the specified text.- Specified by:
addTextItem
in interfaceHasTreeItems
- Parameters:
itemText
- the text of the item to be added- Returns:
- the item that was added
-
addTreeListener
Deprecated.UseaddSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler<com.google.gwt.user.client.ui.TreeItem>)
,addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler<com.google.gwt.user.client.ui.TreeItem>)
, andaddCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.TreeItem>)
insteadDescription copied from interface:SourcesTreeEvents
Adds a listener interface to receive tree events.- Specified by:
addTreeListener
in interfaceSourcesTreeEvents
- Parameters:
listener
- the listener interface to add
-
clear
public void clear()Clears all tree items from the current tree.- Specified by:
clear
in interfaceHasWidgets
-
ensureSelectedItemVisible
public void ensureSelectedItemVisible()Ensures that the currently-selected item is visible, opening its parents and scrolling the tree as necessary. -
getItem
Gets the top-level tree item at the specified index.- Parameters:
index
- the index to be retrieved- Returns:
- the item at that index
-
getItemCount
public int getItemCount()Gets the number of items contained at the root of this tree.- Returns:
- this tree's item count
-
getSelectedItem
Gets the currently selected item.- Returns:
- the selected item
-
getTabIndex
public int getTabIndex()Description copied from interface:Focusable
Gets the widget's position in the tab index.- Specified by:
getTabIndex
in interfaceFocusable
- Returns:
- the widget's tab index
-
insertItem
Inserts an item into the root level of this tree.- Parameters:
beforeIndex
- the index where the item will be inserteditem
- the item to be added- Throws:
IndexOutOfBoundsException
- if the index is out of range
-
insertItem
Inserts a child tree item at the specified index containing the specified widget.- Parameters:
beforeIndex
- the index where the item will be insertedwidget
- the widget to be added- Returns:
- the item that was added
- Throws:
IndexOutOfBoundsException
- if the index is out of range
-
insertTextItem
Inserts a child tree item at the specified index containing the specified text.- Parameters:
beforeIndex
- the index where the item will be inserteditemText
- the text of the item to be added- Returns:
- the item that was added
- Throws:
IndexOutOfBoundsException
- if the index is out of range
-
isAnimationEnabled
public boolean isAnimationEnabled()Description copied from interface:HasAnimation
Returns true if animations are enabled, false if not.- Specified by:
isAnimationEnabled
in interfaceHasAnimation
-
isScrollOnSelectEnabled
public boolean isScrollOnSelectEnabled()Determines whether selecting a tree item will scroll it into view. -
iterator
Description copied from interface:HasWidgets
Gets an iterator for the contained widgets. This iterator is required to implementIterator.remove()
.- Specified by:
iterator
in interfaceHasWidgets
- Specified by:
iterator
in interfaceIterable<Widget>
-
onBrowserEvent
Description copied from interface:EventListener
Fired whenever a browser event is received.- Specified by:
onBrowserEvent
in interfaceEventListener
- Overrides:
onBrowserEvent
in classWidget
- Parameters:
event
- the event received
-
remove
Description copied from interface:HasWidgets
Removes a child widget.- Specified by:
remove
in interfaceHasWidgets
- Parameters:
w
- the widget to be removed- Returns:
true
if the widget was present
-
remove
Overloaded version for IsWidget.- Specified by:
remove
in interfaceHasWidgets.ForIsWidget
- See Also:
-
removeFocusListener
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned byaddFocusHandler(com.google.gwt.event.dom.client.FocusHandler)
insteadDescription copied from interface:SourcesFocusEvents
Removes a previously added listener interface.- Specified by:
removeFocusListener
in interfaceSourcesFocusEvents
- Parameters:
listener
- the listener interface to remove
-
removeItem
Removes an item from the root level of this tree.- Specified by:
removeItem
in interfaceHasTreeItems
- Parameters:
item
- the item to be removed
-
removeItem
Removes an item from the root level of this tree.- Specified by:
removeItem
in interfaceHasTreeItems
- Parameters:
isItem
- the wrapper of item to be removed
-
removeItems
public void removeItems()Removes all items from the root level of this tree.- Specified by:
removeItems
in interfaceHasTreeItems
-
removeKeyboardListener
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadDescription copied from interface:SourcesKeyboardEvents
Removes a previously added listener interface.- Specified by:
removeKeyboardListener
in interfaceSourcesKeyboardEvents
- Parameters:
listener
- the listener interface to remove
-
removeMouseListener
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadDescription copied from interface:SourcesMouseEvents
Removes a previously added listener interface.- Specified by:
removeMouseListener
in interfaceSourcesMouseEvents
- Parameters:
listener
- the listener interface to remove
-
removeTreeListener
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadDescription copied from interface:SourcesTreeEvents
Removes a previously added listener interface.- Specified by:
removeTreeListener
in interfaceSourcesTreeEvents
- Parameters:
listener
- the listener interface to remove
-
setAccessKey
public void setAccessKey(char key) Description copied from interface:Focusable
Sets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.- Specified by:
setAccessKey
in interfaceFocusable
- Parameters:
key
- the widget's access key
-
setAnimationEnabled
public void setAnimationEnabled(boolean enable) Description copied from interface:HasAnimation
Enable or disable animations.- Specified by:
setAnimationEnabled
in interfaceHasAnimation
- Parameters:
enable
- true to enable, false to disable
-
setFocus
public void setFocus(boolean focus) Description copied from interface:Focusable
Explicitly focus/unfocus this widget. Only one widget can have focus at a time, and the widget that does will receive all keyboard events. NOTE: Most browsers fire FocusEvents asynchronously. Especially within GWT tests, you'll need to make your test asynchronous to properly do verifications. SeeGWTTestCase#delayTestFinish
for more information on how to do this. -
setScrollOnSelectEnabled
public void setScrollOnSelectEnabled(boolean enable) Enable or disable scrolling a tree item into view when it is selected. Scrolling into view is enabled by default. -
setSelectedItem
Selects a specified item.- Parameters:
item
- the item to be selected, ornull
to deselect all items
-
setSelectedItem
Selects a specified item.- Parameters:
item
- the item to be selected, ornull
to deselect all itemsfireEvents
-true
to allow selection events to be fired
-
setTabIndex
public void setTabIndex(int index) Description copied from interface:Focusable
Sets the widget's position in the tab index. If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to-1
will cause this widget to be removed from the tab order.- Specified by:
setTabIndex
in interfaceFocusable
- Parameters:
index
- the widget's tab index
-
treeItemIterator
Iterator of tree items.- Returns:
- the iterator
-
doAttachChildren
protected void doAttachChildren()Description copied from class:Widget
If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and callWidget.onAttach()
for each of its child widgets.- Overrides:
doAttachChildren
in classWidget
- See Also:
-
doDetachChildren
protected void doDetachChildren()Description copied from class:Widget
If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and callWidget.onDetach()
for each of its child widgets.- Overrides:
doDetachChildren
in classWidget
- See Also:
-
onEnsureDebugId
Affected Elements:- -root = The root
TreeItem
.
- Overrides:
onEnsureDebugId
in classUIObject
- Parameters:
baseID
- the base ID used by the main element- See Also:
- -root = The root
-
onLoad
protected void onLoad()Description copied from class:Widget
This method is called immediately after a widget becomes attached to the browser's document. -
adopt
-
fireStateChanged
-
getChildWidgets
-
getImages
Tree.ImageAdapter getImages() -
maybeUpdateSelection
-
orphan
-
showClosedImage
Called only fromTreeItem
: Shows the closed image on that tree item.- Parameters:
treeItem
- the tree item
-
showLeafImage
Called only fromTreeItem
: Shows the leaf image on a tree item.- Parameters:
treeItem
- the tree item
-
showOpenImage
Called only fromTreeItem
: Shows the open image on a tree item.- Parameters:
treeItem
- the tree item
-
Tree(Resources)