AbstractUiWidgetNative (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation<VALUE>
- - net.sf.mmm.client.ui.base.widget.AbstractUiWidget<VALUE>
  - - net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative<ADAPTER,VALUE>

Type Parameters:

ADAPTER - is the generic type of getWidgetAdapter().

VALUE - is the generic type of the value. Use Void for no value.

All Implemented Interfaces:

AttributeReadAriaRole, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadValueAdvanced<VALUE>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAriaRole, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteValueAdvanced<VALUE>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiFeatureValidation<VALUE>, UiFeatureValue<VALUE>, UiFeatureValueAndValidation<VALUE>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<VALUE>, AttributeReadDisposed, AttributeReadId<String>, AttributeReadValue<VALUE>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteValue<VALUE>, Accessibility, AbstractValidatableObject, HasValueValidators<VALUE>, ValidatableObject<VALUE>

Direct Known Subclasses:

AbstractUiWidgetActive, AbstractUiWidgetComposite, AbstractUiWidgetMenuItemSeparator, AbstractUiWidgetRegularAtomic, AbstractUiWidgetTableColumn, AbstractUiWidgetWithLabel
```
public abstract class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapter,VALUE>
extends AbstractUiWidget<VALUE>
implements UiWidgetAbstractComposite, AttributeWriteAriaRole
```
This is the abstract base implementation of UiWidget or more precisely UiWidgetNative. It is independent of any native toolkit via UiWidgetAdapter that is lazily created.
If you want to create an implementation of all the UiWidgets for a native UI toolkit, you are strongly encouraged to extend from this class and its subclasses (all classes named AbstractUiWidget*).

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractUiWidgetNative.SizeImpl` This class contains the size (`Length` values) of this widget.
`private class`	`AbstractUiWidgetNative.VisibleFlag` This inner class is the implementation of the visible flag.

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget
AbstractUiWidget.AccessHelper, AbstractUiWidget.EventSender, AbstractUiWidget.HandlerContainer

Field Summary

Fields
Modifier and Type	Field and Description
`private AbstractRole`	`ariaRole`
`private boolean`	`disposed`
`private boolean`	`enabled`
`private String`	`id`
`private static int`	`idCounter`
`private static String`	`idPrefix`
`private static LengthProperty[]`	`LENGTH_PROPERTIES` The number of `LengthProperty` `values`.
`private UiMode`	`mode`
`private UiMode`	`modeFixed`
`private UiWidgetComposite<?>`	`parent`
`private AbstractUiWidgetNative.SizeImpl`	`size`
`private String`	`styles`
`private String`	`tooltip`
`private boolean`	`visible`
`private AbstractUiWidgetNative.VisibleFlag`	`visibleFlag`
`private ADAPTER`	`widgetAdapter`

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
Constructor and Description

AbstractUiWidgetNative(UiContext context, ADAPTER widgetAdapter)
The constructor.

Constructors
Constructor and Description
`AbstractUiWidgetNative(UiContext context, ADAPTER widgetAdapter)` The constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeHandler(UiHandlerEventValueChange<VALUE> handler)` This method adds the given `UiHandlerEventValueChange` to this object.
`boolean`	`addStyle(String style)` This method adds the given `style` to the `styles`.
`void`	`clearMessages()` This method is clearing all messages.
`protected void`	`clearValidity()` This method may clear potential state information from previous validations.
`protected AbstractUiWidgetNative.SizeImpl`	`createSize()`
`protected String`	`createUniqueId()`
`protected abstract ADAPTER`	`createWidgetAdapter()` This method creates the `widget adapter`.
`void`	`dispose()` This method disposes this object.
`protected VALUE`	`doGetValue(VALUE template, ValidationState state)` This method is called from the `data-binding` triggered by API methods such as `AbstractUiFeatureValueAndValidation.getValue()`.
`protected void`	`doSetMode(UiMode uiMode)` This method is called from `setMode(UiMode)` if the `UiMode` actually changed.
`protected void`	`doSetValue(VALUE value, boolean forUser)` This method is called from the `data-binding` triggered by API methods such as `AbstractUiWidget.setValue(Object, boolean)`.
`protected void`	`doValidate(ValidationState state, VALUE value)` This method is called from `AbstractUiFeatureValueAndValidation.validate(ValidationState)` and performs the actual validation of this object.
`Role`	`getAriaRole()` This method gets the `Accessibility.WAI_ARIA` `role` of this object.
`protected Class<? extends Role>`	`getAriaRoleFixedType()`
`UiWidget`	`getChild(int index)` This method gets the child at the given index.
`UiWidget`	`getChild(String childId)` This method gets the child with the given `id`.
`int`	`getChildCount()` This method gets the number of children in this composite.
`int`	`getChildIndex(UiWidget child)` This method determines the index of the given `child` in the list of `children` of this composite.
`String`	`getId()` This method gets the unique identifier of this object.
`private int`	`getIndexOfStyle(String style)`
`static int`	`getIndexOfStyle(String allStyles, String style)`
`UiMode`	`getMode()` This method gets the current `UiMode` of this object.
`UiMode`	`getModeFixed()` This method gets the fixed `UiMode` of this object.
`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.
`AttributeWriteFlagAdvanced`	`getVisibleFlag()` This method gets advanced visibility support.
`protected ADAPTER`	`getWidgetAdapter()` This method gets or creates the `UiWidgetAdapter`.
`static <A extends UiWidgetAdapter> A`	`getWidgetAdapter(AbstractUiWidgetNative<A,?> widget)` This method gives access to `getWidgetAdapter()`.
`boolean`	`hasStyle(String style)` This method checks if the given `style` is contained in the `set of styles` of this object.
`boolean`	`hasWidgetAdapter()`
`protected void`	`initializeWidgetAdapter(ADAPTER adapter)` This method is called from `getWidgetAdapter()` to initialize the `UiWidgetAdapter`.
`boolean`	`isDisposed()` This method tests if this object has been `disposed`.
`boolean`	`isEnabled()` This method determines if this object is enabled.
`protected boolean`	`isModifiedRecursive()`
`boolean`	`isVisible()` This method determines if this object is `set` to visible.
`boolean`	`isVisibleRecursive()` This method determines if this object is actually visible for the end-user.
`boolean`	`removeChangeHandler(UiHandlerEventValueChange<VALUE> handler)` This method removes the given `UiHandlerEventValueChange` from this object.
`protected void`	`removeFromParent()` This method removes this widget from its `parent`.
`boolean`	`removeStyle(String style)` This method removes the given `style` from the `styles`.
`<ROLE extends Role> ROLE`	`setAriaRole(Class<ROLE> roleType)` This method sets the `ARIA role` of this object.
`void`	`setEnabled(boolean enabled)` This method sets the `enabled` status of this object.
`boolean`	`setFocused()` This method sets the `focus` to this object.
`void`	`setId(String newId)` This method set the `ID` of this object.
`static void`	`setIdPrefix(String idPrefix)` This method sets the static prefix used for generated IDs.
`void`	`setMode(UiMode mode)` This method sets the `mode` of this object.
`protected void`	`setMode(UiMode newMode, boolean programmatic)`
`void`	`setModeFixed(UiMode modeFixed)` This method sets the `fixed mode` of this object.
`(package private) void`	`setModeRecursive(UiMode newMode, boolean programmatic)` This method is called from `setMode(UiMode)` to recursively change the `UiMode`.
`protected void`	`setParent(UiWidgetComposite<?> parent)` This method sets the `parent`.
`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)` This method shows or hides this object.
`void`	`setVisible(boolean visibility, boolean programmatic)` This method shows or hides this object.
`String`	`toString()`
`(package private) void`	`validateRecursive(ValidationState state)` This method performs the recursive validation of potential children of this widget excluding the validation of this widget itself.
`protected void`	`visibilityChanged(boolean visibility, boolean programmatic)` Called from `setVisible(boolean)` is the visibility has actually changed.

Methods inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget
addEventHandler, addValidator, clearMessagesLocal, clearValidationFailure, convertValueToString, fireEvent, fireValueChange, getBasicUtil, getContext, getDataBinding, getDataBinding, getDataBindingForWidget, getEventSender, getFactory, getLogger, getObserverSource, getOriginalValue, getRecentValue, getSource, getValueClass, getValueDirect, getValueOrException, getWidgetAdapter, hasEventSender, isMandatory, isModified, removeEventHandler, removeFromParent, removeValidator, setMandatory, setModified, setParent, setValue

Methods inherited from class net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation
addValidatorMandatory, createValidationFailure, getValue, getValueAndValidate, handleGetValueError, resetValue, setValue, setValueForUser, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureEvent
addEventHandler, removeEventHandler

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

Methods inherited from interface net.sf.mmm.util.validation.api.AbstractValidatableObject
validate

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteValueAdvanced
resetValue, setValue, setValueForUser

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

- Field Detail
  - LENGTH_PROPERTIES
```
private static final LengthProperty[] LENGTH_PROPERTIES
```
    The number of LengthProperty values.
  - idPrefix
```
private static String idPrefix
```
    See Also:
    
    setIdPrefix(String)
  - idCounter
```
private static int idCounter
```
    See Also:
    
    createUniqueId()
  - widgetAdapter
```
private ADAPTER extends UiWidgetAdapter widgetAdapter
```
    See Also:
    
    getWidgetAdapter()
  - parent
```
private UiWidgetComposite<?> parent
```
    See Also:
    
    getParent()
  - id
```
private String id
```
    See Also:
    
    getId()
  - visible
```
private boolean visible
```
    See Also:
    
    isVisible()
  - visibleFlag
```
private AbstractUiWidgetNative.VisibleFlag visibleFlag
```
    See Also:
    
    getVisibleFlag()
  - enabled
```
private boolean enabled
```
    See Also:
    
    isEnabled()
  - disposed
```
private boolean disposed
```
    See Also:
    
    isDisposed()
  - tooltip
```
private String tooltip
```
    See Also:
    
    getTooltip()
  - styles
```
private String styles
```
    See Also:
    
    getStyles()
  - size
```
private AbstractUiWidgetNative.SizeImpl size
```
    See Also:
    
    getSize()
  - ariaRole
```
private AbstractRole ariaRole
```
    See Also:
    
    getAriaRole()
  - mode
```
private UiMode mode
```
    See Also:
    
    getMode()
  - modeFixed
```
private UiMode modeFixed
```
    See Also:
    
    getModeFixed()
- Constructor Detail
  - AbstractUiWidgetNative
```
public AbstractUiWidgetNative(UiContext context,
                              ADAPTER widgetAdapter)
