net.sf.mmm.client.ui.impl.test.widget.adapter

Class UiWidgetAdapterTest

java.lang.Object

net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapter<Void>

net.sf.mmm.client.ui.impl.test.widget.adapter.UiWidgetAdapterTest

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAltText, AttributeReadAttribute, AttributeReadCollapsed, AttributeReadColumnSpan, AttributeReadEnabled, AttributeReadFocused, AttributeReadHeightInRows, AttributeReadHtmlId, AttributeReadImage<UiWidgetImage>, AttributeReadLabel, AttributeReadLengthProperty, AttributeReadMaximumTextLength, AttributeReadPrimaryStyle, AttributeReadResizable, AttributeReadSelectionMode, AttributeReadSizeInPixel, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadSummary, AttributeReadTitleVisible, AttributeReadTooltip, AttributeReadUrl, AttributeReadValidationFailure, AttributeWriteAccessKey, AttributeWriteAltText, AttributeWriteAttribute, AttributeWriteCollapsed, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteImage<UiWidgetImage>, AttributeWriteLabel, AttributeWriteLengthProperty, AttributeWriteMaximumTextLength, AttributeWriteOnlyAttribute, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteSelectionMode, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteSummary, AttributeWriteTitleVisible, AttributeWriteTooltip, AttributeWriteUrl, AttributeWriteValidationFailure, UiWidgetAdapter, UiWidgetAdapterActive, UiWidgetAdapterClickable, UiWidgetAdapterWithLabel, UiWidgetAdapterButton, UiWidgetAdapterCollapsableSection, UiWidgetAdapterImage, UiWidgetAdapterLabel, UiWidgetAdapterLink, UiWidgetAdapterSection, UiWidgetAdapterMenuItemClickable, UiWidgetAdapterMenuItemSeparator, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, Accessibility

Direct Known Subclasses:

UiWidgetAdapterTestComposite, UiWidgetAdapterTestField, UiWidgetAdapterTestSelectedValue

public class UiWidgetAdapterTest
extends AbstractUiWidgetAdapter<Void>
implements AttributeWriteMaximumTextLength, AttributeWriteValidationFailure, UiWidgetAdapterButton, UiWidgetAdapterCollapsableSection, UiWidgetAdapterImage, UiWidgetAdapterLabel, UiWidgetAdapterLink, UiWidgetAdapterSection, UiWidgetAdapterMenuItemClickable, UiWidgetAdapterMenuItemSeparator, AttributeWriteSelectionMode, AttributeWriteStringTitle, AttributeWriteSummary, AttributeWriteTitleVisible

This is the implementation of UiWidgetAdapter for testing without a native toolkit.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	collapsed
private boolean	disposed
private String	validationFailure
private int	validationFailureSetCount

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

PROPERTY_TITLE

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

PROPERTY_SUMMARY

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

ATTRIBUTE_COLSPAN

Constructor Summary

Constructors

Constructor and Description
UiWidgetAdapterTest() The constructor.

Method Summary

Modifier and Type	Method and Description
void	clearValidationFailureSetCount() Sets the value of getValidationFailureSetCount() to 0.
String	createAbsoluteImageUrl(String relativePath) This method creates an absolute URL from the given relativePath.
protected Void	createToplevelWidget() This method creates the underlying widget.
void	dispose() This method disposes this object.
double	getHeightInPixel() This method gets the height of this object in pixels.
Length	getLength(LengthProperty property) This method gets the Length for the given LengthProperty of this object.
String	getSummary() This method gets the summary of this object.
String	getValidationFailure() This method gets the validation failure of this object.
int	getValidationFailureSetCount()
double	getWidthInPixel() This method gets the width of this object in pixels.
boolean	isCollapsed() This method determines if this object is collapsed.
boolean	isTitleVisible() This method determines if the title of this object is visible.
void	removeFromParent() This method removes the widget from its parent.
void	setAccessKey(char accessKey) This method sets the accessKey attribute of this object.
void	setAltText(String altText) This method sets the alternative text of this object.
void	setAttribute(String name, String value) This method sets the attribute of this object.
void	setCollapsed(boolean collapsed) This method sets the collapsed status of this object.
void	setEnabled(boolean enabled) This method sets the enabled status of this object.
void	setEventSender(UiFeatureEvent source, UiHandlerEvent sender) This method registers the given event handler in the widget.
boolean	setFocused() This method sets the focus to this object.
void	setId(String id) This method set the ID of 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.
void	setLength(LengthProperty property, Length value) This method sets the specified length of this object.
void	setMaximumTextLength(int length) This method sets the maximum text length of this object.
void	setSelectionMode(SelectionMode selectionMode) This method sets the selection mode.
void	setStyles(String styles) This method clears all styles and sets them to the given styles.
void	setSummary(String summary) This method sets the summary of this object.
void	setTitle(String title) This method sets the title of this object.
void	setTitleVisible(boolean titleVisible) This method sets the titleVisible flag of this object.
void	setTooltip(String tooltip) This method sets the tooltip text of this object.
void	setUrl(String url) This method sets the URL of this object.
void	setValidationFailure(String validationFailure) This method sets the validation failure.
void	setVisible(boolean visible, boolean programmatic)
protected void	verifyNotDisposed() Verifies that this object is NOT already disposed.

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

