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

Class UiWidgetCustom<VALUE,DELEGATE extends UiWidget>

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.custom.UiWidgetCustom<VALUE,DELEGATE>

Type Parameters:

VALUE - is the generic type of the value.

DELEGATE - is the generic type of the delegate.

All Implemented Interfaces:

AttributeReadAriaRole, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadValueAdvanced<VALUE>, AttributeReadVisible, AttributeReadVisibleRecursive, 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, UiWidgetAbstractWithValue<VALUE>, UiWidgetRegular, UiWidgetWithValue<VALUE>, AttributeReadDisposed, AttributeReadId<String>, AttributeReadValue<VALUE>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteValue<VALUE>, Accessibility, AbstractValidatableObject, HasValueValidators<VALUE>, ValidatableObject<VALUE>

Direct Known Subclasses:

UiWidgetCustomAbstractListTable, UiWidgetCustomAtomicNoValue, UiWidgetCustomComposite, UiWidgetCustomField

public abstract class UiWidgetCustom<VALUE,DELEGATE extends UiWidget>
extends AbstractUiWidget<VALUE>
implements UiWidgetWithValue<VALUE>

This is the abstract base class for custom widgets. A custom widget is a widget implemented via delegation to another widget. It is therefore toolkit independent and can be implemented as a regular class. This makes the programming model of this UI-Toolkit easy to use.
Typical use-cases for custom widgets are field widgets for custom datatypes and composites for editors of particular business objects.

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

AbstractUiWidget.AccessHelper, AbstractUiWidget.EventSender, AbstractUiWidget.HandlerContainer

Field Summary

Fields

Modifier and Type	Field and Description
private DELEGATE	delegate
private boolean	initialized
private Class<VALUE>	valueClass

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
UiWidgetCustom(UiContext context, DELEGATE delegate, Class<VALUE> valueClass) The constructor.

Method Summary

Modifier and Type	Method and Description
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.
void	dispose() This method disposes this object.
protected void	doInitialize() This method is called from initialize() but only if called for the first time.
protected void	doSetMode(UiMode mode) This method actually changes the mode.
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 DELEGATE	getDelegate() This method gets the underlying widget that is adapted by this widget.
protected static <WIDGET extends UiWidget> WIDGET	getDelegate(UiWidgetCustom<?,WIDGET> customWidget) This method gets the delegate of the given widget.
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.
UiWidgetComposite<?>	getParent()
String	getPrimaryStyle() This method gets the primary style of this object.
Size	getSize()
String	getSource()
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.
Class<VALUE>	getValueClass()
AttributeWriteFlagAdvanced	getVisibleFlag() This method gets advanced visibility support.
protected UiWidgetAdapter	getWidgetAdapter() This method gets or creates the UiWidgetAdapter.
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	initialize() This method initializes this widget.
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.
protected void	removeFromParent() This method removes this widget from its parent.
boolean	removeStyle(String style) This method removes the given style from the styles.
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 id) This method set the ID of this object.
void	setMode(UiMode mode) This method sets the mode of this object.
protected void	setMode(UiMode mode, boolean programmatic)
void	setModeFixed(UiMode mode) This method sets the fixed mode of this object.
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 visible, boolean programmatic) This method shows or hides this object.

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

addChangeHandler, addEventHandler, addValidator, clearMessagesLocal, clearValidationFailure, convertValueToString, doGetValue, doSetValue, fireEvent, fireValueChange, getBasicUtil, getContext, getDataBinding, getDataBinding, getDataBindingForWidget, getEventSender, getFactory, getLogger, getObserverSource, getOriginalValue, getRecentValue, getValueDirect, getValueOrException, getWidgetAdapter, hasEventSender, isMandatory, isModified, removeChangeHandler, removeEventHandler, removeFromParent, removeValidator, setMandatory, setModified, setParent, setValue, toString

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

getValue

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

getValueAndValidate, getValueDirect

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

addChangeHandler, removeChangeHandler

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

resetValue, setValue, setValue, setValueForUser

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

getOriginalValue, getValueOrException

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

addValidatorMandatory, isMandatory

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

addValidator, removeValidator

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

validate

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

Field Detail

delegate

private final DELEGATE extends UiWidget delegate

See Also:

getDelegate()

valueClass

private final Class<VALUE> valueClass

See Also:

getValueClass()

initialized

private boolean initialized

See Also:

initialize()

Constructor Detail

UiWidgetCustom

public UiWidgetCustom(UiContext context,
                      DELEGATE delegate,
                      Class<VALUE> valueClass)

The constructor.

Parameters:

context - is the context.

delegate - is the delegate.

valueClass - is the value class.

Method Detail

getValueClass

public Class<VALUE> getValueClass()

Overrides:

getValueClass in class AbstractUiWidget<VALUE>

Returns:

the valueClass

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

Overrides:

clearMessages in class AbstractUiWidget<VALUE>

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.

clearValidity

protected void clearValidity()

This method may clear potential state information from previous validations. It clears the validity recursively.

Overrides:

clearValidity in class AbstractUiWidget<VALUE>

getDelegate

protected final DELEGATE getDelegate()

This method gets the underlying widget that is adapted by this widget.

Returns:

the adapted widget.

getDelegate

protected static final <WIDGET extends UiWidget> WIDGET getDelegate(UiWidgetCustom<?,WIDGET> customWidget)

This method gets the delegate of the given widget.

Type Parameters:

WIDGET - is the generic type for the delegate of the given widgets.

Parameters:

customWidget - is the widget for which the delegate is requested.

Returns:

the requested delegate.

isModifiedRecursive

protected boolean isModifiedRecursive()

Overrides:

isModifiedRecursive in class AbstractUiWidget<VALUE>

Returns:

true if a child or descendant of this object is modified, false otherwise.

getWidgetAdapter

protected UiWidgetAdapter 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.

hasWidgetAdapter

public 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).

getParent

public final 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).

dispose

public final 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 final 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()

isVisible

public final 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()

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 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()

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.

isEnabled

public final 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.

setEnabled

public final 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.

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 mode,
                       boolean programmatic)

Specified by:

setMode in class AbstractUiWidget<VALUE>

Parameters:

mode - is the new UiMode to set.

programmatic - - see UiEvent.isProgrammatic().

See Also:

AbstractUiWidget.setMode(UiMode)

doSetMode

protected void doSetMode(UiMode mode)

This method actually changes the mode.

Parameters:

mode - is the new UiMode to set.

getModeFixed

public final 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 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.

getTooltip

public final 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.

setTooltip

public final 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()

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

setPrimaryStyle

public final 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()

getStyles

public final 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 final 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 final 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.

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

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.

getId

public final 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

setId

public final 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.

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>

setParent

protected void setParent(UiWidgetComposite<?> parent)

This method sets the parent.

Specified by:

setParent in class AbstractUiWidget<VALUE>

Parameters:

parent - is the new parent.

initialize

protected final void initialize()

This method initializes this widget. It is automatically called from setParent(UiWidgetComposite) so initialization is performed before the widget is actually attached to the screen for the first time. The first call of this method delegates to doInitialize(). Further calls of this method will have no effect.
ATTENTION:
You should not call this method directly unless you are absolutely aware of what you are doing.

doInitialize

protected void doInitialize()

This method is called from initialize() but only if called for the first time. You may override this method to add additional initialization logic. Then do not forget the super call.
ATTENTION:
Never call this method directly.

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.

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.

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