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

Class AbstractUiWidget<VALUE>

java.lang.Object

net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation<VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidget<VALUE>

Type Parameters:

VALUE - is the generic type of the value.

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>, AttributeReadDisposed, AttributeReadId<String>, AttributeReadValue<VALUE>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteValue<VALUE>, Accessibility, AbstractValidatableObject, HasValueValidators<VALUE>, ValidatableObject<VALUE>

Direct Known Subclasses:

AbstractUiWidgetNative, UiWidgetCustom

public abstract class AbstractUiWidget<VALUE>
extends AbstractUiFeatureValueAndValidation<VALUE>
implements UiWidgetAbstractWithValue<VALUE>, AttributeWriteModified, AttributeWriteOnlyFocused

This is the abstract base implementation of UiWidget. Below this class there are two inheritance hierarchies AbstractUiWidgetNative and UiWidgetCustom. To avoid problems with the lack of multi-inheritance in Java, we already implement UiWidgetWithValue. For subclasses that have no value Void is used for <VALUE>.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractUiWidget.AccessHelper This inner class gives access to methods not visible in the public API.
protected class	AbstractUiWidget.EventSender This inner class is an adapter for the events.
protected static class	AbstractUiWidget.HandlerContainer A simple adapter containing a UiHandlerEvent.

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractUiContext	context
private UiDataBinding<VALUE>	dataBinding
private AbstractUiWidget.EventSender	eventSender

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
AbstractUiWidget(UiContext context) The constructor.

Method Summary

Modifier and Type	Method and Description
void	addChangeHandler(UiHandlerEventValueChange<VALUE> handler) This method adds the given UiHandlerEventValueChange to this object.
void	addEventHandler(UiHandlerEvent handler) This method adds the given UiHandlerEvent to this object.
void	addValidator(ValueValidator<? super VALUE> validator) This method adds the given ValueValidator to this object.
void	clearMessages() This method is clearing all messages.
protected void	clearMessagesLocal() This method clears the messages locally (the non-recursive part of clearMessages()).
protected void	clearValidationFailure() This method clears the messages locally (the non-recursive part of clearMessages()).
protected void	clearValidity() This method may clear potential state information from previous validations.
protected String	convertValueToString(VALUE value) Converts the given value to String.
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	doSetValue(VALUE value, boolean forUser) This method is called from the data-binding triggered by API methods such as 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.
protected void	fireEvent(UiEvent event) Fires an event with the given parameters.
protected void	fireValueChange(boolean programmatic) Called if the value has changed internally.
protected BasicUtil	getBasicUtil()
AbstractUiContext	getContext() This method gets the UiContext.
protected UiDataBinding<VALUE>	getDataBinding()
protected UiDataBinding<VALUE>	getDataBinding(VALUE example)
protected static <VALUE> UiDataBinding<VALUE>	getDataBindingForWidget(UiWidgetWithValue<VALUE> widget, VALUE value) Makes getDataBinding() accessible.
protected AbstractUiWidget.EventSender	getEventSender() This method gets the AbstractUiWidget.EventSender.
UiWidgetFactory	getFactory()
protected org.slf4j.Logger	getLogger()
protected AttributeReadEventObserver	getObserverSource()
VALUE	getOriginalValue() This method gets the last value that has been set.
protected VALUE	getRecentValue()
String	getSource()
protected Class<VALUE>	getValueClass()
VALUE	getValueDirect(VALUE template, ValidationState state) This method is a combination of AttributeReadValueAdvanced.getValueOrException(Object) and AbstractValidatableObject.validate(ValidationState).
VALUE	getValueOrException(VALUE template) This method is like AttributeReadValueAdvanced.getValue() but does NOT catch exceptions while parsing the value from the user input.
protected abstract UiWidgetAdapter	getWidgetAdapter() This method gets or creates the UiWidgetAdapter.
static UiWidgetAdapter	getWidgetAdapter(UiWidget widget) This method gives access to getWidgetAdapter().
protected boolean	hasEventSender()
abstract boolean	hasWidgetAdapter()
boolean	isMandatory() This method determines if ValidatorMandatory (or a sub-class) has been added to this object.
boolean	isModified() This method determines if this object (or more precisely its value) is modified.
protected boolean	isModifiedRecursive()
boolean	removeChangeHandler(UiHandlerEventValueChange<VALUE> handler) This method removes the given UiHandlerEventValueChange from this object.
boolean	removeEventHandler(UiHandlerEvent handler) This method removes the given UiHandlerEvent from this object.
protected abstract void	removeFromParent() This method removes this widget from its parent.
static void	removeFromParent(UiWidget widget) This method invokes removeFromParent() on the given widget.
boolean	removeValidator(ValueValidator<? super VALUE> validator) This method removes the given ValueValidator from this object.
protected void	setMandatory(boolean mandatory) This method is called whenever the isMandatory() flag is updated.
void	setMode(UiMode mode) This method sets the mode of this object.
protected abstract void	setMode(UiMode mode, boolean programmatic)
void	setModified(boolean modified) This method sets the modified attribute programatically.
protected abstract void	setParent(UiWidgetComposite<?> parent) This method sets the parent.
static void	setParent(UiWidget widget, UiWidgetComposite<?> newParent) This method sets the parent of the given widget.
void	setValue(VALUE newValue, boolean forUser) This is the generic variant of AttributeWriteValueAdvanced.setValue(Object) and AttributeWriteValueAdvanced.setValueForUser(Object).
String	toString()
private void	validateInteral(ValidationState state, VALUE value) This method is called from AbstractUiFeatureValueAndValidation.validate(ValidationState) and performs the actual validation of this object.

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

