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

Class UiWidgetAdapterGwtTree.TreeNodeAdapter

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.TreeItem

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

All Implemented Interfaces:

com.google.gwt.event.dom.client.ClickHandler, com.google.gwt.event.logical.shared.ValueChangeHandler<Boolean>, com.google.gwt.event.shared.EventHandler, com.google.gwt.safehtml.client.HasSafeHtml, com.google.gwt.user.client.ui.HasHTML, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasTreeItems, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsTreeItem, Consumer<List<NODE>>, AttributeReadAriaRole, AttributeReadCollapsed, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteCollapsed, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteMode, AttributeWriteModeFixed, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiWidgetAbstractTree.UiWidgetTreeNode<NODE>, UiWidget, AttributeReadDisposed, AttributeReadId<String>, AttributeReadValue<NODE>, AttributeWriteDisposed, AttributeWriteId<String>, Accessibility, AbstractValidatableObject

Enclosing class:

UiWidgetAdapterGwtTree<NODE>

protected class UiWidgetAdapterGwtTree.TreeNodeAdapter
extends com.google.gwt.user.client.ui.TreeItem
implements Consumer<List<NODE>>, com.google.gwt.event.logical.shared.ValueChangeHandler<Boolean>, com.google.gwt.event.dom.client.ClickHandler, UiWidgetAbstractTree.UiWidgetTreeNode<NODE>

This inner class adapts from <NODE> to TreeItem.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	UiWidgetAdapterGwtTree.TreeNodeAdapter.SizeImpl The implementation of Size for UiWidgetAdapterGwtTree.TreeNodeAdapter.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.TreeItem

com.google.gwt.user.client.ui.TreeItem.TreeItemImpl, com.google.gwt.user.client.ui.TreeItem.TreeItemImplIE8ToIE10

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasTreeItems

com.google.gwt.user.client.ui.HasTreeItems.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	loaded
private com.google.gwt.user.client.ui.SimpleCheckBox	multiSelectionCheckbox The SimpleCheckBox for SelectionMode.MULTIPLE_SELECTION.
private NODE	node
private UiWidgetRegular	nodeWidget
private Size	size
private com.google.gwt.user.client.ui.FlowPanel	widgetPanel

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Fields inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

STYLE_HEADER

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

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TreeNodeAdapter() The dummy constructor.
	TreeNodeAdapter(NODE node, UiWidgetRegular widget) The constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(List<NODE> value) Accept an input value.
void	addEventHandler(UiHandlerEvent handler) This method adds the given UiHandlerEvent to this object.
boolean	addStyle(String style) This method adds the given style to the styles.
private void	clearChildren() Clears all existing children.
void	clearMessages() This method is clearing all messages.
void	dispose() This method disposes this object.
Role	getAriaRole() This method gets the Accessibility.WAI_ARIA role of this object.
UiContext	getContext() This method gets the UiContext.
String	getId() This method gets the unique identifier of this object.
UiMode	getMode() This method gets the current UiMode of this object.
UiMode	getModeFixed() This method gets the fixed UiMode of this object.
NODE	getNode()
UiWidgetRegular	getNodeWidget() Please note that you may need to cast to the UiWidgetRegular-type according to your UiWidgetAbstractTree.UiTreeNodeRenderer.
UiWidgetComposite<?>	getParent()
String	getPrimaryStyle() This method gets the primary style of this object.
Size	getSize()
String	getStyles() This method gets the style(s) (also called style-name(s)) of this object.
String	getTooltip() This method gets the tooltip of this object.
NODE	getValue() This method gets the value of this object.
AttributeWriteFlagAdvanced	getVisibleFlag() This method gets advanced visibility support.
com.google.gwt.user.client.ui.FlowPanel	getWidgetPanel()
boolean	hasStyle(String style) This method checks if the given style is contained in the set of styles of this object.
private void	initializeMultiSelection() Initializes checkboxes for multi-selection.
boolean	isCollapsed() This method determines if this object is collapsed.
boolean	isDisposed() This method tests if this object has been disposed.
boolean	isEnabled() This method determines if this object is enabled.
boolean	isModified() This method determines if this object (or more precisely its value) is modified.
boolean	isVisibleRecursive() This method determines if this object is actually visible for the end-user.
protected void	loadChildren() Loads the children of this node asynchronously.
void	onClick(com.google.gwt.event.dom.client.ClickEvent event)
void	onValueChange(com.google.gwt.event.logical.shared.ValueChangeEvent<Boolean> event)
boolean	removeEventHandler(UiHandlerEvent handler) This method removes the given UiHandlerEvent from this object.
boolean	removeStyle(String style) This method removes the given style from the styles.
void	setCollapsed(boolean collapsed) This method sets the collapsed status of this object.
void	setEnabled(boolean enabled) This method sets the enabled status of this object.
void	setId(String id) This method set the ID of this object.
void	setMode(UiMode mode) This method sets the mode of this object.
void	setModeFixed(UiMode mode) This method sets the fixed mode of this object.
private void	setNodeSelected(boolean selected) Sets the selection state.
void	setPrimaryStyle(String primaryStyle) This method sets the primary style.
void	setStyles(String styles) This method clears all styles and sets them to the given styles.
void	setTooltip(String tooltip) This method sets the tooltip text of this object.
void	setVisible(boolean visible, boolean programmatic) This method shows or hides this object.
protected void	updateNode() Updates the UI of this node.
private void	updateSelectionMode() Recursively updates the SelectionMode.
boolean	validate(ValidationState state) This method performs the actual validation.

