net.sf.mmm.client.ui.gwt.widgets

Class PopupWindow

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.SimplePanel

com.google.gwt.user.client.ui.PopupPanel

net.sf.mmm.client.ui.gwt.widgets.PopupWindow

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<com.google.gwt.user.client.ui.PopupPanel>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.EventPreview, com.google.gwt.user.client.ui.AcceptsOneWidget, com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesPopupEvents, Iterable<com.google.gwt.user.client.ui.Widget>, AttributeReadClosable, AttributeReadLengthProperty, AttributeReadMaximizable, AttributeReadMaximized, AttributeReadMovable, AttributeReadResizable, AttributeWriteClosable, AttributeWriteMaximizable, AttributeWriteMaximized, AttributeWriteMovable, AttributeWriteResizable

Direct Known Subclasses:

FeatureBehaviorInsertImage.InserImagePopup, FeatureBehaviorInsertLink.InserImageLink, RichTextToolbar.FontSettingsPopup

public class PopupWindow
extends com.google.gwt.user.client.ui.PopupPanel
implements AttributeWriteResizable, AttributeWriteMovable, AttributeWriteClosable, AttributeWriteMaximized, AttributeWriteMaximizable, AttributeReadLengthProperty

This class is a Widget that represents a popup. It extends PopupPanel with additional features such as being resizable. It is an alternative to DialogBox.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.PopupPanel

com.google.gwt.user.client.ui.PopupPanel.AnimationType, com.google.gwt.user.client.ui.PopupPanel.PositionCallback

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.gwt.user.client.ui.Widget	borderEast The right border of the window
private com.google.gwt.user.client.ui.Widget	borderNorth The top border of the window
private com.google.gwt.user.client.ui.Widget	borderNorthEast The top right corner of the window
private com.google.gwt.user.client.ui.Widget	borderNorthWest The top left corner of the window
private com.google.gwt.user.client.ui.Widget	borderSouth The bottom border of the window
private com.google.gwt.user.client.ui.Widget	borderSouthEast The bottom right corner of the window
private com.google.gwt.user.client.ui.Widget	borderSouthWest The bottom left corner of the window
private com.google.gwt.user.client.ui.Widget	borderWest The left border of the window
private ButtonPanel	buttonPanel
private boolean	closable
private com.google.gwt.user.client.ui.Button	closeButton The button to close the window.
private VerticalFlowPanel	contentPanel The content panel.
private com.google.gwt.dom.client.Element	focusedElement The Element outside the PopupWindow that had the focus before the PopupWindow was shown.
private com.google.gwt.dom.client.Element	glassPanel
private VerticalFlowPanel	mainPanel The main panel.
private boolean	maximizable
private SimpleToggleButton	maximizeButton The button to (un)maximize the window.
private boolean	maximized
private boolean	movable
private HandlerRegistrationCollector	registrationCollector The HandlerRegistrationCollector or null to ignore HandlerRegistrations.
private boolean	resizable
private int	savedHeight The saved height to restore after e.g.
private int	savedWidth The saved width to restore after e.g.
private int	savedX The saved X-position to restore after e.g.
private int	savedY The saved Y-position to restore after e.g.
private com.google.gwt.user.client.ui.InlineLabel	title The title label.
private HorizontalFlowPanel	titleBar The title panel.

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
PopupWindow() The constructor.
PopupWindow(boolean autoHide) The constructor.
PopupWindow(boolean autoHide, boolean modal) The constructor.
PopupWindow(boolean autoHide, boolean modal, HandlerRegistrationCollector registrationCollector) The constructor.

Method Summary

