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

Class UiWidgetCustomAbstractWindow<DELEGATE extends UiWidgetAbstractWindow>

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>

net.sf.mmm.client.ui.base.widget.custom.UiWidgetCustomComposite<VALUE,CHILD,DELEGATE>

net.sf.mmm.client.ui.base.widget.custom.UiWidgetCustomDynamicComposite<Void,UiWidgetRegular,DELEGATE>

net.sf.mmm.client.ui.base.widget.custom.window.UiWidgetCustomAbstractWindow<DELEGATE>

Type Parameters:

DELEGATE - is the generic type of the delegate.

All Implemented Interfaces:

AttributeReadAriaRole, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPosition, AttributeReadPrimaryStyle, AttributeReadResizable, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadValueAdvanced<Void>, AttributeReadVisible, AttributeReadVisibleRecursive, 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>, UiWidgetRegular, UiWidgetWithValue<Void>, UiWidgetAbstractWindow, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeReadValue<Void>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, AttributeWriteValue<Void>, Accessibility, AbstractValidatableObject, HasValueValidators<Void>, ValidatableObject<Void>

Direct Known Subclasses:

UiWidgetCustomAbstractDialogWindow

public abstract class UiWidgetCustomAbstractWindow<DELEGATE extends UiWidgetAbstractWindow>
extends UiWidgetCustomDynamicComposite<Void,UiWidgetRegular,DELEGATE>
implements UiWidgetAbstractWindow

This is the abstract base class for a custom widget implementing UiWidgetAbstractWindow.

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 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
UiWidgetCustomAbstractWindow(UiContext context, DELEGATE delegate) 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.
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).
String	getTitle() This method gets the title of this object.
boolean	isResizable() This method determines if this object is resizable.
void	setPosition(double x, double y) This method sets the position of the object.
void	setTitle(String title) This method sets the title of this object.

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

addChild, addChild, removeChild, removeChild

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

doGetValue, doSetValue, getChild, getChild, getChildCount, getChildIndex

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

addStyle, clearMessages, clearValidity, dispose, doInitialize, doSetMode, doValidate, getAriaRole, getDelegate, getDelegate, getId, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getSource, getStyles, getTooltip, getValueClass, getVisibleFlag, getWidgetAdapter, hasStyle, hasWidgetAdapter, initialize, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeFromParent, removeStyle, setEnabled, setFocused, setId, setMode, setMode, setModeFixed, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, setVisible

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

addChangeHandler, addEventHandler, addValidator, clearMessagesLocal, clearValidationFailure, convertValueToString, 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.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, 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.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

Constructor Detail

UiWidgetCustomAbstractWindow

public UiWidgetCustomAbstractWindow(UiContext context,
                                    DELEGATE delegate)

The constructor.

Parameters:

context - is the context.

delegate - is the delegate.

Method Detail

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

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.

setPosition

public void setPosition(double x,
                        double y)

This method sets the position of the object.

Specified by:

setPosition in interface AttributeWritePosition

Parameters:

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

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

isResizable

public boolean isResizable()

This method determines if this object is resizable.

Specified by:

isResizable in interface AttributeReadResizable

Returns:

true if the object can be resized (by the end-user), false otherwise.

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