Methods inherited from class com.google.gwt.user.client.ui.TreeItem

addItem, addItem, addItem, addItem, addTextItem, asTreeItem, getChild, getChildCount, getChildIndex, getFocusable, getFocusableWidget, getHTML, getParentItem, getState, getText, getTree, getUserObject, getWidget, insertItem, insertItem, insertItem, insertTextItem, isSelected, onEnsureDebugId, remove, removeItem, removeItem, removeItems, setHTML, setHTML, setSelected, setState, setState, setText, setUserObject, setWidget

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, sinkEvents, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

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

isVisible, setVisible

Field Detail

node

private final NODE node

See Also:

getNode()

nodeWidget

private final UiWidgetRegular nodeWidget

See Also:

TreeItem.getWidget()

loaded

private boolean loaded

See Also:

loadChildren()

widgetPanel

private com.google.gwt.user.client.ui.FlowPanel widgetPanel

See Also:

getWidgetPanel()

multiSelectionCheckbox

private com.google.gwt.user.client.ui.SimpleCheckBox multiSelectionCheckbox

The SimpleCheckBox for SelectionMode.MULTIPLE_SELECTION.

size

private Size size

See Also:

getSize()

Constructor Detail

TreeNodeAdapter

private TreeNodeAdapter()

The dummy constructor.

TreeNodeAdapter

public TreeNodeAdapter(NODE node,
                       UiWidgetRegular widget)

The constructor.

Parameters:

node - is the unwrapped node (business object).

widget - is the UiWidgetRegular rendering this node.

Method Detail

getNode

public NODE getNode()

Returns:

the node

getWidgetPanel

public com.google.gwt.user.client.ui.FlowPanel getWidgetPanel()

Returns:

the widgetPanel

updateNode

protected void updateNode()

Updates the UI of this node.

loadChildren

protected void loadChildren()

Loads the children of this node asynchronously.

accept

public void accept(List<NODE> value)

Accept an input value.

Specified by:

accept in interface Consumer<List<NODE>>

Parameters:

value - the input object to consume.

clearChildren

private void clearChildren()

Clears all existing children.

updateSelectionMode

private void updateSelectionMode()

Recursively updates the SelectionMode.

initializeMultiSelection

private void initializeMultiSelection()

Initializes checkboxes for multi-selection.

onClick

public void onClick(com.google.gwt.event.dom.client.ClickEvent event)

Specified by:

onClick in interface com.google.gwt.event.dom.client.ClickHandler

onValueChange

public void onValueChange(com.google.gwt.event.logical.shared.ValueChangeEvent<Boolean> event)

Specified by:

onValueChange in interface com.google.gwt.event.logical.shared.ValueChangeHandler<Boolean>

setNodeSelected

private void setNodeSelected(boolean selected)

Sets the selection state.

Parameters:

selected - - true for selected, false for not selected.

getNodeWidget

public UiWidgetRegular getNodeWidget()