```
    The constructor.
    
    Parameters:
    
    context - is the context.
    
    widgetAdapter - is the widget adapter. Typically null for lazy initialization.
- Method Detail
  - hasWidgetAdapter
```
public final boolean hasWidgetAdapter()
```
    Specified by:
    
    hasWidgetAdapter in class AbstractUiWidget<VALUE>
    
    Returns:
    
    true if the UiWidgetAdapter has already been created. Otherwise false (if AbstractUiWidget.getWidgetAdapter() has never been called yet).
  - getWidgetAdapter
```
protected final ADAPTER getWidgetAdapter()
```
    This method gets or creates the UiWidgetAdapter.
    ATTENTION:
    On the first call of this method, the UiWidgetAdapter is created. For the purpose of lazy instantiation this should happen as late as possible. Use AbstractUiWidget.hasWidgetAdapter() to prevent unnecessary creation.
    
    Specified by:
    
    getWidgetAdapter in class AbstractUiWidget<VALUE>
    
    Returns:
    
    the UiWidgetAdapter.
  - getWidgetAdapter
```
public static final <A extends UiWidgetAdapter> A getWidgetAdapter(AbstractUiWidgetNative<A,?> widget)
```
    This method gives access to getWidgetAdapter().
    ATTENTION:
    This method is only for internal purposes when implementing UiWidgets. It shall never be used by regular users (what also applies for all classes in this base packages).
    
    Type Parameters:
    
    A - is the generic type of getWidgetAdapter().
    
    Parameters:
    
    widget - is the widget.
    
    Returns:
    
    the widget adapter of the given widget.
  - initializeWidgetAdapter
```
protected void initializeWidgetAdapter(ADAPTER adapter)
```
    This method is called from getWidgetAdapter() to initialize the UiWidgetAdapter. All attributes of this widget need to be set in the UiWidgetAdapter.
    
    Parameters:
    
    adapter - is the UiWidgetAdapter to initialize.
  - createWidgetAdapter
```
protected abstract ADAPTER createWidgetAdapter()
```
    This method creates the widget adapter.
    This design is done to give more flexibility by overriding and also for lazy initialization of the widget.
    
    Returns:
    
    a new instance of the underlying widget.
  - setId
```
public void setId(String newId)
```
    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:
    
    newId - 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
  - setIdPrefix
```
public static void setIdPrefix(String idPrefix)
```
    This method sets the static prefix used for generated IDs.
    
    Parameters:
    
    idPrefix - is the idPrefix to set
  - createUniqueId
```
protected String createUniqueId()
```
    Returns:
    
    a new unique value for getId().
  - setFocused
```
public boolean setFocused()
```
    This method sets the focus to this object.
    NOTE:
    You can only set the focus. To actually remove it, you need to set it in a different widget. Further, as an API user you can normally ignore the result. This is only relevant for composite widgets such as panels, that delegate the call recursively and may not contain any child that can take the focus.
    
    Specified by:
    
    setFocused in interface AttributeWriteOnlyFocused
    
    Returns:
    
    true if the focus has been set successfully, false otherwise.
  - 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).
  - setParent
```
protected void setParent(UiWidgetComposite<?> parent)
```
    This method sets the parent.
    
    Specified by:
    
    setParent in class AbstractUiWidget<VALUE>
    
    Parameters:
    
    parent - is the new parent.
  - removeFromParent
```
protected void removeFromParent()
```
    This method removes this widget from its parent. The parent is set to null and the native widget is removed from its parent.
    
    Specified by:
    
    removeFromParent in class AbstractUiWidget<VALUE>
  - addChangeHandler
```
public void addChangeHandler(UiHandlerEventValueChange<VALUE> handler)
```
    This method adds the given UiHandlerEventValueChange to this object.
    
    Specified by:
    
    addChangeHandler in interface UiFeatureValue<VALUE>
    
    Overrides:
    
    addChangeHandler in class AbstractUiWidget<VALUE>
    
    Parameters:
    
    handler - is the UiHandlerEventValueChange to add.
  - removeChangeHandler
```
public boolean removeChangeHandler(UiHandlerEventValueChange<VALUE> handler)
```
    This method removes the given UiHandlerEventValueChange from this object.
    
    Specified by:
    
    removeChangeHandler in interface UiFeatureValue<VALUE>
    
    Overrides:
    
    removeChangeHandler in class AbstractUiWidget<VALUE>
    
    Parameters:
    
    handler - is the UiHandlerEventValueChange to remove.
    
    Returns:
    
    true if the handler has been removed successfully, false if it was NOT registered and nothing has changed.
  - getMode
```
public final UiMode getMode()
```
    This method gets the current UiMode of this object.
    
    Specified by:
    
    getMode in interface AttributeReadMode
    
    Returns:
    
    the UiMode.
  - setMode
```
public final 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
    
    Overrides:
    
    setMode in class AbstractUiWidget<VALUE>
    
    Parameters:
    
    mode - is the new UiMode to set.
  - setMode