addStyle, createLabel, getAccessKey, getActiveWidget, getAltText, getAttribute, getBundle, getColumnSpan, getContext, getHeightInRows, getId, getImage, getLabel, getMaximumTextLength, getPrimaryStyle, getSelectionMode, getStyles, getTitle, getTooltip, getToplevelWidget, getUiWidget, getUiWidgetTyped, getUrl, hasStyle, isDisposed, isEnabled, isFocused, isResizable, isStyleDeltaSupported, removeStyle, setMode, setParent, setPrimaryStyle, setUiWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMaximumTextLength

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

getAltText

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

getUrl

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

isFocused

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

getAccessKey

Methods inherited from interface net.sf.mmm.client.ui.base.widget.adapter.UiWidgetAdapter

createLabel, getToplevelWidget, isStyleDeltaSupported, setMode, setParent

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

getId

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

getTooltip

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

isDisposed

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

getAttribute

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

getImage

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

getSelectionMode

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

getTitle

Field Detail

disposed

private boolean disposed

See Also:

dispose()

collapsed

private boolean collapsed

See Also:

setEnabled(boolean)

validationFailure

private String validationFailure

See Also:

getValidationFailure()

validationFailureSetCount

private int validationFailureSetCount

See Also:

getValidationFailureSetCount()

Constructor Detail

UiWidgetAdapterTest

public UiWidgetAdapterTest()

The constructor.

Method Detail

createToplevelWidget

protected Void createToplevelWidget()

This method creates the underlying widget.
ATTENTION:
This method is called from the constructor but implemented in sub-classes. You should NOT access or even modify member variables as they are NOT set at this point (even final members). However, this design is done by intention instead of passing the widget as constructor argument to give more flexibility by overriding and also for potential lazy initialization of the widget.

Specified by:

createToplevelWidget in class AbstractUiWidgetAdapter<Void>

Returns:

a new instance of the underlying widget.

removeFromParent

public void removeFromParent()

This method removes the widget from its parent. After this method, the widget is detached from the UI.

Specified by:

removeFromParent in interface UiWidgetAdapter

createAbsoluteImageUrl

public String createAbsoluteImageUrl(String relativePath)

This method creates an absolute URL from the given relativePath.

Specified by:

createAbsoluteImageUrl in interface UiWidgetAdapter

Parameters:

relativePath - is the relative path (URL suffix) to the image.

Returns:

the absolute URL.

See Also:

UiConfiguration.getTheme()

setEventSender

public void setEventSender(UiFeatureEvent source,
                           UiHandlerEvent sender)

This method registers the given event handler in the widget. This method will be called only once.

Specified by:

setEventSender in interface UiWidgetAdapter

Parameters:

source - is the event source.

sender - is the UiHandlerEvent where the events are send to. This is actually an adapter that dispatches the events to the individual listeners registered in the widget.

getLength

public Length getLength(LengthProperty property)

This method gets the Length for the given LengthProperty of this object.
E.g. the call of getLength(LengthProperty.WIDTH) will return the same result as AttributeReadSize.getWidth(). Unlike AttributeReadSize this method provides access to additional properties such as e.g. LengthProperty.MIN_WIDTH or LengthProperty.MAX_HEIGHT.

Specified by:

getLength in interface AttributeReadLengthProperty

Parameters:

property - is the LengthProperty identifying the actual property to get.

Returns:

the requested Length. Will be Length.ZERO if undefined (NOT set).

setLength

public void setLength(LengthProperty property,
                      Length value)

This method sets the specified length of this object.
E.g. the call of setLength(LengthProperty.WIDTH, value) will return the same result as setWidth(value).

Specified by:

setLength in interface AttributeWriteLengthProperty

Parameters:

property - is the LengthProperty identifying the actual property to set.

value - is the new length to set.

getWidthInPixel

public double getWidthInPixel()

This method gets the width of this object in pixels.
NOTE:
The result will typically be an int value. However, to be compatible with Length.getAmount() and with some underlying native toolkits we use double to prevent potential information loss.

Specified by:

getWidthInPixel in interface AttributeReadSizeInPixel

Returns:

the width.

getHeightInPixel

public double getHeightInPixel()

This method gets the height of this object in pixels.
NOTE:
The result will typically be an int value. However, to be compatible with Length.getAmount() and with some underlying native toolkits we use double to prevent potential information loss.

Specified by:

getHeightInPixel in interface AttributeReadSizeInPixel

Returns:

the height.

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.

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

setId

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

setAttribute

public void setAttribute(String name,
                         String value)

This method sets the attribute of this object.

Specified by:

setAttribute in interface AttributeWriteOnlyAttribute

Parameters:

name - is the name of the attribute.

value - is the new value of the attribute. May be null to unset (remove attribute).

verifyNotDisposed

protected void verifyNotDisposed()

Verifies that this object is NOT already disposed.

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

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.

setVisible