Please note that you may need to cast to the UiWidgetRegular-type according to your UiWidgetAbstractTree.UiTreeNodeRenderer.

Specified by:

getNodeWidget in interface UiWidgetAbstractTree.UiWidgetTreeNode<NODE>

Returns:

the regular widget used to render the node data.

See Also:

UiWidgetAbstractTree.setTreeNodeRenderer(UiTreeNodeRenderer)

isCollapsed

public boolean isCollapsed()

This method determines if this object is collapsed. This means that some content is hidden (folded away). If it is NOT collapsed, it is called expanded and the content gets visible again.

Specified by:

isCollapsed in interface AttributeReadCollapsed

Returns:

true if this object is collapsed, false if expanded.

setCollapsed

public void setCollapsed(boolean collapsed)

This method sets the collapsed status of this object.

Specified by:

setCollapsed in interface AttributeWriteCollapsed

Parameters:

collapsed - - if true the object will be collapsed, else it will be expanded.

setTooltip

public void setTooltip(String tooltip)

This method sets the tooltip text of this object.

Specified by:

setTooltip in interface AttributeWriteTooltip

Parameters:

tooltip - is the new tooltip text or null to disable the tooltip.

See Also:

AttributeReadTooltip.getTooltip()

getTooltip

public String getTooltip()

This method gets the tooltip of this object. It is a brief description that explains this object. If the user remains on the object (e.g. with the mouse pointer) this tooltip is displayed as hover.

Specified by:

getTooltip in interface AttributeReadTooltip

Returns:

the text of this object.

setId

public void setId(String id)

This method set the ID of this object. Use this method to give the object a meaningful identifier after creation.
ATTENTION:
See javadoc of AttributeReadHtmlId.getId() for the syntax constraints of IDs.

Specified by:

setId in interface AttributeWriteHtmlId

Specified by:

setId in interface AttributeWriteId<String>

Parameters:

id - is the new ID for the object.

getId

public String getId()

This method gets the unique identifier of this object.
ATTENTION:
In order to be compliant with all possible UI toolkit implementations, a valid ID has to fulfill ECMA-262, Section 7.6. It is recommended to use IDs of the form [a-zA-Z][a-zA-Z0-9_$]*. Invalid IDs (e.g. containing colon, hash or period) are not accepted to prevent you from later having problems with CSS selectors.

Specified by:

getId in interface AttributeReadHtmlId

Specified by:

getId in interface AttributeReadId<String>

Returns:

the ID of this object.

See Also:

AttributeReadHtmlId.ID_SEPARATOR

getMode

public UiMode getMode()

This method gets the current UiMode of this object.

Specified by:

getMode in interface AttributeReadMode

Returns:

the UiMode.

setMode

public void setMode(UiMode mode)

This method sets the mode of this object. It will change the object to view or edit mode. This is a recursive operation that will also apply to all descendants of this object. If a fixed mode is set (not null), this method will have no effect and recursive calls will stop at this object.

Specified by:

setMode in interface AttributeWriteMode

Parameters:

mode - is the new UiMode to set.

setModeFixed

public void setModeFixed(UiMode mode)

This method sets the fixed mode of this object. This will set the mode to the given mode (if not null, recursively) and then mark the mode as fixed so AttributeWriteMode.setMode(UiMode) will have no effect anymore. The fixed mode itself will NOT be set recursively.
The typical use-case is to set the fixed mode to UiMode.VIEW in order to prevent a UI widget (a field or even an entire sub-dialog) from switching to edit-mode (UiMode.EDIT) so the UI widget will always remain read-only.

Specified by:

setModeFixed in interface AttributeWriteModeFixed

Parameters:

mode - is the new fixed UiMode to set. May be null to unset fixation.

getModeFixed

public UiMode getModeFixed()

This method gets the fixed UiMode of this object. While a fixed UiMode is set (NOT null) changing the mode will have no effect.

Specified by:

getModeFixed in interface AttributeReadModeFixed

Returns:

the fixed UiMode or null if the UiMode may be changed.

getParent

public UiWidgetComposite<?> getParent()

Specified by:

getParent in interface UiWidget

Returns:

the parent of this widget or null if NOT attached to the UI or if this is a root widget (e.g. UiWidgetMainWindow).

