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

Class UiWidgetCustomAbstractDialogWindow<DELEGATE extends UiWidgetAbstractDialogWindow>

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>

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

Type Parameters:

DELEGATE - is the generic type of the delegate.

All Implemented Interfaces:

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

Direct Known Subclasses:

UiWidgetCustomPopup

public abstract class UiWidgetCustomAbstractDialogWindow<DELEGATE extends UiWidgetAbstractDialogWindow>
extends UiWidgetCustomAbstractWindow<DELEGATE>
implements UiWidgetAbstractDialogWindow

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

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

STYLE_PRIMARY

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
UiWidgetCustomAbstractDialogWindow(UiContext context, DELEGATE delegate) The constructor.

Method Summary

Modifier and Type	Method and Description
void	addCloseHandler(UiHandlerEventClose handler) This method adds the given UiHandlerEventClose to this object.
void	addOpenHandler(UiHandlerEventOpen handler) This method adds the given UiHandlerEventOpen to this object.
void	close() Closes this object so it gets hidden.
boolean	isClosable() This method determines if this object (e.g.
boolean	isMaximizable() This method determines if this object can be (un)maximized by the end-user.
boolean	isMaximized() This method determines if this object is maximized.
boolean	isMovable() This method determines if this object can be moved.
void	open() Opens this object so it gets visible.
boolean	removeCloseHandler(UiHandlerEventClose handler) This method removes the given UiHandlerEventClose from this object.
boolean	removeOpenHandler(UiHandlerEventOpen handler) This method removes the given UiHandlerEventOpen from this object.
void	setClosable(boolean closable) This method sets the closable attribute.
void	setMaximizable(boolean maximizable) This method set the maximizable state of this object.
void	setMaximized(boolean maximized) This method (un)maximizes the object.
void	setMovable(boolean movable) This method sets the movable attribute.
void	setResizable(boolean resizable) This method sets the resizable attribute.

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

centerWindow, getPositionX, getPositionY, getTitle, isResizable, setPosition, setTitle

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

centerWindow

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

setTitle

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

getTitle

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

setPosition

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

getPositionX, getPositionY

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

isResizable

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

UiWidgetCustomAbstractDialogWindow

public UiWidgetCustomAbstractDialogWindow(UiContext context,
                                          DELEGATE delegate)

The constructor.

Parameters:

context - is the context.

delegate - is the delegate.

Method Detail

open

public void open()

Opens this object so it gets visible. Has the same effect as setVisible(true).

Specified by:

open in interface UiFeatureOpenClose

close

public void close()

Closes this object so it gets hidden. Has the same effect as setVisible(false).

Specified by:

close in interface UiFeatureOpenClose

addOpenHandler

public void addOpenHandler(UiHandlerEventOpen handler)

This method adds the given UiHandlerEventOpen to this object.

Specified by:

addOpenHandler in interface UiFeatureOpenClose

Parameters:

handler - is the UiHandlerEventOpen to add.

addCloseHandler

public void addCloseHandler(UiHandlerEventClose handler)

This method adds the given UiHandlerEventClose to this object.

Specified by:

addCloseHandler in interface UiFeatureOpenClose

Parameters:

handler - is the UiHandlerEventClose to add.

removeOpenHandler

public boolean removeOpenHandler(UiHandlerEventOpen handler)

This method removes the given UiHandlerEventOpen from this object.

Specified by:

removeOpenHandler in interface UiFeatureOpenClose

Parameters:

handler - is the UiHandlerEventClose to remove.

Returns:

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

removeCloseHandler

public boolean removeCloseHandler(UiHandlerEventClose handler)

This method removes the given UiHandlerEventClose from this object.

Specified by:

removeCloseHandler in interface UiFeatureOpenClose

Parameters:

handler - is the UiHandlerEventClose to remove.

Returns:

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

setMovable

public void setMovable(boolean movable)

This method sets the movable attribute.

Specified by:

setMovable in interface AttributeWriteMovable

Parameters:

movable - is the new value of AttributeReadMovable.isMovable().

isMaximized

public boolean isMaximized()

This method determines if this object is maximized. In this case the size is fully expanded to cover the entire screen (also called full-screen).

Specified by:

isMaximized in interface AttributeReadMaximized

Returns:

true if the object is maximized, false otherwise.

setMaximizable

public void setMaximizable(boolean maximizable)

This method set the maximizable state of this object.

Specified by:

setMaximizable in interface AttributeWriteMaximizable

Parameters:

maximizable - - true if a (icon) button shall be available to (un)maximize the object (window), false otherwise.

See Also:

AttributeReadMaximizable.isMaximizable()

isMaximizable

public boolean isMaximizable()

This method determines if this object can be (un)maximized by the end-user.

Specified by:

isMaximizable in interface AttributeReadMaximizable

Returns:

true if the object is maximizable, false otherwise.

setResizable

public void setResizable(boolean resizable)

This method sets the resizable attribute.

Specified by:

setResizable in interface AttributeWriteResizable

Parameters:

resizable - is the new value of AttributeReadResizable.isResizable().

setClosable

public void setClosable(boolean closable)

This method sets the closable attribute. By default a dialog window is closable. If you set closable to false there is no icon-button displayed in the title-bar and hitting the escape key will not close the window.

Specified by:

setClosable in interface AttributeWriteClosable

Specified by:

setClosable in interface UiWidgetAbstractDialogWindow

Parameters:

closable - is the new value of AttributeReadClosable.isClosable().

isMovable

public boolean isMovable()

This method determines if this object can be moved.

Specified by:

isMovable in interface AttributeReadMovable

Returns:

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

isClosable

public boolean isClosable()

This method determines if this object (e.g. a window) can be closed by the end-user.

Specified by:

isClosable in interface AttributeReadClosable

Returns:

true if the object can be closed by the end-user, false otherwise.

setMaximized

public void setMaximized(boolean maximized)

This method (un)maximizes the object. If it is un-maximized, its size and position will be restored to the values before it was maximized.

Specified by:

setMaximized in interface AttributeWriteMaximized

Parameters:

maximized - - true to maximize, false to un-maximize.

See Also:

AttributeReadMaximized.isMaximized()