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

Class UiWidgetAdapterGwtMainWindow

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<com.google.gwt.user.client.ui.RootPanel>

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

All Implemented Interfaces:

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

public class UiWidgetAdapterGwtMainWindow
extends UiWidgetAdapterGwtAbstractWindow<com.google.gwt.user.client.ui.RootPanel>
implements UiWidgetAdapterMainWindow

This is the implementation of UiWidgetAdapterMainWindow using GWT based on RootPanel and Window.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private VerticalFlowPanel	contentPanel

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
UiWidgetAdapterGwtMainWindow() The constructor.

Method Summary

Modifier and Type	Method and Description
private int	convertLength(Length length) Converts the width to pixels.
protected com.google.gwt.user.client.ui.RootPanel	createToplevelWidget() This method creates the underlying widget.
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).
String	getTitle() This method gets the title of this object.
double	getWidthInPixel() This method gets the width of this object in pixels.
boolean	isResizable() This method determines if this object is resizable.
void	setEnabled(boolean enabled) This method sets the enabled status of this object.
void	setLength(LengthProperty property, Length value) This method sets the specified length of this object.
void	setMenuBar(UiWidgetMenuBar menuBar) This method sets the UiWidgetMenuBar.
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.impl.gwt.widget.window.adapter.UiWidgetAdapterGwtAbstractWindow

addChild, getSizeElement

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

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

applyEventAdapter, applyEventAdapterForChange, applyEventAdapterForClick, applyEventAdapterForFocus, applyEventAdapterForSelection, getEventAdapter, setEventSender

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

createLabel, getAccessKey, getAltText, getAttribute, getBundle, getColumnSpan, getContext, getHeightInRows, getId, getLabel, getMaximumTextLength, getPrimaryStyle, getSelectionMode, getStyles, 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, setVisible

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

Field Detail

contentPanel

private final VerticalFlowPanel contentPanel

See Also:

getContentPanel()

Constructor Detail

UiWidgetAdapterGwtMainWindow

public UiWidgetAdapterGwtMainWindow()

The constructor.

Method Detail

getContentPanel

protected VerticalFlowPanel getContentPanel()

Specified by:

getContentPanel in class UiWidgetAdapterGwtAbstractWindow<com.google.gwt.user.client.ui.RootPanel>

Returns:

the content panel.

getTitle

public String getTitle()

This method gets the title of this object.
NOTE:
For generic usage you need to use Object.toString() of the result if NOT null

Specified by:

getTitle in interface AttributeReadStringTitle

Specified by:

getTitle in interface AttributeReadTitle<String>

Overrides:

getTitle in class AbstractUiWidgetAdapter<com.google.gwt.user.client.ui.RootPanel>

Returns:

the title or null if not set. The string-representation of the result (if NOT null) needs to be suitable for end-users.

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

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

Overrides:

setLength in class UiWidgetAdapterGwt<com.google.gwt.user.client.ui.RootPanel>

Parameters:

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

value - is the new length to set.

convertLength

private int convertLength(Length length)

Converts the width to pixels. Actual conversion has already been done by the AbstractUiWidgetAbstractWindow.

Parameters:

length - is the Length.

Returns:

the amount of pixels.

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

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

Overrides:

setEnabled in class UiWidgetAdapterGwtAbstractWindow<com.google.gwt.user.client.ui.RootPanel>

Parameters:

enabled - - if true the object will be enabled, else the object will be disabled.

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<com.google.gwt.user.client.ui.RootPanel>

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<com.google.gwt.user.client.ui.RootPanel>

Returns:

the height.

isResizable

public boolean isResizable()

This method determines if this object is resizable.

Specified by:

isResizable in interface AttributeReadResizable

Overrides:

isResizable in class AbstractUiWidgetAdapter<com.google.gwt.user.client.ui.RootPanel>

Returns:

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

setMenuBar

public void setMenuBar(UiWidgetMenuBar menuBar)

This method sets the UiWidgetMenuBar. It will be called just once.

Specified by:

setMenuBar in interface UiWidgetAdapterMainWindow

Parameters:

menuBar - is the UiWidgetMenuBar to attach at the top of the window.

createToplevelWidget

protected com.google.gwt.user.client.ui.RootPanel 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<com.google.gwt.user.client.ui.RootPanel>

Returns:

a new instance of the underlying widget.