net.sf.mmm.client.ui.impl.gwt.widget.complex.adapter

Class UiWidgetAdapterGwtTree<NODE>

java.lang.Object

net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapter<WIDGET>

net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapterWithEvents<WIDGET,EventAdapterGwt>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt<WIDGET>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidget<WIDGET>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.FlowPanel>

net.sf.mmm.client.ui.impl.gwt.widget.complex.adapter.UiWidgetAdapterGwtTree<NODE>

Type Parameters:

NODE - is the generic type of the tree-nodes.

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAltText, AttributeReadAttribute, AttributeReadColumnSpan, AttributeReadEnabled, AttributeReadFocused, AttributeReadHeightInRows, AttributeReadHtmlId, AttributeReadImage<UiWidgetImage>, AttributeReadKeyboardFilter, AttributeReadLabel, AttributeReadLengthProperty, AttributeReadMaximumTextLength, AttributeReadPrimaryStyle, AttributeReadResizable, AttributeReadSelectionMode, AttributeReadSizeInPixel, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadSummary, AttributeReadTitleVisible, AttributeReadTooltip, AttributeReadUrl, AttributeReadValidationFailure, AttributeWriteAccessKey, AttributeWriteAttribute, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteImage<UiWidgetImage>, AttributeWriteKeyboardFilter, AttributeWriteLengthProperty, AttributeWriteOnlyAttribute, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteSelectionMode, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteSummary, AttributeWriteTitleVisible, AttributeWriteTooltip, UiWidgetAdapter, UiWidgetAdapterActive, UiWidgetAdapterAbstractDataSet<NODE>, UiWidgetAdapterTree<NODE>, HandlerRegistrationCollector, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, Accessibility

public class UiWidgetAdapterGwtTree<NODE>
extends UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.FlowPanel>
implements UiWidgetAdapterTree<NODE>

This is the implementation of UiWidgetAdapterTree using GWT based on Tree.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	UiWidgetAdapterGwtTree.EventAdapterGwtTree
protected class	UiWidgetAdapterGwtTree.TreeNodeAdapter This inner class adapts from <NODE> to TreeItem.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<NODE,UiWidgetAdapterGwtTree.TreeNodeAdapter>	nodeMap Maps from <NODE> to UiWidgetAdapterGwtTree.TreeNodeAdapter.
private NODE	rootNode
private UiWidgetAdapterGwtTree.TreeNodeAdapter	rootNodeAdapter The UiWidgetAdapterGwtTree.TreeNodeAdapter for rootNode.
private com.google.gwt.user.client.ui.ScrollPanel	scrollPanel
private SelectionMode	selectionMode
private com.google.gwt.user.client.ui.InlineLabel	titleHeader
private com.google.gwt.user.client.ui.Tree	tree
private UiWidgetAbstractTree.UiTreeModel<NODE>	treeModel
private UiWidgetAbstractTree.UiTreeNodeRenderer<NODE,?>	treeNodeRenderer

Fields inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt

TAB_INDEX_NONE

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

HTML_ATTRIBUTE_ID, ID_SEPARATOR, PROPERTY_ID

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

PROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLE

Fields inherited from interface net.sf.mmm.util.lang.api.concern.Accessibility

WAI_ARIA

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAccessKey

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadSummary

PROPERTY_SUMMARY

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStringTitle

PROPERTY_TITLE

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadLabel

PROPERTY_LABEL

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadColumnSpan

ATTRIBUTE_COLSPAN

Constructor Summary

Constructors