getParent, getSize

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

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

setFocused

Field Detail

context

private final AbstractUiContext context

See Also:

getContext()

eventSender

private AbstractUiWidget.EventSender eventSender

See Also:

fireEvent(UiEvent)

dataBinding

private UiDataBinding<VALUE> dataBinding

See Also:

getDataBinding()

Constructor Detail

AbstractUiWidget

public AbstractUiWidget(UiContext context)

The constructor.

Parameters:

context - is the context.

Method Detail

getLogger

protected org.slf4j.Logger getLogger()

Specified by:

getLogger in class AbstractUiFeatureValueAndValidation<VALUE>

Returns:

a Logger instance.

getBasicUtil

protected final BasicUtil getBasicUtil()

Returns:

the instance of BasicUtil.

getDataBindingForWidget

protected static <VALUE> UiDataBinding<VALUE> getDataBindingForWidget(UiWidgetWithValue<VALUE> widget,
                                                                      VALUE value)

Makes getDataBinding() accessible.

Type Parameters:

VALUE - is the generic type of the value.

Parameters:

widget - is the UiWidgetWithValue.

value - is the value, may be null.

Returns:

the data binding of the given widget.

getDataBinding

protected UiDataBinding<VALUE> getDataBinding()

Returns:

the UiDataBinding for this widget.

getDataBinding

protected UiDataBinding<VALUE> getDataBinding(VALUE example)

Parameters:

example - is an example value that may be used to determine the value class if not available. May be null.

Returns:

the data binding.

See Also:

getDataBinding()

getValueClass

protected Class<VALUE> getValueClass()

Returns:

the Class reflecting <VALUE>. May also be null for Void.

getValueOrException

public final VALUE getValueOrException(VALUE template)
                                throws RuntimeException

This method is like AttributeReadValueAdvanced.getValue() but does NOT catch exceptions while parsing the value from the user input. Additionally it allows to provide a template object that gets populated. This allows advanced features with polymorphism as you can also provide a sub-class of <VALUE>.

Specified by:

getValueOrException in interface AttributeReadValueAdvanced<VALUE>

Overrides:

getValueOrException in class AbstractUiFeatureValueAndValidation<VALUE>

Parameters:

template - is the object where the data is filled in. May also be null - then this method will create a new instance.

Returns:

the current value of this widget. May be null if empty. If the value type is String the empty String has to be returned if no value has been entered. In case <VALUE> is a mutable object (java bean) and template is NOT null, this method is supposed to return template.

Throws:

RuntimeException - if the entered value is invalid (e.g. paring caused a NumberFormatException).

getOriginalValue

public VALUE getOriginalValue()

This method gets the last value that has been set. After calling AttributeWriteValueAdvanced.setValue(Object) the value can be modified (by the user in case of a widget). Then calls to AttributeReadValueAdvanced.getValue() will return the current value with its potential modifications (as a new object). This method will ensure to get the value that was set before by the program.
ATTENTION:
The original value shall never be modified to avoid undesired side effects. Various features such as AttributeWriteValueAdvanced.resetValue() rely on this fact. Therefore AttributeReadValueAdvanced.getValue() will always return a new instance.

Specified by:

getOriginalValue in interface AttributeReadValueAdvanced<VALUE>

Returns:

the original value.

getRecentValue