```
protected void setMode(UiMode newMode,
                       boolean programmatic)
```
    Specified by:
    
    setMode in class AbstractUiWidget<VALUE>
    
    Parameters:
    
    newMode - is the new UiMode to set.
    
    programmatic - - see UiEvent.isProgrammatic().
    
    See Also:
    
    AbstractUiWidget.setMode(UiMode)
  - doSetMode
```
protected void doSetMode(UiMode uiMode)
```
    This method is called from setMode(UiMode) if the UiMode actually changed.
    
    Parameters:
    
    uiMode - is the new UiMode.
  - setModeRecursive
```
void setModeRecursive(UiMode newMode,
                      boolean programmatic)
```
    This method is called from setMode(UiMode) to recursively change the UiMode.
    
    Parameters:
    
    newMode - is the new UiMode.
    
    programmatic - - see UiEvent.isProgrammatic().
  - 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.
  - setModeFixed
```
public void setModeFixed(UiMode modeFixed)
```
    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:
    
    modeFixed - is the new fixed UiMode to set. May be null to unset fixation.
  - 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()
  - 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
  - setVisible
```
public final void setVisible(boolean visible)
```
    This method shows or hides this object.
    ATTENTION:
    This method is NOT symmetric to AttributeWriteVisibleAdvanced.isVisible(). It is an efficient shortcut for AttributeWriteVisibleAdvanced.getVisibleFlag().setFlag(visible, null).
    
    Specified by:
    
    setVisible in interface AttributeWriteVisible
    
    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).
    
    See Also:
    
    AttributeWriteVisibleAdvanced.isVisible()
  - setVisible