Constructor and Description
UiWidgetAdapterGwtTree() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	applyEventAdapterForSelection(EventAdapterGwt adapter) Applies for EventType.SELECTION_CHANGE events.
protected void	clearMultiSelection() Clear SimpleCheckBoxes of SelectionMode.MULTIPLE_SELECTION.
void	collapseAllNodes()
protected EventAdapterGwt	createEventAdapter(UiFeatureEvent source, UiHandlerEvent sender) This method creates the AbstractUiWidgetAdapterWithEvents.getEventAdapter() instance.
protected com.google.gwt.user.client.ui.FlowPanel	createToplevelWidget() This method creates the underlying widget.
private UiWidgetAdapterGwtTree.TreeNodeAdapter	createTreeNodeAdapter(NODE node)
void	expandNodes()
com.google.gwt.user.client.ui.Tree	getGwtTree()
com.google.gwt.user.client.ui.ScrollPanel	getScrollPanel()
protected com.google.gwt.dom.client.Element	getSizeElement()
String	getSummary() This method gets the summary of this object.
com.google.gwt.user.client.ui.InlineLabel	getTitleHeader()
UiWidgetAbstractTree.UiWidgetTreeNode<NODE>	getTreeNodeWidget(NODE node)
protected AbstractUiWidgetTree<?,NODE>	getUiWidgetTyped() This method is a design suggestion for implementations of widget adapters that need typed access to AbstractUiWidgetAdapter.getUiWidget() and want to perform the cast only in a single place.
protected com.google.gwt.user.client.ui.Focusable	getWidgetAsFocusable()
protected com.google.gwt.event.dom.client.HasAllFocusHandlers	getWidgetAsHasAllFocusHandlers()
protected com.google.gwt.event.dom.client.HasKeyPressHandlers	getWidgetAsKeyPressHandlers()
boolean	isTitleVisible() This method determines if the title of this object is visible.
private void	onOpenEvent(com.google.gwt.event.logical.shared.OpenEvent<com.google.gwt.user.client.ui.TreeItem> event)
void	setEnabled(boolean enabled) This method sets the enabled status of this object.
void	setRootNode(NODE node)
void	setSelectionMode(SelectionMode selectionMode) This method sets the selection mode.
void	setSummary(String summary) This method sets the summary of this object.
void	setTitle(String title) This method sets the title of this object.
void	setTitleVisible(boolean titleVisible) This method sets the titleVisible flag of this object.
void	setTreeModel(UiWidgetAbstractTree.UiTreeModel<NODE> treeModel)
void	setTreeNodeRenderer(UiWidgetAbstractTree.UiTreeNodeRenderer<NODE,?> renderer)

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidgetActive

applyEventAdapterForClick, applyEventAdapterForFocus, getKeyboardFilter, getWidgetAsHasBlurHandlers, getWidgetAsHasFocusHandlers, setAccessKey, setClickEventSender, setFocused, setKeyboardFilter

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidget

dispose, getActiveWidget, removeFromParent

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt

addHandlerRegistration, addStyle, createAbsoluteImageUrl, getHeightInPixel, getImage, getImageParentElement, getLength, getToplevelWidget, getToplevelWidget, getWidthInPixel, isStyleDeltaSupported, removeStyle, setAttribute, setId, setImage, setLength, setPrimaryStyle, setStyles, setTooltip, setVisible

Methods inherited from class net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapterWithEvents

applyEventAdapter, applyEventAdapterForChange, getEventAdapter, setEventSender

Methods inherited from class net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapter

createLabel, getAccessKey, getAltText, getAttribute, getBundle, getColumnSpan, getContext, getHeightInRows, getId, getLabel, getMaximumTextLength, getPrimaryStyle, getSelectionMode, getStyles, getTitle, getTooltip, getToplevelWidget, getUiWidget, getUrl, getValidationFailure, hasStyle, isDisposed, isEnabled, isFocused, isResizable, setMode, setParent, setUiWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.mmm.client.ui.base.widget.adapter.UiWidgetAdapter

createAbsoluteImageUrl, createLabel, getToplevelWidget, isStyleDeltaSupported, removeFromParent, setEventSender, setMode, setParent, setVisible

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteHtmlId

setId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

getId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteTooltip

setTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadTooltip

getTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadEnabled

isEnabled

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStylesAdvanced

addStyle, removeStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStylesAdvanced

hasStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStyles

setStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

getStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWritePrimaryStyle

setPrimaryStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadPrimaryStyle

getPrimaryStyle

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteDisposed

dispose

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadDisposed

isDisposed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteLengthProperty

setLength

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadLengthProperty

getLength

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadSizeInPixel

getHeightInPixel, getWidthInPixel

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAttribute

getAttribute

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteOnlyAttribute

setAttribute

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadFocused

isFocused

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteOnlyFocused

setFocused

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteAccessKey

setAccessKey

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAccessKey

getAccessKey

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadSelectionMode

getSelectionMode

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStringTitle

getTitle

Field Detail

rootNode

private NODE rootNode

See Also:

setRootNode(Object)

treeModel

private UiWidgetAbstractTree.UiTreeModel<NODE> treeModel

See Also:

#setTreeModel(UiTreeModel)

treeNodeRenderer

private UiWidgetAbstractTree.UiTreeNodeRenderer<NODE,?> treeNodeRenderer

See Also:

#setTreeNodeRenderer(UiTreeNodeRenderer)

nodeMap

private Map<NODE,UiWidgetAdapterGwtTree.TreeNodeAdapter> nodeMap

Maps from <NODE> to UiWidgetAdapterGwtTree.TreeNodeAdapter.

titleHeader

private com.google.gwt.user.client.ui.InlineLabel titleHeader

See Also:

setTitle(String)

tree

private com.google.gwt.user.client.ui.Tree tree