protected VALUE getRecentValue()

Returns:

the recent value.

getValueDirect

public VALUE getValueDirect(VALUE template,
                            ValidationState state)
                     throws RuntimeException

This method is a combination of AttributeReadValueAdvanced.getValueOrException(Object) and AbstractValidatableObject.validate(ValidationState). It allows more efficient implementations as determining and creating the value can be expensive. Saving changes requires validation AND on success getting the value, while already validation requires getting the value. For composite UI objects this effect would reinforce to multiply the number of calls to AttributeReadValueAdvanced.getValueOrException(Object).
NOTE:
This method is designed for implementors of composite UI objects. API users should only use UiFeatureValueAndValidation.getValueAndValidate(ValidationState).

Specified by:

getValueDirect in interface UiFeatureValueAndValidation<VALUE>

Parameters:

template - is the object where the data is filled in. May also be null - then this method will create a new instance.

state - is the ValidationState. If null the validation will be omitted, otherwise an implicit validation is performed.

Returns:

the current value. May be null (esp. if invalid).

Throws:

RuntimeException - if state is null no validation is performed and input errors are directly thrown causing a fast fail. Otherwise if validation is performed all RuntimeException are catched and according validation failures are collected and visualized by the UI.

doGetValue

protected VALUE doGetValue(VALUE template,
                           ValidationState state)

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 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 doSetValue(Object, boolean) .

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

See Also:

doSetValue(Object, boolean)

doSetValue

protected void doSetValue(VALUE value,
                          boolean forUser)

This method is called from the data-binding triggered by API methods such as 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 doGetValue(Object, ValidationState).

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:

doGetValue(Object, ValidationState)

setValue

public void setValue(VALUE newValue,
                     boolean forUser)

This is the generic variant of AttributeWriteValueAdvanced.setValue(Object) and AttributeWriteValueAdvanced.setValueForUser(Object).
NOTE:
To make your code expressive please only use this method for generic situations where forUser is dynamic.

Specified by:

setValue in interface AttributeWriteValueAdvanced<VALUE>

Parameters:

newValue - is the new value to set.

forUser - true for the semantics of AttributeWriteValueAdvanced.setValueForUser(Object), false for AttributeWriteValueAdvanced.setValue(Object).

convertValueToString

protected String convertValueToString(VALUE value)

Converts the given value to String.

Parameters:

value - is the value to convert.

Returns:

the String representation to display the given value.

removeValidator

public boolean removeValidator(ValueValidator<? super VALUE> validator)

This method removes the given ValueValidator from this object.
ATTENTION:
Having dynamic validators is an exotic case that should be avoided. This feature is provided but not recommended.

Specified by:

removeValidator in interface HasValueValidators<VALUE>

Parameters:

validator - is the ValueValidator to remove.

Returns:

true if the ValueValidator has actually been removed, false otherwise (it has NOT previously been added).

isMandatory

public boolean isMandatory()

This method determines if ValidatorMandatory (or a sub-class) has been added to this object.

Specified by:

isMandatory in interface UiFeatureValidation<VALUE>

Returns:

true if this the value of this object is mandatory.

setMandatory

protected void setMandatory(boolean mandatory)

This method is called whenever the isMandatory() flag is updated. You may override it to update the UI to reflect this change.

Parameters:

mandatory - is the new value of isMandatory().

isModified

public boolean isModified()

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

Specified by:

isModified in interface AttributeReadModified

Returns:

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

See Also:

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

isModifiedRecursive

protected boolean isModifiedRecursive()

Returns:

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

setModified

public void setModified(boolean modified)

This method sets the modified attribute programatically.
ATTENTION:
This interface and this method is NOT intended to be used by API users. The strategy how to determine if something is modified should be an implementation secret (another strategy may be to get the value and check if it is equal to the original value what is however not as robust). Instead methods such as AttributeWriteValueAdvanced.setValueForUser(Object) should be provided for API users.

Specified by:

setModified in interface AttributeWriteModified

Parameters:

modified - is the new value of AttributeReadModified.isModified().

See Also:

AttributeReadModified.isModified()

setMode

public void setMode(UiMode mode)

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

Specified by:

setMode in interface AttributeWriteMode

Parameters:

mode - is the new UiMode to set.

setMode

protected abstract void setMode(UiMode mode,
                                boolean programmatic)

Parameters:

mode - is the new UiMode to set.

programmatic - - see UiEvent.isProgrammatic().

See Also:

setMode(UiMode)

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