```
public void setVisible(boolean visibility,
                       boolean programmatic)
```
    Description copied from interface: AttributeWriteVisibleAdvanced
    
    This method shows or hides this object.
    
    Specified by:
    
    setVisible in interface AttributeWriteVisibleAdvanced
    
    Parameters:
    
    visibility - - see setVisible(boolean).
    
    programmatic - - see UiEvent.isProgrammatic().
    
    See Also:
    
    setVisible(boolean)
  - visibilityChanged
```
protected void visibilityChanged(boolean visibility,
                                 boolean programmatic)
```
    Called from setVisible(boolean) is the visibility has actually changed.
    
    Parameters:
    
    visibility - is the new visibility.
    
    programmatic - - see UiEvent.isProgrammatic().
  - isVisible
```
public boolean isVisible()
```
    This method determines if this object is set to visible.
    ATTENTION:
    This method is an efficient shortcut for AttributeWriteVisibleAdvanced.getVisibleFlag().getFlag(). If you want to read the value that has been set via AttributeWriteVisibleAdvanced.setVisible(boolean) you would need to do AttributeWriteVisibleAdvanced.getVisibleFlag().getFlag(null) instead. See AttributeWriteVisibleAdvanced.getVisibleFlag() for more information.
    
    Specified by:
    
    isVisible in interface AttributeReadVisible
    
    Specified by:
    
    isVisible in interface AttributeWriteVisibleAdvanced
    
    Returns:
    
    true if programmatically set visible, false if directly programmatically hidden.
    
    See Also:
    
    AttributeReadVisibleRecursive.isVisibleRecursive()
  - 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.
  - isVisibleRecursive