See Also:

getGwtTree()

scrollPanel

private com.google.gwt.user.client.ui.ScrollPanel scrollPanel

See Also:

getScrollPanel()

selectionMode

private SelectionMode selectionMode

See Also:

setSelectionMode(SelectionMode)

rootNodeAdapter

private UiWidgetAdapterGwtTree.TreeNodeAdapter rootNodeAdapter

The UiWidgetAdapterGwtTree.TreeNodeAdapter for rootNode.

Constructor Detail

UiWidgetAdapterGwtTree

public UiWidgetAdapterGwtTree()

The constructor.

Method Detail

setTreeModel

public void setTreeModel(UiWidgetAbstractTree.UiTreeModel<NODE> treeModel)

Specified by:

setTreeModel in interface UiWidgetAdapterTree<NODE>

Parameters:

treeModel - is the UiWidgetAbstractTree.UiTreeModel.

setTreeNodeRenderer

public void setTreeNodeRenderer(UiWidgetAbstractTree.UiTreeNodeRenderer<NODE,?> renderer)

Specified by:

setTreeNodeRenderer in interface UiWidgetAdapterTree<NODE>

Parameters:

renderer - is the UiWidgetAbstractTree.UiTreeNodeRenderer.

See Also:

UiWidgetAdapterTree#setTreeNodeRenderer(UiTreeNodeRenderer)

setSelectionMode

public void setSelectionMode(SelectionMode selectionMode)

This method sets the selection mode.
ATTENTION:
It is recommended to set the SelectionMode immediately after creating the object. The initial default is always SelectionMode.SINGLE_SELECTION. Dynamically changing the SelectionMode may be expensive or not be supported (in exotic implementations) and should therefore be avoided.

Specified by:

setSelectionMode in interface AttributeWriteSelectionMode

Parameters:

selectionMode - is the new SelectionMode.

clearMultiSelection

protected void clearMultiSelection()

Clear SimpleCheckBoxes of SelectionMode.MULTIPLE_SELECTION.

getTreeNodeWidget

public UiWidgetAbstractTree.UiWidgetTreeNode<NODE> getTreeNodeWidget(NODE node)

Specified by:

getTreeNodeWidget in interface UiWidgetAdapterTree<NODE>

Parameters:

node - is the <NODE>.

Returns:

is the UiWidgetAbstractTree.UiWidgetTreeNode or null.

See Also:

UiWidgetAdapterTree.getTreeNodeWidget(Object)

collapseAllNodes

public void collapseAllNodes()

Specified by:

collapseAllNodes in interface UiWidgetAdapterTree<NODE>

See Also:

UiWidgetAdapterTree.collapseAllNodes()

expandNodes

public void expandNodes()

Specified by:

expandNodes in interface UiWidgetAdapterTree<NODE>

See Also:

UiWidgetAdapterTree.expandNodes()

setRootNode

public void setRootNode(NODE node)

Specified by:

setRootNode in interface UiWidgetAdapterTree<NODE>

Parameters:

node - is the root node.

createTreeNodeAdapter

private UiWidgetAdapterGwtTree.TreeNodeAdapter createTreeNodeAdapter(NODE node)

Parameters:

node - is the <NODE> to wrap.

Returns:

the UiWidgetAdapterGwtTree.TreeNodeAdapter for the given node.

createEventAdapter

protected EventAdapterGwt createEventAdapter(UiFeatureEvent source,
                                             UiHandlerEvent sender)

This method creates the AbstractUiWidgetAdapterWithEvents.getEventAdapter() instance. It should to be implemented by the top-level widget-adapter class specific for a native UI toolkit. It may further be overridden to use a sub-class instead when more specific behavior is needed.

Overrides:

createEventAdapter in class UiWidgetAdapterGwt<com.google.gwt.user.client.ui.FlowPanel>

Parameters:

source - is the source of the events (typically UiWidget).

sender - is the sender of events (an adapter that delegates to the individual handlers/listeners).

Returns:

the new event adapter.

applyEventAdapterForSelection

protected void applyEventAdapterForSelection(EventAdapterGwt adapter)

Applies for EventType.SELECTION_CHANGE events.

Overrides:

applyEventAdapterForSelection in class AbstractUiWidgetAdapterWithEvents<com.google.gwt.user.client.ui.FlowPanel,EventAdapterGwt>

Parameters:

adapter - is the event adapter.

getWidgetAsFocusable

protected com.google.gwt.user.client.ui.Focusable getWidgetAsFocusable()

Specified by:

getWidgetAsFocusable in class UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.FlowPanel>

Returns:

the widget as Focusable or null if NOT supported.

getWidgetAsKeyPressHandlers

