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

Class AbstractUiWidgetClickable<ADAPTER extends UiWidgetAdapterClickable,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>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetClickable<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, AttributeReadImage<UiWidgetImage>, AttributeReadLabel, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadValueAdvanced<VALUE>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAccessKey, AttributeWriteAriaRole, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteImage<UiWidgetImage>, AttributeWriteLabel, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteValueAdvanced<VALUE>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureClick, UiFeatureEvent, UiFeatureFocus, UiFeatureMessages, UiFeatureMode, UiFeatureValidation<VALUE>, UiFeatureValue<VALUE>, UiFeatureValueAndValidation<VALUE>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<VALUE>, UiWidgetActive, UiWidgetClickable, AttributeReadDisposed, AttributeReadId<String>, AttributeReadValue<VALUE>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteValue<VALUE>, Accessibility, AbstractValidatableObject, HasValueValidators<VALUE>, ValidatableObject<VALUE>

Direct Known Subclasses:

AbstractUiWidgetAbstractButton, AbstractUiWidgetCollapsableSection, AbstractUiWidgetLink, AbstractUiWidgetMenuItemClickable

public abstract class AbstractUiWidgetClickable<ADAPTER extends UiWidgetAdapterClickable,VALUE>
extends AbstractUiWidgetActive<ADAPTER,VALUE>
implements UiWidgetClickable

This is the abstract base implementation of a clickable 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 UiWidgetImage	image
private String	label

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

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

PROPERTY_LABEL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addClickHandler(UiHandlerEventClick handler) This method adds the given UiHandlerEventClick to this object.
void	click() This method programmatically notifies all registered listeners.
protected void	click(boolean programmatic)
UiWidgetImage	getImage() This method gets the image of this object.
String	getLabel() This method gets the label of this object.
String	getSource()
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
void	onAccessKeyPressed(boolean programmatic)
boolean	removeClickHandler(UiHandlerEventClick handler) This method removes the given UiHandlerEventClick from this object.
void	setImage(UiWidgetImage image) This method sets the image of this object.
void	setLabel(String label) This method sets the label of this object.
String	toString()

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

addFocusHandler, getAccessKey, isFocused, removeFocusHandler, setAccessKey, setFocused, setFocused

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, 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, 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.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.feature.UiFeatureFocus

addFocusHandler, removeFocusHandler

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

resetValue, setValue, setValueForUser

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

getValue

Field Detail

label

private String label

See Also:

getLabel()

image

private UiWidgetImage image

See Also:

getImage()

Constructor Detail

AbstractUiWidgetClickable

public AbstractUiWidgetClickable(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 AbstractUiWidgetActive<ADAPTER extends UiWidgetAdapterClickable,VALUE>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

getImage

public UiWidgetImage getImage()

This method gets the image of this object. If the image is attached to an object with arbitrary other features and has a smaller size, it is typically called icon.

Specified by:

getImage in interface AttributeReadImage<UiWidgetImage>

Returns:

the image or null if no image is defined.

setImage

public void setImage(UiWidgetImage image)

This method sets the image of this object. A previously set image will be replaced.

Specified by:

setImage in interface AttributeWriteImage<UiWidgetImage>

Specified by:

setImage in interface UiWidgetClickable

Parameters:

image - is the new image or null to remove the image.

addClickHandler

public void addClickHandler(UiHandlerEventClick handler)

This method adds the given UiHandlerEventClick to this object.

Specified by:

addClickHandler in interface UiFeatureClick

Parameters:

handler - is the UiHandlerEventClick to add.

removeClickHandler

public boolean removeClickHandler(UiHandlerEventClick handler)

This method removes the given UiHandlerEventClick from this object.

Specified by:

removeClickHandler in interface UiFeatureClick

Parameters:

handler - is the UiHandlerEventClick to remove.

Returns:

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

click

public void click()

This method programmatically notifies all registered listeners.

Specified by:

click in interface UiFeatureClick

click

protected void click(boolean programmatic)

Parameters:

programmatic - - see AbstractUiEvent.isProgrammatic().

See Also:

click()

setLabel

public void setLabel(String label)

This method sets the label of this object.

Specified by:

setLabel in interface AttributeWriteLabel

Parameters:

label - is the new label to set.

getLabel

public String getLabel()

This method gets the label of this object. A label is some text that is permanently shown to the user in the UI in order to describe the meaning of the object and in particular its value. For elements that allow to display or edit a value the label is typically shown beside the edit/display widget. For action elements such as buttons or links the label is the actual text (lettering).

Specified by:

getLabel in interface AttributeReadLabel

Returns:

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

onAccessKeyPressed

public void onAccessKeyPressed(boolean programmatic)

Overrides:

onAccessKeyPressed in class AbstractUiWidgetActive<ADAPTER extends UiWidgetAdapterClickable,VALUE>

Parameters:

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

toString

public String toString()

Overrides:

toString in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterClickable,VALUE>

getSource

public String getSource()

Overrides:

getSource in class AbstractUiWidget<VALUE>

Returns:

a String representation of this object that qualifies as source description that might be displayed to end-users (unlike AbstractUiWidget.toString() what is for debugging only).