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

Class AbstractUiWidgetAbstractWindow<ADAPTER extends UiWidgetAdapterAbstractWindow>

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,Void>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetComposite<ADAPTER,CHILD>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetDynamicComposite<ADAPTER,UiWidgetRegular>

net.sf.mmm.client.ui.base.widget.window.AbstractUiWidgetAbstractWindow<ADAPTER>

Type Parameters:

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

All Implemented Interfaces:

AttributeReadAriaRole, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPosition, AttributeReadPrimaryStyle, AttributeReadResizable, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadValueAdvanced<Void>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAriaRole, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePosition, AttributeWritePrimaryStyle, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteValueAdvanced<Void>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiFeatureValidation<Void>, UiFeatureValue<Void>, UiFeatureValueAndValidation<Void>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<Void>, UiWidgetComposite<UiWidgetRegular>, UiWidgetDynamicComposite<UiWidgetRegular>, UiWidgetMultiComposite<UiWidgetRegular>, UiWidgetAbstractWindow, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeReadValue<Void>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, AttributeWriteValue<Void>, Accessibility, AbstractValidatableObject, HasValueValidators<Void>, ValidatableObject<Void>

Direct Known Subclasses:

AbstractUiWidgetAbstractDialogWindow, AbstractUiWidgetMainWindow

public abstract class AbstractUiWidgetAbstractWindow<ADAPTER extends UiWidgetAdapterAbstractWindow>
extends AbstractUiWidgetDynamicComposite<ADAPTER,UiWidgetRegular>
implements UiWidgetAbstractWindow

This is the abstract base implementation of UiWidgetAbstractWindow.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AbstractUiWidgetAbstractWindow.SizeWindowImpl Extends AbstractUiWidgetNative.SizeImpl with window specific size logic.

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 String	title
private double	x
private double	y

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

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

PROPERTY_TITLE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	centerWindow() This method sets the position of the window, so that it is in the center of the screen.
private Length	convertEmToPixel(Length length) Converts a Length given in LengthUnit.EM to LengthUnit.PIXEL.
protected AbstractUiWidgetNative.SizeImpl	createSize()
double	getPositionX() This method gets the pixel position of the left border object on the x-axis (horizontal).
double	getPositionY() This method gets the pixel position of the top border of this object on the y-axis (vertical).
private AttributeReadSizeInPixel	getScreenBase()
String	getSource()
String	getTitle() This method gets the title of this object.
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
void	setPosition(double xPos, double yPos) This method sets the position of the object.
void	setTitle(String title) This method sets the title of 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.AbstractUiWidgetDynamicComposite

addChild, addChild, doAddChild, getChild, getChildCount, getChildIndex, removeChild, removeChild

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

getChild

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

addChangeHandler, addStyle, clearMessages, clearValidity, createUniqueId, createWidgetAdapter, dispose, doGetValue, doSetMode, doSetValue, doValidate, getAriaRole, getAriaRoleFixedType, getId, getIndexOfStyle, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getStyles, getTooltip, getVisibleFlag, getWidgetAdapter, getWidgetAdapter, hasStyle, hasWidgetAdapter, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeChangeHandler, removeFromParent, removeStyle, setAriaRole, setEnabled, setFocused, setId, setIdPrefix, setMode, setMode, setModeFixed, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, toString, 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.UiWidgetDynamicComposite

addChild, addChild

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetMultiComposite

removeChild, removeChild

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetComposite

getChild, getChild

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetAbstractComposite

getChildCount, getChildIndex

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

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

isResizable

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

title

private String title

See Also:

getTitle()

x

private double x

See Also:

getPositionX()

y

private double y

See Also:

getPositionY()

Constructor Detail

AbstractUiWidgetAbstractWindow

public AbstractUiWidgetAbstractWindow(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 AbstractUiWidgetDynamicComposite<ADAPTER extends UiWidgetAdapterAbstractWindow,UiWidgetRegular>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

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

setPosition

public void setPosition(double xPos,
                        double yPos)

This method sets the position of the object.

Specified by:

setPosition in interface AttributeWritePosition

Parameters:

xPos - is the position on the x-axsis (horizontal).

yPos - is the position on the y-axsis (vertical).

getPositionX

public double getPositionX()

This method gets the pixel position of the left border object on the x-axis (horizontal).

Specified by:

getPositionX in interface AttributeReadPosition

Returns:

the x position.

See Also:

AttributeReadPosition.getPositionY()

getPositionY

public double getPositionY()

This method gets the pixel position of the top border of this object on the y-axis (vertical).

Specified by:

getPositionY in interface AttributeReadPosition

Returns:

the y position.

See Also:

AttributeReadPosition.getPositionX()

getTitle

public String getTitle()

This method gets the title of this object. The detailed meaning of the title depends on the type of object. E.g. a window will have the title in the top-level bar.

Specified by:

getTitle in interface AttributeReadStringTitle

Specified by:

getTitle in interface AttributeReadTitle<String>

Returns:

the title.

centerWindow

public void centerWindow()

This method sets the position of the window, so that it is in the center of the screen. You should set set the size before invoking this method.

Specified by:

centerWindow in interface UiWidgetAbstractWindow

createSize

protected AbstractUiWidgetNative.SizeImpl createSize()

Overrides:

createSize in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterAbstractWindow,Void>

Returns:

the Size instance lazily created by AbstractUiWidgetNative.getSize().

convertEmToPixel

private Length convertEmToPixel(Length length)

Converts a Length given in LengthUnit.EM to LengthUnit.PIXEL.

Parameters:

length - is the Length to convert.

Returns:

the converted Length.

getScreenBase

private AttributeReadSizeInPixel getScreenBase()

Returns:

the instance of AttributeReadSizeInPixel used to determine the base of the screen to center or convert Length.

setVisible

public void setVisible(boolean visible,
                       boolean programmatic)

This method shows or hides this object.

Specified by:

setVisible in interface AttributeWriteVisibleAdvanced

Overrides:

setVisible in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterAbstractWindow,Void>

Parameters:

visible - - see AbstractUiWidgetNative.setVisible(boolean).

programmatic - - see UiEvent.isProgrammatic().

See Also:

AbstractUiWidgetNative.setVisible(boolean)

getSource

public String getSource()

Overrides:

getSource in class AbstractUiWidget<Void>

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