```
public final 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.
  - 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.
  - 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.
  - 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.
  - getSize
```
public Size getSize()
```
    Specified by:
    
    getSize in interface UiWidget
    
    Returns:
    
    the Size aspect to read and write the size of this widget.
  - createSize
```
protected AbstractUiWidgetNative.SizeImpl createSize()
```
    Returns:
    
    the Size instance lazily created by getSize().
  - 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
  - getAriaRoleFixedType
```
protected Class<? extends Role> getAriaRoleFixedType()
```
    Returns:
    
    the Class reflecting the Role that is fixed for this widget or null if the role can be changed dynamically.
  - setAriaRole
```
public <ROLE extends Role> ROLE setAriaRole(Class<ROLE> roleType)
```
    This method sets the ARIA role of this object.
    NOTE:
    If you are using the UI-Toolkit (UiWidget) the roles are automatically set for according widgets. There is no need to e.g. manually set RoleCombobox to a UiWidgetComboBox. Therefore, you only need to set roles explicitly for specific custom features. ATTENTION:
    This method will fail if an abstract Role is given.
    
    Specified by:
    
    setAriaRole in interface AttributeWriteAriaRole
    
    Type Parameters:
    
    ROLE - is the generic type of the new Role.
    
    Parameters:
    
    roleType - is the interface of the new ARIA role. Must not be an abstract Role interface.
    
    Returns:
    
    the instance of the new Role that is connected to this object.
    
    See Also:
    
    AttributeReadAriaRole.getAriaRole(), Accessibility
  - 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.
  - 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.
  - 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.
  - 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()
  - hasStyle
```
public final 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.
  - getIndexOfStyle