Modifier and Type	Method and Description
void	add(com.google.gwt.user.client.ui.IsWidget child)
void	add(com.google.gwt.user.client.ui.Widget w)
private void	addMouseHandler(com.google.gwt.user.client.ui.Widget widget, Direction resizeDirection) Adds a PopupMouseHandler to the given Widget based on the given Direction.
private void	doSetResizable(boolean newResizable)
ButtonPanel	getButtonPanel()
VerticalFlowPanel	getContentPanel()
private com.google.gwt.dom.client.Element	getFirstFocusElement()
protected com.google.gwt.dom.client.Element	getGlassPanel()
private com.google.gwt.dom.client.Element	getLastFocusElement()
Length	getLength(LengthProperty property) This method gets the Length for the given LengthProperty of this object.
(package private) VerticalFlowPanel	getMainPanel()
void	hide()
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.
protected void	onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent event)
boolean	remove(com.google.gwt.user.client.ui.IsWidget child)
boolean	remove(com.google.gwt.user.client.ui.Widget w)
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.
void	setTitleText(String titleText)
void	show()

Methods inherited from class com.google.gwt.user.client.ui.PopupPanel

addAutoHidePartner, addCloseHandler, addPopupListener, center, getAnimationType, getContainerElement, getGlassElement, getGlassStyleName, getOffsetHeight, getOffsetWidth, getPopupLeft, getPopupTop, getStyleElement, getTitle, hide, isAnimationEnabled, isAutoHideEnabled, isAutoHideOnHistoryEventsEnabled, isGlassEnabled, isModal, isPreviewingAllNativeEvents, isShowing, isVisible, onEventPreview, onKeyDownPreview, onKeyPressPreview, onKeyUpPreview, onUnload, removeAutoHidePartner, removePopupListener, setAnimationEnabled, setAnimationType, setAutoHideEnabled, setAutoHideOnHistoryEventsEnabled, setGlassEnabled, setGlassStyleName, setHeight, setModal, setPopupPosition, setPopupPositionAndShow, setPreviewingAllNativeEvents, setTitle, setVisible, setWidget, setWidth, showRelativeTo

Methods inherited from class com.google.gwt.user.client.ui.SimplePanel

getWidget, iterator, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Panel

adopt, clear, doAttachChildren, doDetachChildren, orphan

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

registrationCollector

private final HandlerRegistrationCollector registrationCollector

The HandlerRegistrationCollector or null to ignore HandlerRegistrations.

mainPanel

private final VerticalFlowPanel mainPanel

The main panel.

contentPanel

private final VerticalFlowPanel contentPanel

The content panel.

titleBar

private final HorizontalFlowPanel titleBar

The title panel.

title

private final com.google.gwt.user.client.ui.InlineLabel title

The title label.

closeButton

private final com.google.gwt.user.client.ui.Button closeButton

The button to close the window.

maximizeButton

private final SimpleToggleButton maximizeButton

The button to (un)maximize the window.

buttonPanel

private final ButtonPanel buttonPanel

See Also:

getButtonPanel()

borderWest

private final com.google.gwt.user.client.ui.Widget borderWest

The left border of the window

borderEast

private final com.google.gwt.user.client.ui.Widget borderEast

The right border of the window

borderSouth

private final com.google.gwt.user.client.ui.Widget borderSouth

The bottom border of the window

borderSouthWest

private final com.google.gwt.user.client.ui.Widget borderSouthWest

The bottom left corner of the window

borderSouthEast

private final com.google.gwt.user.client.ui.Widget borderSouthEast

The bottom right corner of the window

borderNorth

private final com.google.gwt.user.client.ui.Widget borderNorth

The top border of the window

borderNorthWest

private final com.google.gwt.user.client.ui.Widget borderNorthWest

The top left corner of the window

borderNorthEast

private final com.google.gwt.user.client.ui.Widget borderNorthEast

The top right corner of the window

resizable

private boolean resizable

See Also:

isResizable()

movable

private boolean movable

See Also:

isMovable()

closable

private boolean closable

See Also:

isClosable()

maximizable

private boolean maximizable

See Also:

isMaximizable()

maximized

private boolean maximized

See Also:

isMaximized()

savedX

private int savedX

The saved X-position to restore after e.g. setMaximized(boolean).

savedY

private int savedY

The saved Y-position to restore after e.g. setMaximized(boolean).

savedWidth

private int savedWidth

The saved width to restore after e.g. setMaximized(boolean).

savedHeight

private int savedHeight

The saved height to restore after e.g. setMaximized(boolean).

focusedElement

private com.google.gwt.dom.client.Element focusedElement