public void setVisible(boolean visible,
                       boolean programmatic)

Specified by:

setVisible in interface UiWidgetAdapter

Parameters:

visible - - true to set visible (show), false to set invisible (hide).

programmatic - - see UiEvent.isProgrammatic().

See Also:

AttributeWriteVisibleAdvanced.setVisible(boolean, boolean)

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.

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.

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>

Parameters:

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

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.

setCollapsed

public void setCollapsed(boolean collapsed)

This method sets the collapsed status of this object.

Specified by:

setCollapsed in interface AttributeWriteCollapsed

Parameters:

collapsed - - if true the object will be collapsed, else it will be expanded.

isCollapsed

public boolean isCollapsed()

This method determines if this object is collapsed. This means that some content is hidden (folded away). If it is NOT collapsed, it is called expanded and the content gets visible again.

Specified by:

isCollapsed in interface AttributeReadCollapsed

Returns:

true if this object is collapsed, false if expanded.

setUrl

public void setUrl(String url)

This method sets the URL of this object.

Specified by:

setUrl in interface AttributeWriteUrl

Parameters:

url - is the new URL.

setAltText

public void setAltText(String altText)

This method sets the alternative text of this object.

Specified by:

setAltText in interface AttributeWriteAltText

Parameters:

altText - is the new alternative text.

See Also:

AttributeReadAltText.getAltText(), Accessibility

getValidationFailure

public String getValidationFailure()

This method gets the validation failure of this object. This is a text that explains the user why the value he has entered is invalid (typically provided as tooltip of an error icon).

Specified by:

getValidationFailure in interface AttributeReadValidationFailure

Overrides:

getValidationFailure in class AbstractUiWidgetAdapter<Void>

Returns:

the validation error text or null for no error.

setValidationFailure

public void setValidationFailure(String validationFailure)

This method sets the validation failure.
ATTENTION:
For regular usage you should use UiFeatureValidation. This method is only intended as back-door for very special cases (e.g. you have to use your own validator infrastructure and perform validation outside this framework). It is not recommended to use this method as an API user.

Specified by:

setValidationFailure in interface AttributeWriteValidationFailure

Parameters:

validationFailure - is the validation failure text. The empty string or null will clear the error and mark the field as valid. Otherwise the field will be invalid.

getValidationFailureSetCount

public int getValidationFailureSetCount()

Returns:

the number of invocations to setValidationFailure(String) since clearValidationFailureSetCount().

clearValidationFailureSetCount

public void clearValidationFailureSetCount()

Sets the value of getValidationFailureSetCount() to 0.

setMaximumTextLength

public void setMaximumTextLength(int length)

This method sets the maximum text length of this object.
ATTENTION:
If you are setting this property on a UI field, the typical behavior is that after the maximum text length is reached, any additional input is ignored. This also applies for copy and paste operations. For usability this might be undesired in many cases as users can not append something and then remove a prefix afterwards if the length would be exceeded. Please consider using a validator instead and only use this feature in situations where it is really suitable.

Specified by:

setMaximumTextLength in interface AttributeWriteMaximumTextLength

Parameters:

length - is the new maximum text length to set. Use Integer.MAX_VALUE to unset.

setSelectionMode

public void setSelectionMode(SelectionMode selectionMode)

This method sets the selection mode.
ATTENTION:
It is recommended to set the SelectionMode immediately after creating the object. The initial default is always SelectionMode.SINGLE_SELECTION. Dynamically changing the SelectionMode may be expensive or not be supported (in exotic implementations) and should therefore be avoided.

Specified by:

setSelectionMode in interface AttributeWriteSelectionMode

Parameters:

selectionMode - is the new SelectionMode.

setTitle

public void setTitle(String title)

This method sets the title of this object.

Specified by:

setTitle in interface AttributeWriteStringTitle

Specified by:

setTitle in interface AttributeWriteTitle<String>

Parameters:

title - is the new title.

See Also:

AttributeReadStringTitle.getTitle()

getSummary

public String getSummary()

This method gets the summary of this object. It describes the main purpose of this object in a short and compact way. A summary might not be visible but is honored by assistive technology such as screen-readers.

Specified by:

getSummary in interface AttributeReadSummary

Returns:

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

setSummary

public void setSummary(String summary)

This method sets the summary of this object.

Specified by:

setSummary in interface AttributeWriteSummary

Parameters:

summary - is the new summary to set.

isTitleVisible

public boolean isTitleVisible()

This method determines if the title of this object is visible. For Accessibility reasons you should always set the title of a titled object. However in specific cases you want to save space on the screen and may not require the title to be displayed for seeing users. Then you can hide the title while it is still recognized by assistive technology such as screen readers.

Specified by:

isTitleVisible in interface AttributeReadTitleVisible

Returns:

true if visible, false if hidden.

setTitleVisible

public void setTitleVisible(boolean titleVisible)

This method sets the titleVisible flag of this object.

Specified by:

setTitleVisible in interface AttributeWriteTitleVisible

Parameters:

titleVisible - is the new value for AttributeReadTitleVisible.isTitleVisible().