com.vaadin.terminal.gwt.client.ui
Class VWindow

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
                      com.vaadin.terminal.gwt.client.ui.VOverlay
                          com.vaadin.terminal.gwt.client.ui.VWindow

All Implemented Interfaces:

com.google.gwt.event.dom.client.BlurHandler, com.google.gwt.event.dom.client.FocusHandler, com.google.gwt.event.dom.client.KeyDownHandler, com.google.gwt.event.dom.client.ScrollHandler, com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel>, 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.EventHandler, 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.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesPopupEvents, Container, Focusable, Paintable, ShortcutActionHandler.BeforeShortcutActionListener, ShortcutActionHandler.ShortcutActionHandlerOwner, Iterable<com.google.gwt.user.client.ui.Widget>

public class VWindow
extends VOverlay
implements Container, ShortcutActionHandler.ShortcutActionHandlerOwner, com.google.gwt.event.dom.client.ScrollHandler, com.google.gwt.event.dom.client.KeyDownHandler, com.google.gwt.event.dom.client.FocusHandler, com.google.gwt.event.dom.client.BlurHandler, ShortcutActionHandler.BeforeShortcutActionListener, Focusable

"Sub window" component.

Author:

Vaadin Ltd

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.terminal.gwt.client.ui.VOverlay

VOverlay.PositionAndSize, VOverlay.ResizeAnimation

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

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

static String	CLASSNAME
protected ApplicationConnection	client
static int	Z_INDEX

Fields inherited from class com.vaadin.terminal.gwt.client.ui.VOverlay

CLASSNAME_SHADOW

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

DEBUG_ID_PREFIX

Constructor Summary

VWindow()

Method Summary

void	addStyleDependentName(String styleSuffix)
void	bringToFront()
protected void	constructDOM()
void	focus() Sets focus to this widget.
RenderSpace	getAllocatedSpace(com.google.gwt.user.client.ui.Widget child) Returns the size currently allocated for the child component.
protected com.google.gwt.user.client.Element	getContainerElement()
protected com.google.gwt.user.client.Element	getModalityCurtain()
ShortcutActionHandler	getShortcutActionHandler() Returns the ShortCutActionHandler currently used or null if there is currently no shortcutactionhandler
boolean	hasChildComponent(com.google.gwt.user.client.ui.Widget component) Is a given component child of this layout.
void	hide()
protected boolean	isClosable() Returns the closable state of the sub window.
protected void	onAttach()
void	onBeforeShortcutAction(com.google.gwt.user.client.Event e) This method is called by ShortcutActionHandler before firing the shortcut if the Paintable is currently focused (aka the target of the shortcut action).
void	onBlur(com.google.gwt.event.dom.client.BlurEvent event)
void	onBrowserEvent(com.google.gwt.user.client.Event event)
boolean	onEventPreview(com.google.gwt.user.client.Event event)
void	onFocus(com.google.gwt.event.dom.client.FocusEvent event)
void	onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)
protected void	onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent event) fix for #5495, #5497 taken from GWT issue https://code.google.com/p/google-web-toolkit/issues/detail?id=5263
void	onScroll(com.google.gwt.event.dom.client.ScrollEvent event)
void	replaceChildComponent(com.google.gwt.user.client.ui.Widget oldComponent, com.google.gwt.user.client.ui.Widget newComponent) Replace child of this layout with another component.
boolean	requestLayout(Set<Paintable> child) Called when a child components size has been updated in the rendering phase.
void	setCaption(String c)
void	setCaption(String c, String icon)
protected void	setClosable(boolean closable) Sets the closable state of the window.
void	setHeight(String height)
void	setPopupPosition(int left, int top)
void	setVisible(boolean visible)
void	setWidth(String width)
protected void	setZIndex(int zIndex) Set the z-index (visual stack position) for this overlay.
void	show()
void	updateCaption(Paintable component, UIDL uidl) Update child components caption, description and error message.
void	updateFromUIDL(UIDL uidl, ApplicationConnection client)

Methods inherited from class com.vaadin.terminal.gwt.client.ui.VOverlay

hide, isShadowEnabled, isSinkShadowEvents, needsShimElement, onClose, onDetach, positionOrSizeUpdated, setShadowEnabled, setShadowStyle, setSinkShadowEvents, sinkEvents, updateShadowSizeAndPosition

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

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

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

add, getWidget, iterator, remove, setWidget

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

add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove

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, onLoad, removeFromParent, setLayoutData

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.user.client.ui.HasWidgets

add, clear, iterator, remove

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

fireEvent

Field Detail

CLASSNAME

public static final String CLASSNAME

See Also:

Constant Field Values

Z_INDEX

public static final int Z_INDEX

See Also:

Constant Field Values

client

protected ApplicationConnection client

Constructor Detail

VWindow

public VWindow()

Method Detail

bringToFront

public void bringToFront()

setZIndex

protected void setZIndex(int zIndex)

Description copied from class: VOverlay

Set the z-index (visual stack position) for this overlay.

Overrides:

setZIndex in class VOverlay

Parameters:

zIndex - The new z-index

getModalityCurtain

protected com.google.gwt.user.client.Element getModalityCurtain()

constructDOM

protected void constructDOM()

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)

Specified by:

updateFromUIDL in interface Paintable

setVisible

public void setVisible(boolean visible)

Overrides:

setVisible in class VOverlay

setClosable

protected void setClosable(boolean closable)

Sets the closable state of the window. Additionally hides/shows the close button according to the new state.

Parameters:

closable - true if the window can be closed by the user

isClosable

protected boolean isClosable()

Returns the closable state of the sub window. If the sub window is closable a decoration (typically an X) is shown to the user. By clicking on the X the user can close the window.

Returns:

true if the sub window is closable

show

public void show()

Overrides:

show in class VOverlay

hide

public void hide()

Overrides:

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

setPopupPosition

public void setPopupPosition(int left,
                             int top)

Overrides:

setPopupPosition in class VOverlay

setCaption

public void setCaption(String c)

setCaption

public void setCaption(String c,
                       String icon)

getContainerElement

protected com.google.gwt.user.client.Element getContainerElement()

Overrides:

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

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.Widget

setWidth

public void setWidth(String width)

Overrides:

setWidth in class VOverlay

setHeight

public void setHeight(String height)

Overrides:

setHeight in class VOverlay

onEventPreview

public boolean onEventPreview(com.google.gwt.user.client.Event event)

Specified by:

onEventPreview in interface com.google.gwt.user.client.EventPreview

Overrides:

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

addStyleDependentName

public void addStyleDependentName(String styleSuffix)

Overrides:

addStyleDependentName in class com.google.gwt.user.client.ui.UIObject

onAttach

protected void onAttach()

Overrides:

onAttach in class com.google.gwt.user.client.ui.Widget

getAllocatedSpace

public RenderSpace getAllocatedSpace(com.google.gwt.user.client.ui.Widget child)

Description copied from interface: Container

Returns the size currently allocated for the child component.

Specified by:

getAllocatedSpace in interface Container

Returns:

hasChildComponent

public boolean hasChildComponent(com.google.gwt.user.client.ui.Widget component)

Description copied from interface: Container

Is a given component child of this layout.

Specified by:

hasChildComponent in interface Container

Parameters:

component - Component to test.

Returns:

true iff component is a child of this layout.

replaceChildComponent

public void replaceChildComponent(com.google.gwt.user.client.ui.Widget oldComponent,
                                  com.google.gwt.user.client.ui.Widget newComponent)

Description copied from interface: Container

Replace child of this layout with another component. Each layout must be able to switch children. To to this, one must just give references to a current and new child.

Specified by:

replaceChildComponent in interface Container

Parameters:

oldComponent - Child to be replaced

newComponent - Child that replaces the oldComponent

requestLayout

public boolean requestLayout(Set<Paintable> child)

Description copied from interface: Container

Called when a child components size has been updated in the rendering phase.

Specified by:

requestLayout in interface Container

Parameters:

child - Set of child widgets whose size have changed

Returns:

true if the size of the Container remains the same, false if the event need to be propagated to the Containers parent

updateCaption

public void updateCaption(Paintable component,
                          UIDL uidl)

Description copied from interface: Container

Update child components caption, description and error message.

Each component is responsible for maintaining its caption, description and error message. In most cases components doesn't want to do that and those elements reside outside of the component. Because of this layouts must provide service for it's childen to show those elements for them.

Specified by:

updateCaption in interface Container

Parameters:

component - Child component for which service is requested.

uidl - UIDL of the child component.

getShortcutActionHandler

public ShortcutActionHandler getShortcutActionHandler()

Description copied from interface: ShortcutActionHandler.ShortcutActionHandlerOwner

Returns the ShortCutActionHandler currently used or null if there is currently no shortcutactionhandler

Specified by:

getShortcutActionHandler in interface ShortcutActionHandler.ShortcutActionHandlerOwner

onScroll

public void onScroll(com.google.gwt.event.dom.client.ScrollEvent event)

Specified by:

onScroll in interface com.google.gwt.event.dom.client.ScrollHandler

onKeyDown

public void onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)

Specified by:

onKeyDown in interface com.google.gwt.event.dom.client.KeyDownHandler

onBlur

public void onBlur(com.google.gwt.event.dom.client.BlurEvent event)

Specified by:

onBlur in interface com.google.gwt.event.dom.client.BlurHandler

onFocus

public void onFocus(com.google.gwt.event.dom.client.FocusEvent event)

Specified by:

onFocus in interface com.google.gwt.event.dom.client.FocusHandler

onBeforeShortcutAction

public void onBeforeShortcutAction(com.google.gwt.user.client.Event e)

Description copied from interface: ShortcutActionHandler.BeforeShortcutActionListener

This method is called by ShortcutActionHandler before firing the shortcut if the Paintable is currently focused (aka the target of the shortcut action). Eg. a field can update its possibly changed value to the server before shortcut action is fired.

Specified by:

onBeforeShortcutAction in interface ShortcutActionHandler.BeforeShortcutActionListener

Parameters:

e - the event that triggered the shortcut action

focus

public void focus()

Description copied from interface: Focusable

Sets focus to this widget.

Specified by:

focus in interface Focusable

onPreviewNativeEvent

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

fix for #5495, #5497 taken from GWT issue https://code.google.com/p/google-web-toolkit/issues/detail?id=5263

Overrides:

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