getValue

public NODE getValue()

This method gets the value of this object.

Specified by:

getValue in interface AttributeReadValue<NODE>

Returns:

the value of this object. May be null unless otherwise stated.

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.

setVisible

public void setVisible(boolean visible,
                       boolean programmatic)

This method shows or hides this object.

Specified by:

setVisible in interface AttributeWriteVisibleAdvanced

Parameters:

visible - is the new visibility status of this object. If true, the object will be shown (and raised), if false the object will be hidden (iconified).

programmatic - - see UiEvent.isProgrammatic().

See Also:

AttributeWriteVisibleAdvanced.isVisible()

isEnabled

public boolean isEnabled()

This method determines if this object is enabled. If it is NOT enabled, the user can NOT interact with the object.

Specified by:

isEnabled in interface AttributeReadEnabled

Returns:

true if this object is enabled, false if this object is disabled.

dispose

public void dispose()

This method disposes this object. The resources of the object are deallocated and the object can not be used or displayed anymore. If this is an object of the UI (user interface) it will be detached.

Specified by:

dispose in interface AttributeWriteDisposed

isDisposed

public boolean isDisposed()

This method tests if this object has been disposed. A disposed object can NOT be used anymore.

Specified by:

isDisposed in interface AttributeReadDisposed

Returns:

true if this object has been disposed.

See Also:

AttributeWriteDisposed.dispose()

isVisibleRecursive

public boolean isVisibleRecursive()

This method determines if this object is actually visible for the end-user. In advance to AttributeReadVisible.isVisible() it also takes its parent objects into account. So it only returns true if the object is actually attached to the UI and physically in the current dialogue (it may still be clipped from the screen or scrolled out of the visible panel).

Specified by:

isVisibleRecursive in interface AttributeReadVisibleRecursive

Returns:

true if visible to the end-user, false otherwise.

getContext

public UiContext getContext()

This method gets the UiContext. This is the container with central components for the UI and client infrastructure. E.g. it contains the widget-factory that created this UiWidget. It may be used internally in UiWidget implementations as well as externally to create new UiWidgets (typically children).

Specified by:

getContext in interface UiWidget

Returns:

the UiContext.

validate

public boolean validate(ValidationState state)

This method performs the actual validation.

Specified by:

validate in interface AbstractValidatableObject

Parameters:

state - is the ValidationState. Shall initially be created as new instance and passed on in case of recursive validations. May also be null and will then be created internally (in case you do not need more feedback than a boolean result).

Returns:

true if the validation of this object has been successful, false otherwise (if there are validation failures).

addEventHandler

public void addEventHandler(UiHandlerEvent handler)

This method adds the given UiHandlerEvent to this object.

Specified by:

addEventHandler in interface UiFeatureEvent

Parameters:

handler - is the UiHandlerEvent to add.

removeEventHandler

public boolean removeEventHandler(UiHandlerEvent handler)

This method removes the given UiHandlerEvent from this object.

Specified by:

removeEventHandler in interface UiFeatureEvent

Parameters:

handler - is the UiHandlerEvent to remove.

Returns:

true if the handler has been removed successfully, false if it was NOT registered and nothing has changed.

setPrimaryStyle

public void setPrimaryStyle(String primaryStyle)

This method sets the primary style.

Specified by:

setPrimaryStyle in interface AttributeWritePrimaryStyle

Parameters:

primaryStyle - is the new value for primary style.

See Also:

AttributeReadStyles.getStyles()

setStyles

public void setStyles(String styles)

This method clears all styles and sets them to the given styles. This will also update the primary style.

Specified by:

setStyles in interface AttributeWriteStyles

Parameters:

styles - are the styles of this object. Either a single style or a list of styles separated by whitespaces. Use the empty string to unset all styles.

getStyles

public String getStyles()

This method gets the style(s) (also called style-name(s)) of this object. The style defines aspects for the appearance (look & feel) of a UI element when displayed to the user.
If you are familiar with web-technology just think of this as the class attribute of HTML elements that are then configured via some cascading style sheet (CSS).
The following situations can be distinguished:

• no style
  The empty string is returned.
• single style
  The name of that single style is returned. The result does NOT contain any whitespace.
• multiple styles
  The list of individual styles are separated by whitespaces in the result.

Each individual style has to match AttributeReadStyles.STYLE_PATTERN_SINGLE. Any number of styles or in other words the result of this has to match AttributeReadStyles.STYLE_PATTERN_MULTIPLE. The first style is called the primary style.

Specified by:

getStyles in interface AttributeReadStyles

Returns:

the style(s) of this object.

addStyle

public boolean addStyle(String style)

This method adds the given style to the styles.

Specified by:

addStyle in interface AttributeWriteStylesAdvanced

Parameters:

style - is the style to add. If this style is already contained in the styles, this will have no effect.

Returns:

true if the styles has actually been added, false if it was already present before.

removeStyle

public boolean removeStyle(String style)

This method removes the given style from the styles.

Specified by:

removeStyle in interface AttributeWriteStylesAdvanced

Parameters:

style - is the style to remove. If this style is NOT contained in the styles, this will have no effect.

Returns:

true if the given style has actually been removed, false otherwise (if it was NOT present).

getPrimaryStyle

public String getPrimaryStyle()

This method gets the primary style of this object.

Specified by:

getPrimaryStyle in interface AttributeReadPrimaryStyle

Returns:

the primary style of this object. Will be null if NOT defined.

hasStyle

public boolean hasStyle(String style)

This method checks if the given style is contained in the set of styles of this object.

Specified by:

hasStyle in interface AttributeReadStylesAdvanced

Parameters:

style - is the style to check.

Returns:

true if the given style is active.

getSize

public Size getSize()

Specified by:

getSize in interface UiWidget

Returns:

the Size aspect to read and write the size of this widget.

getAriaRole

public Role getAriaRole()

This method gets the Accessibility.WAI_ARIA role of this object.
ATTENTION:
A reasonable UI framework (e.g. when using UiWidget) is supposed to provide high-level widgets and support setting the according Role and their attributes automatically. Therefore users should only use this for special situations e.g. for setting aria-hidden intentionally for a visible object.

Specified by:

getAriaRole in interface AttributeReadAriaRole

Returns:

the Role or null if NOT set.

See Also:

Accessibility

isModified

public boolean isModified()

This method determines if this object (or more precisely its value) is modified. This means that the object has been modified (via a the user interface) since it's value was programatically set for the last time. Often this is also called dirty. A composite object is also modified if one of its children are modified.
NOTE:
If the object's value is changed by the end-user to something else but then changed back to its original value it may still remain modified.

Specified by:

isModified in interface AttributeReadModified

Returns:

true if this object has been modified, false otherwise (if no changes have been made to this object).

See Also:

AttributeReadValueAdvanced.getOriginalValue(), AttributeWriteValueAdvanced.setValueForUser(Object)

getVisibleFlag

public AttributeWriteFlagAdvanced getVisibleFlag()

This method gets advanced visibility support. It allows you to read and write the visibility for different cross-cutting concerns.
Motivation:
Typical UI toolkits provide visibility as a primitive boolean attribute or property. However, this is leading to various problems if you have multiple aspects that influence the flag. E.g. assume you have some dynamic effect that is showing or hiding a widget. Additionally the widget is in a collapsable section, tab-panel, or the like that is also showing or hiding the widget. Further, there might be an authorization in your application as a cross-cutting concern that hides widgets from the UI according to the current roles and permissions of the user. If this is all based on a simple boolean flag you will end up in a mess and with a buggy application. So the dynamic effect or even worse the authorization will hide the widget but after the user collapses and then expands a panel it becomes visible again. You do not want to deal with bugs like this.
ATTENTION:
The returned instance may be lazily created. It will not be expensive but for a large UI this will sum up. In a web or especially a mobile client memory might be low. So if you are recursively traversing the UI widget tree you should only rely on AttributeWriteVisibleAdvanced.isVisible() for reading visibility.

Specified by:

getVisibleFlag in interface AttributeWriteVisibleAdvanced

Returns:

the mutable flag for advanced visibility support.

clearMessages

public void clearMessages()

This method is clearing all messages. This includes validation failures as well as other messages such as infos, errors, or warnings (e.g. in a message-panel). This is a recursive operation that is propagated to all potential children.

Specified by:

clearMessages in interface UiFeatureMessages