public interface Tree<E extends Entity> extends ListComponent<E>, Component.Editable, Component.HasButtonsPanel, Component.HasCaption, Component.HasIcon, LookupComponent, Component.Focusable
Modifier and Type | Interface and Description |
---|---|
static interface |
Tree.StyleProvider<E extends Entity>
Allows to define different styles for tree items.
|
ListComponent.IconProvider<E extends Entity>
Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper
LookupComponent.LookupSelectionChangeEvent, LookupComponent.LookupSelectionChangeListener, LookupComponent.LookupSelectionChangeNotifier
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS
Modifier and Type | Method and Description |
---|---|
void |
addStyleProvider(Tree.StyleProvider<? super E> styleProvider) |
void |
collapse(java.lang.Object itemId) |
void |
collapseTree() |
void |
expand(java.lang.Object itemId) |
void |
expandTree() |
void |
expandUpTo(int level)
Expand tree including specified level
|
CaptionMode |
getCaptionMode() |
java.lang.String |
getCaptionProperty() |
HierarchicalDatasource |
getDatasource() |
Action |
getEnterPressAction() |
java.lang.String |
getHierarchyProperty() |
Action |
getItemClickAction() |
boolean |
isExpanded(java.lang.Object itemId) |
void |
refresh()
Deprecated.
refresh datasource instead
|
void |
removeStyleProvider(Tree.StyleProvider<? super E> styleProvider) |
void |
repaint()
Repaint UI representation of the tree including style providers and icon providers without refreshing the tree data.
|
void |
setCaptionMode(CaptionMode captionMode) |
void |
setCaptionProperty(java.lang.String captionProperty) |
void |
setDatasource(HierarchicalDatasource datasource) |
void |
setEnterPressAction(Action action)
Set action to be executed on Enter key press.
|
void |
setIconProvider(ListComponent.IconProvider<? super E> iconProvider)
Set the icon provider for the tree.
|
void |
setItemClickAction(Action action)
Assign action to be executed on double click inside a tree node.
|
void |
setMultiSelect(boolean multiselect) |
void |
setStyleProvider(Tree.StyleProvider<? super E> styleProvider) |
getSelected, getSingleSelected, isMultiSelect, setSelected, setSelected
getFrame, setFrame
addAction, addAction, getAction, getActionNN, getActions, removeAction, removeAction, removeAllActions
addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition
isEditable, isEditableWithParent, setEditable
getButtonsPanel, setButtonsPanel
getCaption, getDescription, setCaption, setDescription
getIcon, setIcon, setIconFromSet
getLookupSelectedItems, setLookupSelectHandler
getTabIndex, isFocusable, setFocusable, setTabIndex
static final java.lang.String NAME
void expandTree()
void expand(java.lang.Object itemId)
void collapseTree()
void collapse(java.lang.Object itemId)
void expandUpTo(int level)
level
- level of Tree nodes to expand, if passed level = 1 then root items will be expandedjava.lang.IllegalArgumentException
- if level < 1boolean isExpanded(java.lang.Object itemId)
CaptionMode getCaptionMode()
void setCaptionMode(CaptionMode captionMode)
java.lang.String getCaptionProperty()
void setCaptionProperty(java.lang.String captionProperty)
java.lang.String getHierarchyProperty()
void setDatasource(HierarchicalDatasource datasource)
HierarchicalDatasource getDatasource()
getDatasource
in interface ListComponent<E extends Entity>
void setItemClickAction(Action action)
Action getItemClickAction()
void setStyleProvider(@Nullable Tree.StyleProvider<? super E> styleProvider)
void addStyleProvider(Tree.StyleProvider<? super E> styleProvider)
void removeStyleProvider(Tree.StyleProvider<? super E> styleProvider)
void setIconProvider(ListComponent.IconProvider<? super E> iconProvider)
void repaint()
void setEnterPressAction(Action action)
Action getEnterPressAction()
void setMultiSelect(boolean multiselect)
@Deprecated void refresh()