The Element outside the PopupWindow that had the focus before the PopupWindow was shown.

glassPanel

private com.google.gwt.dom.client.Element glassPanel

See Also:

getGlassPanel()

Constructor Detail

PopupWindow

public PopupWindow()

The constructor.

PopupWindow

public PopupWindow(boolean autoHide)

The constructor.

Parameters:

autoHide - - see PopupPanel.setAutoHideEnabled(boolean).

PopupWindow

public PopupWindow(boolean autoHide,
                   boolean modal)

The constructor.

Parameters:

autoHide - - see PopupPanel.setAutoHideEnabled(boolean).

modal - - see PopupPanel.setModal(boolean).

PopupWindow

public PopupWindow(boolean autoHide,
                   boolean modal,
                   HandlerRegistrationCollector registrationCollector)

The constructor.

Parameters:

autoHide - - see PopupPanel.setAutoHideEnabled(boolean).

modal - - see PopupPanel.setModal(boolean).

registrationCollector - the HandlerRegistrationCollector used to collect HandlerRegistrations.

Method Detail

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.

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

doSetResizable

private void doSetResizable(boolean newResizable)

Parameters:

newResizable - - see setResizable(boolean).

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

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

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

getLength

public Length getLength(LengthProperty property)

This method gets the Length for the given LengthProperty of this object.
E.g. the call of getLength(LengthProperty.WIDTH) will return the same result as AttributeReadSize.getWidth(). Unlike AttributeReadSize this method provides access to additional properties such as e.g. LengthProperty.MIN_WIDTH or LengthProperty.MAX_HEIGHT.

Specified by:

getLength in interface AttributeReadLengthProperty

Parameters:

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

Returns:

the requested Length. Will be Length.ZERO if undefined (NOT set).

addMouseHandler

private void addMouseHandler(com.google.gwt.user.client.ui.Widget widget,
                             Direction resizeDirection)

Adds a PopupMouseHandler to the given Widget based on the given Direction.

Parameters:

widget - is the Widget where to add the PopupMouseHandler to.

resizeDirection - is the resize Direction or null for move.

add

public void add(com.google.gwt.user.client.ui.Widget w)

Specified by:

add in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

add in class com.google.gwt.user.client.ui.SimplePanel

add

public void add(com.google.gwt.user.client.ui.IsWidget child)

Specified by:

add in interface com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Overrides:

add in class com.google.gwt.user.client.ui.Panel

remove

public boolean remove(com.google.gwt.user.client.ui.IsWidget child)

Specified by:

remove in interface com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Overrides:

remove in class com.google.gwt.user.client.ui.Panel

remove

public boolean remove(com.google.gwt.user.client.ui.Widget w)

Specified by:

remove in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

remove in class com.google.gwt.user.client.ui.SimplePanel

setTitleText

public void setTitleText(String titleText)

Parameters:

titleText - is the text to be displayed in the title bar of the popup window.

onPreviewNativeEvent

protected void onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent event)

Overrides:

onPreviewNativeEvent in class com.google.gwt.user.client.ui.PopupPanel

getFirstFocusElement

private com.google.gwt.dom.client.Element getFirstFocusElement()

Returns:

the first Element of this popup that is tab-able to get the focus.

getLastFocusElement

private com.google.gwt.dom.client.Element getLastFocusElement()

Returns:

the last Element of this popup that is tab-able to get the focus.

getMainPanel

VerticalFlowPanel getMainPanel()

Returns:

the main panel of this PopupWindow. This panel contains the borders, the title-bar and the content-panel.

getButtonPanel

public ButtonPanel getButtonPanel()

Returns:

the ButtonPanel located at the bottom of the PopupWindow where buttons shall be added.

getContentPanel

public VerticalFlowPanel getContentPanel()

Returns:

the content panel where the content of the popup window should be added to.

getGlassPanel

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

Returns:

the glassPanel

show

public void show()

Overrides:

show in class com.google.gwt.user.client.ui.PopupPanel

hide

public void hide()

Overrides:

hide in class com.google.gwt.user.client.ui.PopupPanel