net.sf.mmm.client.ui.impl.gwt.widget.window.adapter

Class UiWidgetAdapterGwtAbstractDialogWindow

java.lang.Object

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

net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapterWithEvents<WIDGET,EventAdapterGwt>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt<WIDGET>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidget<WIDGET>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtDynamicComposite<WIDGET,UiWidgetRegular>

net.sf.mmm.client.ui.impl.gwt.widget.window.adapter.UiWidgetAdapterGwtAbstractWindow<PopupWindow>

net.sf.mmm.client.ui.impl.gwt.widget.window.adapter.UiWidgetAdapterGwtAbstractDialogWindow

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAltText, AttributeReadAttribute, AttributeReadClosable, AttributeReadColumnSpan, AttributeReadEnabled, AttributeReadFocused, AttributeReadHeightInRows, AttributeReadHtmlId, AttributeReadImage<UiWidgetImage>, AttributeReadLabel, AttributeReadLengthProperty, AttributeReadMaximizable, AttributeReadMaximized, AttributeReadMaximumTextLength, AttributeReadMovable, AttributeReadPosition, AttributeReadPrimaryStyle, AttributeReadResizable, AttributeReadSelectionMode, AttributeReadSizeInPixel, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadUrl, AttributeReadValidationFailure, AttributeWriteAttribute, AttributeWriteClosable, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteImage<UiWidgetImage>, AttributeWriteLengthProperty, AttributeWriteMaximizable, AttributeWriteMaximized, AttributeWriteMovable, AttributeWriteOnlyAttribute, AttributeWritePosition, AttributeWritePrimaryStyle, AttributeWriteResizable, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, UiWidgetAdapter, UiWidgetAdapterComposite<UiWidgetRegular>, UiWidgetAdapterDynamicComposite<UiWidgetRegular>, UiWidgetAdapterAbstractDialogWindow, UiWidgetAdapterAbstractWindow, HandlerRegistrationCollector, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, Accessibility

Direct Known Subclasses:

UiWidgetAdapterGwtPopup, UiWidgetAdapterGwtWindow

public abstract class UiWidgetAdapterGwtAbstractDialogWindow
extends UiWidgetAdapterGwtAbstractWindow<PopupWindow>
implements UiWidgetAdapterAbstractDialogWindow

This is the implementation of UiWidgetAdapterAbstractDialogWindow using GWT based on PopupWindow.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt

TAB_INDEX_NONE

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

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

PROPERTY_LABEL

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

ATTRIBUTE_COLSPAN

Constructor Summary

Constructors

Constructor and Description
UiWidgetAdapterGwtAbstractDialogWindow() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	applyEventAdapter(EventAdapterGwt adapter) This method applies the given event adapter to the widget(s) so it receive native events.
protected VerticalFlowPanel	getContentPanel()
double	getHeightInPixel() This method gets the height of this object in pixels.
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).
protected com.google.gwt.dom.client.Element	getSizeElement()
double	getWidthInPixel() This method gets the width of this object in pixels.
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.
boolean	isResizable() This method determines if this object is resizable.
void	setClosable(boolean closable) This method sets the closable attribute.
void	setLength(LengthProperty property, Length length) This method sets the specified length of this object.
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	setPosition(double x, double y) This method sets the position of the object.
void	setResizable(boolean resizable) This method sets the resizable attribute.
void	setTitle(String title) This method sets the title of this object.
void	setVisible(boolean visible, boolean programmatic)

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.window.adapter.UiWidgetAdapterGwtAbstractWindow

addChild, setEnabled

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtDynamicComposite

removeChild

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidget

dispose, getActiveWidget, removeFromParent

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt

addHandlerRegistration, addStyle, createAbsoluteImageUrl, createEventAdapter, getImage, getImageParentElement, getLength, getToplevelWidget, getToplevelWidget, isStyleDeltaSupported, removeStyle, setAttribute, setId, setImage, setPrimaryStyle, setStyles, setTooltip

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

applyEventAdapterForChange, applyEventAdapterForClick, applyEventAdapterForFocus, applyEventAdapterForSelection, getEventAdapter, setEventSender

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

createLabel, createToplevelWidget, getAccessKey, getAltText, getAttribute, getBundle, getColumnSpan, getContext, getHeightInRows, getId, getLabel, getMaximumTextLength, getPrimaryStyle, getSelectionMode, getStyles, getTitle, getTooltip, getToplevelWidget, getUiWidget, getUiWidgetTyped, getUrl, getValidationFailure, hasStyle, isDisposed, isEnabled, isFocused, setMode, setParent, 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.base.widget.adapter.UiWidgetAdapterDynamicComposite

addChild, removeChild

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

createAbsoluteImageUrl, createLabel, getToplevelWidget, isStyleDeltaSupported, removeFromParent, setEventSender, setMode, setParent

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

getLength

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

getAttribute

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

setAttribute

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

getTitle

Constructor Detail

UiWidgetAdapterGwtAbstractDialogWindow

public UiWidgetAdapterGwtAbstractDialogWindow()

The constructor.

Method Detail

applyEventAdapter

protected void applyEventAdapter(EventAdapterGwt adapter)

This method applies the given event adapter to the widget(s) so it receive native events. It will be called only once. Override only to add specific event registrations.

Overrides:

applyEventAdapter in class AbstractUiWidgetAdapterWithEvents<PopupWindow,EventAdapterGwt>

Parameters:

adapter - is the event adapter.

setVisible

public void setVisible(boolean visible,
                       boolean programmatic)

Specified by:

setVisible in interface UiWidgetAdapter

Overrides:

setVisible in class UiWidgetAdapterGwt<PopupWindow>

Parameters:

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

programmatic - - see UiEvent.isProgrammatic().

See Also:

AttributeWriteVisibleAdvanced.setVisible(boolean, boolean)

getContentPanel

protected VerticalFlowPanel getContentPanel()

Specified by:

getContentPanel in class UiWidgetAdapterGwtAbstractWindow<PopupWindow>

Returns:

the content panel.

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

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

Overrides:

getWidthInPixel in class UiWidgetAdapterGwt<PopupWindow>

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

Overrides:

getHeightInPixel in class UiWidgetAdapterGwt<PopupWindow>

Returns:

the height.

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

isResizable

public boolean isResizable()

This method determines if this object is resizable.

Specified by:

isResizable in interface AttributeReadResizable

Overrides:

isResizable in class AbstractUiWidgetAdapter<PopupWindow>

Returns:

true if the object can be resized (by the end-user), 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().

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.

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

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.

setClosable

public void setClosable(boolean closable)

This method sets the closable attribute.

Specified by:

setClosable in interface AttributeWriteClosable

Parameters:

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

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.

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

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.

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

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

setLength

public void setLength(LengthProperty property,
                      Length length)

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

Overrides:

setLength in class UiWidgetAdapterGwt<PopupWindow>

Parameters:

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

length - is the new length to set.

getSizeElement

protected com.google.gwt.dom.client.Element getSizeElement()

Overrides:

getSizeElement in class UiWidgetAdapterGwtAbstractWindow<PopupWindow>

Returns:

the sized Element used by UiWidgetAdapterGwt.getLength(LengthProperty) and UiWidgetAdapterGwt.setLength(LengthProperty, Length).