protected com.google.gwt.event.dom.client.HasKeyPressHandlers getWidgetAsKeyPressHandlers()

Specified by:

getWidgetAsKeyPressHandlers in class UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.FlowPanel>

Returns:

the widget as HasKeyPressHandlers or null if NOT supported.

getWidgetAsHasAllFocusHandlers

protected com.google.gwt.event.dom.client.HasAllFocusHandlers getWidgetAsHasAllFocusHandlers()

Specified by:

getWidgetAsHasAllFocusHandlers in class UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.FlowPanel>

Returns:

the widget as HasAllFocusHandlers or null if NOT supported.

setTitle

public void setTitle(String title)

This method sets the title of this object.

Specified by:

setTitle in interface AttributeWriteStringTitle

Specified by:

setTitle in interface AttributeWriteTitle<String>

Parameters:

title - is the new title.

See Also:

AttributeReadStringTitle.getTitle()

setEnabled

public void setEnabled(boolean enabled)

This method sets the enabled status of this object. If it is disabled, the user can not interact with the object.

Specified by:

setEnabled in interface AttributeWriteEnabled

Parameters:

enabled - - if true the object will be enabled, else the object will be disabled.

onOpenEvent

private void onOpenEvent(com.google.gwt.event.logical.shared.OpenEvent<com.google.gwt.user.client.ui.TreeItem> event)

Parameters:

event - is the OpenEvent.

getGwtTree

public com.google.gwt.user.client.ui.Tree getGwtTree()

Returns:

the raw GWT Tree.

getScrollPanel

public com.google.gwt.user.client.ui.ScrollPanel getScrollPanel()

Returns:

the ScrollPanel containing the tree.

getSizeElement

protected com.google.gwt.dom.client.Element getSizeElement()

Overrides:

getSizeElement in class UiWidgetAdapterGwt<com.google.gwt.user.client.ui.FlowPanel>

Returns:

the sized Element used by UiWidgetAdapterGwt.getLength(LengthProperty) and UiWidgetAdapterGwt.setLength(LengthProperty, Length).

getTitleHeader

public com.google.gwt.user.client.ui.InlineLabel getTitleHeader()

Returns:

the titleHeader

isTitleVisible

public boolean isTitleVisible()

This method determines if the title of this object is visible. For Accessibility reasons you should always set the title of a titled object. However in specific cases you want to save space on the screen and may not require the title to be displayed for seeing users. Then you can hide the title while it is still recognized by assistive technology such as screen readers.

Specified by:

isTitleVisible in interface AttributeReadTitleVisible

Returns:

true if visible, false if hidden.

setTitleVisible

public void setTitleVisible(boolean titleVisible)

This method sets the titleVisible flag of this object.

Specified by:

setTitleVisible in interface AttributeWriteTitleVisible

Parameters:

titleVisible - is the new value for AttributeReadTitleVisible.isTitleVisible().

setSummary

public void setSummary(String summary)

This method sets the summary of this object.

Specified by:

setSummary in interface AttributeWriteSummary

Parameters:

summary - is the new summary to set.

getSummary

public String getSummary()

This method gets the summary of this object. It describes the main purpose of this object in a short and compact way. A summary might not be visible but is honored by assistive technology such as screen-readers.

Specified by:

getSummary in interface AttributeReadSummary

Returns:

the text. Will be the empty string if no text has been set.

getUiWidgetTyped

protected AbstractUiWidgetTree<?,NODE> getUiWidgetTyped()

This method is a design suggestion for implementations of widget adapters that need typed access to AbstractUiWidgetAdapter.getUiWidget() and want to perform the cast only in a single place. If you would override AbstractUiWidgetAdapter.getUiWidget() to add the cast and do that multiple times across the inheritance hierarchy this would cause multiple/unnecessary casts. Casting is required as we already declare enough generics for widget adapters and also want to keep the code more flexible.

Overrides:

getUiWidgetTyped in class AbstractUiWidgetAdapter<com.google.gwt.user.client.ui.FlowPanel>

Returns:

the UiWidget potentially specifically typed.

createToplevelWidget

protected com.google.gwt.user.client.ui.FlowPanel createToplevelWidget()

This method creates the underlying widget.
ATTENTION:
This method is called from the constructor but implemented in sub-classes. You should NOT access or even modify member variables as they are NOT set at this point (even final members). However, this design is done by intention instead of passing the widget as constructor argument to give more flexibility by overriding and also for potential lazy initialization of the widget.

Specified by:

createToplevelWidget in class AbstractUiWidgetAdapter<com.google.gwt.user.client.ui.FlowPanel>

Returns:

a new instance of the underlying widget.