```
private int getIndexOfStyle(String style)
```
    Parameters:
    
    style - is the style to check.
    
    Returns:
    
    the start-index of the given style in styles or -1 if NOT present.
    
    See Also:
    
    hasStyle(String)
  - getIndexOfStyle
```
public static int getIndexOfStyle(String allStyles,
                                  String style)
```
    Parameters:
    
    allStyles - is the String with all current styles separated with whitespaces.
    
    style - is the single style to check.
    
    Returns:
    
    the start-index of the given style in allStyles or -1 if NOT present.
    
    See Also:
    
    getIndexOfStyle(String)
  - addStyle
```
public final 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 final 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).
  - isModifiedRecursive
```
protected boolean isModifiedRecursive()
```
    Overrides:
    
    isModifiedRecursive in class AbstractUiWidget<VALUE>
    
    Returns:
    
    true if a child or descendant of this object is modified, false otherwise.
  - clearMessages
```
public final 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
    
    Overrides:
    
    clearMessages in class AbstractUiWidget<VALUE>
  - clearValidity
```
protected final void clearValidity()
```
    This method may clear potential state information from previous validations. It clears the validity recursively.
    
    Overrides:
    
    clearValidity in class AbstractUiWidget<VALUE>
  - doValidate
```
protected void doValidate(ValidationState state,
                          VALUE value)
```
    This method is called from AbstractUiFeatureValueAndValidation.validate(ValidationState) and performs the actual validation of this object. This method performs the recursive validation of potential children of this widget excluding the validation of this widget itself. A legal implementation of a composite widget needs to call AbstractUiFeatureValueAndValidation.validate(ValidationState) on all child widgets.
    It performs the validation of this widget by delegating to validateRecursive(ValidationState). It may be overridden to collect potential validation failures and attach them to this widget. You should not forget the super-call in such case.
    
    Overrides:
    
    doValidate in class AbstractUiWidget<VALUE>
    
    Parameters:
    
    state - is the ValidationState. Never null.
    
    value - is the current value of this object that has already be determined.
  - validateRecursive
```
void validateRecursive(ValidationState state)
```
    This method performs the recursive validation of potential children of this widget excluding the validation of this widget itself. A legal implementation of a composite widget needs to call AbstractUiFeatureValueAndValidation.validate(ValidationState) on all child widgets.
    
    Parameters:
    
    state - is the ValidationState.
  - getChild
```
public UiWidget getChild(int index)
                  throws IndexOutOfBoundsException
```
    This method gets the child at the given index.
    
    Specified by:
    
    getChild in interface UiWidgetAbstractComposite
    
    Parameters:
    
    index - is the index of the requested child. Has to be in the range from 0 to UiWidgetAbstractComposite.getChildCount() - 1.
    
    Returns:
    
    the requested child.
    
    Throws:
    
    IndexOutOfBoundsException - if the given index is out of bounds.
    
    See Also:
    
    List.get(int)
  - getChildIndex
```
public int getChildIndex(UiWidget child)
```
    This method determines the index of the given child in the list of children of this composite.
    The signature is by intention not using the generic to support delegation without suffering by the java compiler.
    
    Specified by:
    
    getChildIndex in interface UiWidgetAbstractComposite
    
    Parameters:
    
    child - is the potential child.
    
    Returns:
    
    the index of the given child or -1 if it is NOT a child of this composite.
    
    See Also:
    
    List.indexOf(Object)
  - getChildCount
```
public int getChildCount()
```
    This method gets the number of children in this composite.
    
    Specified by:
    
    getChildCount in interface UiWidgetAbstractComposite
    
    Returns:
    
    the child count.
  - getChild
```
public UiWidget getChild(String childId)
```
    This method gets the child with the given id.
    
    Specified by:
    
    getChild in interface UiWidgetAbstractComposite
    
    Parameters:
    
    childId - is the ID of the requested child.
    
    Returns:
    
    the child with the given id or null if no such child exists.
  - doSetValue
```
protected void doSetValue(VALUE value,
                          boolean forUser)
```
    This method is called from the data-binding triggered by API methods such as AbstractUiWidget.setValue(Object, boolean). In many cases the data-binding already performs the required work to do. However, here is the place to implemented the custom logic to get the value from the actual widget. For details see AbstractUiWidget.doGetValue(Object, ValidationState).
    
    Overrides:
    
    doSetValue in class AbstractUiWidget<VALUE>
    
    Parameters:
    
    value - is the value to set. Typically a composite object (e.g. java bean) so its attributes are set to fields (see UiWidgetField).
    
    forUser - true if called from AbstractUiFeatureValueAndValidation.setValueForUser(Object), false if set from AbstractUiFeatureValueAndValidation.setValue(Object).
    
    See Also:
    
    AbstractUiWidget.doGetValue(Object, ValidationState)
  - doGetValue
```
protected VALUE doGetValue(VALUE template,
                           ValidationState state)
                    throws RuntimeException
```
    This method is called from the data-binding triggered by API methods such as AbstractUiFeatureValueAndValidation.getValue(). In many cases the data-binding already performs the required work to do. However, here is the place to implemented the custom logic to get the value from the actual widget. The following cases have to be distinguished:
    - For native fields this method has to get the actual value from the underlying native widget (text-box, password-field, etc.).
    - For custom fields this method will be responsible to convert from the delegates value (see UiWidgetCustom.getDelegate()) to the proper value type. E.g. if you want to create a custom widget to edit your own datatype such as CustomerNumber based on a UiWidgetTextField you need to convert from String to CustomerNumber.
    - For custom composite widgets you should use AbstractUiWidget.getDataBinding(). UiDataBinding.createAndBind(net.sf.mmm.util.pojo.path.api.TypedProperty) that gives you high-level support and makes your live easy. Then there is no need to override this method.
    - For other cases, especially if <VALUE> is Void, there is nothing to do here.
    The implementation of this method has to correspond with the implementation of AbstractUiWidget.doSetValue(Object, boolean) .
    Overrides:
    
    doGetValue in class AbstractUiWidget<VALUE>
    
    Parameters:
    
    template - is the object where the data is filled in. May only be null if according to data-binding (e.g. if <VALUE> is an (immutable) Datatype).
    
    state - is the ValidationState. May be null (if the validation is omitted). Should only be used to propagate to AbstractUiWidget.getValueDirect(Object, ValidationState) of children.
    
    Returns:
    
    the current value of this widget. May be null if empty. If <VALUE> is String the empty String has to be returned if no value has been entered. In case <VALUE> is a mutable object (java bean) the template is NOT null and is to be returned by this method after the value(s) of this widget have been assigned. For immutable datatypes template will be null and this method has to create a new instance of <VALUE> based on the end-users input in the widget.
    
    Throws:
    
    RuntimeException
    
    See Also:
    
    AbstractUiWidget.doSetValue(Object, boolean)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractUiWidget<VALUE>

Class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapter,VALUE>

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureEvent

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

Methods inherited from interface net.sf.mmm.util.validation.api.AbstractValidatableObject

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

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

Field Detail

LENGTH_PROPERTIES

idPrefix

idCounter

widgetAdapter

parent

id

visible

visibleFlag

enabled

disposed

tooltip

styles

size

ariaRole

mode

modeFixed

Constructor Detail

AbstractUiWidgetNative

Method Detail

hasWidgetAdapter

getWidgetAdapter

getWidgetAdapter

initializeWidgetAdapter

createWidgetAdapter

setId

getId

setIdPrefix

createUniqueId

setFocused

getParent

setParent

removeFromParent

addChangeHandler

removeChangeHandler

getMode

setMode

setMode

doSetMode

setModeRecursive

getModeFixed

setModeFixed

isDisposed

dispose

setVisible

setVisible

visibilityChanged

isVisible

getVisibleFlag

isVisibleRecursive

setTooltip

getTooltip

setEnabled

isEnabled

getSize

createSize

getAriaRole

getAriaRoleFixedType

setAriaRole

getStyles

setStyles