clearMessagesLocal

protected void clearMessagesLocal()

This method clears the messages locally (the non-recursive part of clearMessages()).

clearValidationFailure

protected void clearValidationFailure()

This method clears the messages locally (the non-recursive part of clearMessages()).

clearValidity

protected void clearValidity()

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

Overrides:

clearValidity in class AbstractUiFeatureValueAndValidation<VALUE>

validateInteral

private void validateInteral(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.

Parameters:

state - is the ValidationState. Never null.

value - is the current value of this object that has already be determined.

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.

Parameters:

state - is the ValidationState. Never null.

value - is the current value of this object that has already be determined.

addValidator

public final void addValidator(ValueValidator<? super VALUE> validator)

This method adds the given ValueValidator to this object. All ValueValidators are invoked in the same order as they are added by this method. They are invoked no matter if the previous ValueValidators failed or succeeded. You should always design ValueValidators in a robust and reusable way (e.g. a range validator should accept null as valid input so it can be used for both mandatory and optional fields).

Specified by:

addValidator in interface HasValueValidators<VALUE>

Parameters:

validator - is the ValueValidator to add.

getContext

public final AbstractUiContext getContext()

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

Specified by:

getContext in interface UiWidget

Returns:

the UiContext.

getObserverSource

protected final AttributeReadEventObserver getObserverSource()

Returns:

die Instanz von AttributeReadEventObserver oder null falls nicht verfügbar.

getFactory

public final UiWidgetFactory getFactory()

Returns:

the UiWidgetFactory via getContext() for convenience.

hasWidgetAdapter

public abstract boolean hasWidgetAdapter()

Returns:

true if the UiWidgetAdapter has already been created. Otherwise false (if getWidgetAdapter() has never been called yet).

getWidgetAdapter

protected abstract 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 hasWidgetAdapter() to prevent unnecessary creation.

Returns:

the UiWidgetAdapter.

getWidgetAdapter

public static final UiWidgetAdapter getWidgetAdapter(UiWidget 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).

Parameters:

widget - is the widget.

Returns:

the widget adapter of the given widget.

removeFromParent

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

removeFromParent

public static void removeFromParent(UiWidget widget)

This method invokes removeFromParent() on the given widget.
ATTENTION:
This method is only for internal purposes when implementing UiWidgets. It shall never be used by regular users.

Parameters:

widget - is the widget that should be removed from its parent.

setParent

protected abstract void setParent(UiWidgetComposite<?> parent)

This method sets the parent.

Parameters:

parent - is the new parent.

setParent

public static void setParent(UiWidget widget,
                             UiWidgetComposite<?> newParent)

This method sets the parent of the given widget.
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).

Parameters:

widget - is the widget where to set the parent.

newParent - is the new parent.

hasEventSender

protected final boolean hasEventSender()

Returns:

true if the AbstractUiWidget.EventSender has already been created. Otherwise false (if getEventSender() has never been called yet).

getEventSender

protected final AbstractUiWidget.EventSender getEventSender()

This method gets the AbstractUiWidget.EventSender. It will be created on the first call.

Returns:

the AbstractUiWidget.EventSender.

addEventHandler

public final void addEventHandler(UiHandlerEvent handler)

This method adds the given UiHandlerEvent to this object.

Specified by:

addEventHandler in interface UiFeatureEvent

Parameters:

handler - is the UiHandlerEvent to add.

removeEventHandler

public final boolean removeEventHandler(UiHandlerEvent handler)

This method removes the given UiHandlerEvent from this object.

Specified by:

removeEventHandler in interface UiFeatureEvent

Parameters:

handler - is the UiHandlerEvent to remove.

Returns:

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

addChangeHandler

public void addChangeHandler(UiHandlerEventValueChange<VALUE> handler)

This method adds the given UiHandlerEventValueChange to this object.

Specified by:

addChangeHandler in interface UiFeatureValue<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>

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.

fireEvent

protected final void fireEvent(UiEvent event)

Fires an event with the given parameters.

Parameters:

event - is the UiEvent.

fireValueChange

protected void fireValueChange(boolean programmatic)

Called if the value has changed internally. Implementation has to fire a value change event.

Parameters:

programmatic - - see UiEvent.isProgrammatic(), should typically be true here.

getSource

public String getSource()

Specified by:

getSource in class AbstractUiFeatureValueAndValidation<VALUE>

Returns:

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

toString

public String toString()

Overrides:

toString in class AbstractUiFeatureValueAndValidation<VALUE>