|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.vaadin.terminal.AbstractClientConnector com.vaadin.ui.AbstractComponent com.vaadin.ui.AbstractField<Object> com.vaadin.ui.AbstractSelect com.vaadin.ui.Tree
public class Tree
Tree component. A Tree can be used to select an item (or multiple items) from a hierarchical set of items.
Nested Class Summary | |
---|---|
static class |
Tree.CollapseEvent
Collapse event |
static interface |
Tree.CollapseListener
Collapse event listener. |
static class |
Tree.ExpandEvent
Event to fired when a node is expanded. |
static interface |
Tree.ExpandListener
Expand event listener. |
static interface |
Tree.ItemStyleGenerator
ItemStyleGenerator can be used to add custom styles to tree items. |
class |
Tree.TargetInSubtree
An accept criterion that checks the parent node (or parent hierarchy) for the item identifier given in constructor. |
static class |
Tree.TargetItemAllowsChildren
A criterion that accepts Transferable only directly on a tree
node that can have children. |
static class |
Tree.TreeDragMode
Supported drag modes for Tree. |
static class |
Tree.TreeDropCriterion
Lazy loading accept criterion for Tree. |
class |
Tree.TreeTargetDetails
A TargetDetails implementation with Tree specific api. |
protected class |
Tree.TreeTransferable
Concrete implementation of DataBoundTransferable for data
transferred from a tree. |
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField |
---|
AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent |
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent |
---|
AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler |
Nested classes/interfaces inherited from interface com.vaadin.data.Container |
---|
Container.Editor, Container.Filter, Container.Filterable, Container.Hierarchical, Container.Indexed, Container.ItemSetChangeEvent, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeEvent, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.SimpleFilterable, Container.Sortable, Container.Viewer |
Nested classes/interfaces inherited from interface com.vaadin.ui.Component |
---|
Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener |
Nested classes/interfaces inherited from interface com.vaadin.terminal.Sizeable |
---|
Sizeable.Unit |
Nested classes/interfaces inherited from interface com.vaadin.terminal.VariableOwner |
---|
VariableOwner.ErrorEvent |
Nested classes/interfaces inherited from interface com.vaadin.ui.Field |
---|
Field.ValueChangeEvent |
Nested classes/interfaces inherited from interface com.vaadin.data.Buffered |
---|
Buffered.SourceException |
Nested classes/interfaces inherited from interface com.vaadin.data.Property |
---|
Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer |
Field Summary |
---|
Fields inherited from class com.vaadin.ui.AbstractSelect |
---|
ITEM_CAPTION_MODE_EXPLICIT, ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID, ITEM_CAPTION_MODE_ICON_ONLY, ITEM_CAPTION_MODE_ID, ITEM_CAPTION_MODE_INDEX, ITEM_CAPTION_MODE_ITEM, ITEM_CAPTION_MODE_PROPERTY, itemIdMapper, items |
Fields inherited from interface com.vaadin.terminal.Sizeable |
---|
SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS |
Constructor Summary | |
---|---|
Tree()
Creates a new empty tree. |
|
Tree(String caption)
Creates a new empty tree with caption. |
|
Tree(String caption,
Container dataSource)
Creates a new tree with caption and connect it to a Container. |
Method Summary | |
---|---|
void |
addActionHandler(Action.Handler actionHandler)
Adds an action handler. |
void |
addListener(ItemClickEvent.ItemClickListener listener)
Register a listener to handle ItemClickEvent s. |
void |
addListener(Tree.CollapseListener listener)
Adds the collapse listener. |
void |
addListener(Tree.ExpandListener listener)
Adds the expand listener. |
boolean |
areChildrenAllowed(Object itemId)
Tests if the Item with given ID can have any children. |
void |
changeVariables(Object source,
Map<String,Object> variables)
Invoked when the value of a variable has changed. |
boolean |
collapseItem(Object itemId)
Collapses an item. |
boolean |
collapseItemsRecursively(Object startItemId)
Collapses the items recursively. |
boolean |
expandItem(Object itemId)
Expands an item. |
boolean |
expandItemsRecursively(Object startItemId)
Expands the items recursively Expands all the children recursively starting from an item. |
protected void |
fireCollapseEvent(Object itemId)
Emits collapse event. |
protected void |
fireExpandEvent(Object itemId)
Emits the expand event. |
Collection<?> |
getChildren(Object itemId)
Gets the IDs of all Items that are children of the specified Item. |
Tree.TreeDragMode |
getDragMode()
|
DropHandler |
getDropHandler()
|
AbstractSelect.ItemDescriptionGenerator |
getItemDescriptionGenerator()
Get the item description generator which generates tooltips for tree items |
Tree.ItemStyleGenerator |
getItemStyleGenerator()
|
AbstractSelect.MultiSelectMode |
getMultiselectMode()
Returns the mode the multiselect is in. |
Object |
getParent(Object itemId)
Gets the ID of the parent Item of the specified Item. |
Transferable |
getTransferable(Map<String,Object> payload)
DragSource may convert data added by client side component to meaningful values for server side developer or add other data based on it. |
Collection<?> |
getVisibleItemIds()
Gets the visible item ids. |
boolean |
hasChildren(Object itemId)
Tests if the Item specified with itemId has child Items. |
boolean |
isExpanded(Object itemId)
Check is an item is expanded |
boolean |
isRoot(Object itemId)
Tests if the Item specified with itemId is a root Item. |
boolean |
isSelectable()
Returns the current selectable state. |
void |
paintContent(PaintTarget target)
Paints any needed component-specific things to the given UIDL stream. |
void |
removeActionHandler(Action.Handler actionHandler)
Removes an action handler. |
void |
removeAllActionHandlers()
Removes all action handlers |
boolean |
removeItem(Object itemId)
Removes the Item identified by ItemId from the Container. |
void |
removeListener(ItemClickEvent.ItemClickListener listener)
Removes an ItemClickListener. |
void |
removeListener(Tree.CollapseListener listener)
Removes the collapse listener. |
void |
removeListener(Tree.ExpandListener listener)
Removes the expand listener. |
void |
requestRepaint()
Requests that the connector should be repainted as soon as possible. |
Collection<?> |
rootItemIds()
Gets the IDs of all Items in the container that don't have a parent. |
boolean |
setChildrenAllowed(Object itemId,
boolean areChildrenAllowed)
Sets the given Item's capability to have children. |
void |
setContainerDataSource(Container newDataSource)
Sets the Container that serves as the data source of the viewer. |
void |
setDragMode(Tree.TreeDragMode dragMode)
Sets the drag mode that controls how Tree behaves as a DragSource
. |
void |
setDropHandler(DropHandler dropHandler)
|
void |
setItemDescriptionGenerator(AbstractSelect.ItemDescriptionGenerator generator)
Set the item description generator which generates tooltips for the tree items |
void |
setItemStyleGenerator(Tree.ItemStyleGenerator itemStyleGenerator)
Sets the Tree.ItemStyleGenerator to be used with this tree. |
void |
setLazyLoading(boolean useLazyLoading)
Tree does not support lazy options loading mode. |
void |
setMultiselectMode(AbstractSelect.MultiSelectMode mode)
Sets the behavior of the multiselect mode |
void |
setNewItemsAllowed(boolean allowNewOptions)
Adding new items is not supported. |
void |
setNullSelectionItemId(Object nullSelectionItemId)
Tree does not support setNullSelectionItemId . |
boolean |
setParent(Object itemId,
Object newParentId)
Sets the parent of an Item. |
void |
setSelectable(boolean selectable)
Sets the selectable state. |
Tree.TreeTargetDetails |
translateDropTargetDetails(Map<String,Object> clientVariables)
Called before the DragAndDropEvent is passed to
DropHandler . |
Methods inherited from class com.vaadin.terminal.AbstractClientConnector |
---|
addExtension, addMethodInvocationToQueue, createState, getAllChildrenIterable, getConnectorId, getExtensions, getRpcManager, getRpcProxy, getStateType, registerRpc, registerRpc, removeExtension, requestRepaintAll, retrievePendingRpcCalls |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.vaadin.data.Container |
---|
addContainerProperty, addItem, addItem, containsId, getContainerProperty, getContainerPropertyIds, getItem, getItemIds, getType, removeAllItems, removeContainerProperty, size |
Methods inherited from interface com.vaadin.ui.Component |
---|
addListener, addStyleName, attach, getApplication, getCaption, getDebugId, getIcon, getLocale, getParent, getRoot, getState, getStyleName, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setDebugId, setEnabled, setIcon, setReadOnly, setStyleName, setVisible, updateState |
Methods inherited from interface com.vaadin.terminal.gwt.server.ClientConnector |
---|
detach, getExtensions, getStateType, isConnectorEnabled, removeExtension, requestRepaintAll, retrievePendingRpcCalls, setParent |
Methods inherited from interface com.vaadin.terminal.gwt.client.Connector |
---|
getConnectorId |
Methods inherited from interface com.vaadin.terminal.gwt.server.RpcTarget |
---|
getRpcManager |
Methods inherited from interface com.vaadin.terminal.Sizeable |
---|
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setSizeFull, setSizeUndefined, setWidth, setWidth |
Methods inherited from interface com.vaadin.terminal.VariableOwner |
---|
isEnabled, isImmediate |
Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier |
---|
addShortcutListener, removeShortcutListener |
Constructor Detail |
---|
public Tree()
public Tree(String caption)
caption
- public Tree(String caption, Container dataSource)
caption
- dataSource
- Method Detail |
---|
public boolean isExpanded(Object itemId)
itemId
- the item id.
public boolean expandItem(Object itemId)
itemId
- the item id.
public void requestRepaint()
ClientConnector
requestRepaint
in interface ClientConnector
requestRepaint
in class AbstractComponent
public boolean expandItemsRecursively(Object startItemId)
startItemId
-
public boolean collapseItem(Object itemId)
itemId
- the item id.
public boolean collapseItemsRecursively(Object startItemId)
startItemId
-
public boolean isSelectable()
AbstractSelect.setValue(Object)
or AbstractSelect.select(Object)
.
The tree is selectable by default.
public void setSelectable(boolean selectable)
AbstractSelect.setValue(Object)
or AbstractSelect.select(Object)
.
The tree is selectable by default.
selectable
- The new selectable state.public void setMultiselectMode(AbstractSelect.MultiSelectMode mode)
mode
- The mode to setpublic AbstractSelect.MultiSelectMode getMultiselectMode()
public void changeVariables(Object source, Map<String,Object> variables)
AbstractSelect
changeVariables
in interface VariableOwner
changeVariables
in class AbstractSelect
source
- the Source of the variable change. This is the origin of the
event. For example in Web Adapter this is the request.variables
- the Mapping from variable names to new variable values.com.vaadin.ui.AbstractComponent#changeVariables(java.lang.Object,
java.util.Map)
public void paintContent(PaintTarget target) throws PaintException
paintContent
in interface Vaadin6Component
paintContent
in class AbstractSelect
target
- the Paint Event.
PaintException
- if the paint operation failed.com.vaadin.ui.AbstractComponent#paintContent(PaintTarget)
public boolean areChildrenAllowed(Object itemId)
areChildrenAllowed
in interface Container.Hierarchical
itemId
- ID of the Item in the container whose child capability is
to be tested
true
if the specified Item exists in the
Container and it can have children, false
if
it's not found from the container or it can't have children.Container.Hierarchical.areChildrenAllowed(Object)
public Collection<?> getChildren(Object itemId)
getChildren
in interface Container.Hierarchical
itemId
- ID of the Item whose children the caller is interested in
collection
containing the IDs of all other Items that are children in
the container hierarchyContainer.Hierarchical.getChildren(Object)
public Object getParent(Object itemId)
getParent
in interface Container.Hierarchical
itemId
- ID of the Item whose parent the caller wishes to find out.
null
if the
specified Item is a root element.Container.Hierarchical.getParent(Object)
public boolean hasChildren(Object itemId)
itemId
has child Items.
hasChildren
in interface Container.Hierarchical
itemId
- ID of the Item to be tested
true
if the specified Item has children,
false
if not (is a leaf)Container.Hierarchical.hasChildren(Object)
public boolean isRoot(Object itemId)
itemId
is a root Item.
isRoot
in interface Container.Hierarchical
itemId
- ID of the Item whose root status is to be tested
true
if the specified Item is a root,
false
if notContainer.Hierarchical.isRoot(Object)
public Collection<?> rootItemIds()
rootItemIds
in interface Container.Hierarchical
collection
containing IDs of all root elements of the containerContainer.Hierarchical.rootItemIds()
public boolean setChildrenAllowed(Object itemId, boolean areChildrenAllowed)
setChildrenAllowed
in interface Container.Hierarchical
itemId
- ID of the Item in the container whose child capability is
to be setareChildrenAllowed
- boolean value specifying if the Item can have children or
not
true
if the operation succeeded,
false
if notContainer.Hierarchical.setChildrenAllowed(Object,
boolean)
public boolean setParent(Object itemId, Object newParentId)
Container.Hierarchical
Sets the parent of an Item. The new parent item must exist and be
able to have children. (
). It is
also possible to detach a node from the hierarchy (and thus make it
root) by setting the parent Container.Hierarchical.areChildrenAllowed(Object)
== truenull
.
This operation is optional.
setParent
in interface Container.Hierarchical
itemId
- ID of the item to be set as the child of the Item
identified with newParentId
newParentId
- ID of the Item that's to be the new parent of the Item
identified with itemId
true
if the operation succeeded,
false
if notpublic void setContainerDataSource(Container newDataSource)
setContainerDataSource
in interface Container.Viewer
setContainerDataSource
in class AbstractSelect
newDataSource
- the new data source.Container.Viewer.setContainerDataSource(Container)
public void addListener(Tree.ExpandListener listener)
listener
- the Listener to be added.public void removeListener(Tree.ExpandListener listener)
listener
- the Listener to be removed.protected void fireExpandEvent(Object itemId)
itemId
- the item id.public void addListener(Tree.CollapseListener listener)
listener
- the Listener to be added.public void removeListener(Tree.CollapseListener listener)
listener
- the Listener to be removed.protected void fireCollapseEvent(Object itemId)
itemId
- the item id.public void addActionHandler(Action.Handler actionHandler)
addActionHandler
in interface Action.Container
actionHandler
- the new handler to be added.Action.Container.addActionHandler(Action.Handler)
public void removeActionHandler(Action.Handler actionHandler)
removeActionHandler
in interface Action.Container
actionHandler
- the handler to be removed.Action.Container.removeActionHandler(Action.Handler)
public void removeAllActionHandlers()
public Collection<?> getVisibleItemIds()
getVisibleItemIds
in class AbstractSelect
AbstractSelect.getVisibleItemIds()
public void setNullSelectionItemId(Object nullSelectionItemId) throws UnsupportedOperationException
setNullSelectionItemId
.
setNullSelectionItemId
in class AbstractSelect
nullSelectionItemId
- the nullSelectionItemId to set.
UnsupportedOperationException
AbstractSelect.setNullSelectionItemId(java.lang.Object)
public void setNewItemsAllowed(boolean allowNewOptions) throws UnsupportedOperationException
setNewItemsAllowed
in class AbstractSelect
allowNewOptions
- the New value of property allowNewOptions.
UnsupportedOperationException
- if set to true.AbstractSelect.setNewItemsAllowed(boolean)
public void setLazyLoading(boolean useLazyLoading)
com.vaadin.ui.Select#setLazyLoading(boolean)
public void addListener(ItemClickEvent.ItemClickListener listener)
ItemClickEvent.ItemClickNotifier
ItemClickEvent
s.
addListener
in interface ItemClickEvent.ItemClickNotifier
listener
- ItemClickListener to be registeredpublic void removeListener(ItemClickEvent.ItemClickListener listener)
ItemClickEvent.ItemClickNotifier
removeListener
in interface ItemClickEvent.ItemClickNotifier
listener
- ItemClickListener to be removedpublic void setItemStyleGenerator(Tree.ItemStyleGenerator itemStyleGenerator)
Tree.ItemStyleGenerator
to be used with this tree.
itemStyleGenerator
- item style generator or null to remove generatorpublic Tree.ItemStyleGenerator getItemStyleGenerator()
Tree.ItemStyleGenerator
for this tree. Null if
Tree.ItemStyleGenerator
is not set.public boolean removeItem(Object itemId) throws UnsupportedOperationException
Container
ItemId
from the Container.
Containers that support filtering should also allow removing an item that is currently filtered out.
This functionality is optional.
removeItem
in interface Container
removeItem
in interface Container.Hierarchical
removeItem
in class AbstractSelect
itemId
- ID of the Item to remove
true
if the operation succeeded, false
if not
UnsupportedOperationException
- if the container does not support removing individual itemspublic DropHandler getDropHandler()
getDropHandler
in interface DropTarget
public void setDropHandler(DropHandler dropHandler)
public Tree.TreeTargetDetails translateDropTargetDetails(Map<String,Object> clientVariables)
DropTarget
DragAndDropEvent
is passed to
DropHandler
. Implementation may for example translate the drop
target details provided by the client side (drop target) to meaningful
server side values. If null is returned the terminal implementation will
automatically create a TargetDetails
with raw client side data.
translateDropTargetDetails
in interface DropTarget
clientVariables
- data passed from the DropTargets client side counterpart.
DragSource.getTransferable(Map)
public void setDragMode(Tree.TreeDragMode dragMode)
DragSource
.
dragMode
- public Tree.TreeDragMode getDragMode()
DragSource
.Tree.TreeDragMode
public Transferable getTransferable(Map<String,Object> payload)
DragSource
For example Tree converts item identifiers to generated string keys for
the client side. Vaadin developer don't and can't know anything about
these generated keys, only about item identifiers. When tree node is
dragged client puts that key to Transferable
s client side
counterpart. In getTransferable(Map)
the key is converted
back to item identifier that the server side developer can use.
getTransferable
in interface DragSource
payload
- the data that client side initially included in
Transferable
s client side counterpart.
Transferable
instance that will be passed to
DropHandler
(and/or AcceptCriterion
)public void setItemDescriptionGenerator(AbstractSelect.ItemDescriptionGenerator generator)
generator
- The generator to use or null to disablepublic AbstractSelect.ItemDescriptionGenerator getItemDescriptionGenerator()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |