net.sf.mmm.client.ui.base.widget

Class AbstractUiWidgetActive<ADAPTER extends UiWidgetAdapterActive,VALUE>

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>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetActive<ADAPTER,VALUE>

Type Parameters:

ADAPTER - is the generic type of AbstractUiWidgetNative.getWidgetAdapter().

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractUiWidgetAbstractDataSet, AbstractUiWidgetClickable, AbstractUiWidgetField

public abstract class AbstractUiWidgetActive<ADAPTER extends UiWidgetAdapterActive,VALUE>
extends AbstractUiWidgetNative<ADAPTER,VALUE>
implements UiWidgetActive

This is the abstract base implementation of a focusable UiWidget.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

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

AbstractUiWidgetNative.SizeImpl

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 char	accessKey

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.client.ui.api.attribute.AttributeReadAccessKey

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

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

WAI_ARIA

Constructor Summary

Constructors

Constructor and Description
AbstractUiWidgetActive(UiContext context, ADAPTER widgetAdapter) The constructor.

Method Summary

Modifier and Type	Method and Description
void	addFocusHandler(UiHandlerEventFocus handler) This method adds the given UiHandlerEventFocus to this object.
char	getAccessKey() This method gets the access key of this object.
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
boolean	isFocused() This method determines if this object currently has the focus.
void	onAccessKeyPressed(boolean programmatic)
boolean	removeFocusHandler(UiHandlerEventFocus handler) This method removes the given UiHandlerEventFocus from this object.
void	setAccessKey(char accessKey) This method sets the accessKey attribute of this object.
boolean	setFocused() This method sets the focus to this object.
protected void	setFocused(boolean programmatic)

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

addChangeHandler, addStyle, clearMessages, clearValidity, createSize, createUniqueId, createWidgetAdapter, dispose, doGetValue, doSetMode, doSetValue, doValidate, getAriaRole, getAriaRoleFixedType, getChild, getChild, getChildCount, getChildIndex, getId, getIndexOfStyle, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getStyles, getTooltip, getVisibleFlag, getWidgetAdapter, getWidgetAdapter, hasStyle, hasWidgetAdapter, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeChangeHandler, removeFromParent, removeStyle, setAriaRole, setEnabled, setId, setIdPrefix, setMode, setMode, setModeFixed, setModeRecursive, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, setVisible, toString, validateRecursive, visibilityChanged

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, getParent, getSize

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

clearMessages

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.AttributeWriteMode

setMode

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

getMode

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

setModeFixed

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

getModeFixed

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.AttributeWriteVisibleAdvanced

getVisibleFlag, isVisible, setVisible, setVisible

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

isVisibleRecursive

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

setEnabled

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.AttributeReadModified

isModified

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

getAriaRole

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

accessKey

private char accessKey

See Also:

getAccessKey()

Constructor Detail

AbstractUiWidgetActive

public AbstractUiWidgetActive(UiContext context,
                              ADAPTER widgetAdapter)

The constructor.

Parameters:

context - is the context.

widgetAdapter - is the widget adapter. Typically null for lazy initialization.

Method Detail

initializeWidgetAdapter

protected void initializeWidgetAdapter(ADAPTER adapter)

This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter. All attributes of this widget need to be set in the UiWidgetAdapter.

Overrides:

initializeWidgetAdapter in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterActive,VALUE>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

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

Overrides:

setFocused in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterActive,VALUE>

Returns:

true if the focus has been set successfully, false otherwise.

setFocused

protected void setFocused(boolean programmatic)

Parameters:

programmatic - - see UiEvent.isProgrammatic().

See Also:

setFocused()

isFocused

public boolean isFocused()

This method determines if this object currently has the focus. In this case the cursor is placed in the object (e.g. a text input) and it will receive keyboard events.

Specified by:

isFocused in interface AttributeReadFocused

Returns:

true if this object is focused, false otherwise.

addFocusHandler

public void addFocusHandler(UiHandlerEventFocus handler)

This method adds the given UiHandlerEventFocus to this object.

Specified by:

addFocusHandler in interface UiFeatureFocus

Parameters:

handler - is the UiHandlerEventFocus to add.

removeFocusHandler

public boolean removeFocusHandler(UiHandlerEventFocus handler)

This method removes the given UiHandlerEventFocus from this object.

Specified by:

removeFocusHandler in interface UiFeatureFocus

Parameters:

handler - is the UiHandlerEventFocus to remove.

Returns:

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

getAccessKey

public char getAccessKey()

This method gets the access key of this object. If the access key is pressed together with the [shift] and [alt] keys this object will be invoked. Here invoked means the same as if the end-user would click on the object. In case of an action item (button, link, etc.) it is invoked, otherwise it will get the focus.

Specified by:

getAccessKey in interface AttributeReadAccessKey

Returns:

the access key. Will be AttributeReadAccessKey.ACCESS_KEY_NONE if no access key is defined.

setAccessKey

public void setAccessKey(char accessKey)

This method sets the accessKey attribute of this object.

Specified by:

setAccessKey in interface AttributeWriteAccessKey

Parameters:

accessKey - is the new value of AttributeReadAccessKey.getAccessKey(). Use AttributeReadAccessKey.ACCESS_KEY_NONE to unset.

onAccessKeyPressed

public void onAccessKeyPressed(boolean programmatic)

Parameters:

programmatic - - true if the access key was "pressed" by the program, false if performed by the end-user.