com.vaadin.client.ui.window
Class WindowConnector

java.lang.Object
  com.vaadin.client.ui.AbstractConnector
      com.vaadin.client.ui.AbstractComponentConnector
          com.vaadin.client.ui.AbstractHasComponentsConnector
              com.vaadin.client.ui.AbstractSingleComponentContainerConnector
                  com.vaadin.client.ui.window.WindowConnector

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, StateChangeEvent.StateChangeHandler, ComponentConnector, ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler, HasComponentsConnector, Paintable, ServerConnector, MayScrollChildren, ManagedLayout, PostLayoutListener, ShortcutActionHandler.BeforeShortcutActionListener, SimpleManagedLayout, WindowMoveHandler, com.vaadin.shared.Connector, java.io.Serializable

public class WindowConnector
extends AbstractSingleComponentContainerConnector
implements Paintable, ShortcutActionHandler.BeforeShortcutActionListener, SimpleManagedLayout, PostLayoutListener, MayScrollChildren, WindowMoveHandler

See Also:

Serialized Form

Field Summary

Fields inherited from class com.vaadin.client.ui.AbstractComponentConnector

SIGNIFICANT_MOVE_THRESHOLD

Constructor Summary

WindowConnector()

Method Summary

boolean	delegateCaptionHandling() Return true if parent handles caption, false if the paintable handles the caption itself.
com.vaadin.shared.ui.window.WindowState	getState() Returns the shared state object for this connector.
VWindow	getWidget() Returns the widget associated with this paintable.
boolean	hasTooltip() Check whether there might be a tooltip for this component.
protected void	init() Called when the connector has been initialized.
void	layout()
void	onBeforeShortcutAction(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	onConnectorHierarchyChange(ConnectorHierarchyChangeEvent event)
protected void	onMaximizeRestore()
void	onStateChanged(StateChangeEvent stateChangeEvent) Notifies the event handler that the state has changed.
void	onUnregister() Event called when connector has been unregistered.
void	onWindowMove(WindowMoveEvent event) Called when the VWindow was moved by the user.
void	postLayout() Method invoked by LayoutManager to notify the connector that a layout phase has ended.
void	setWindowOrderAndPosition() Gives the WindowConnector an order number.
void	updateCaption(ComponentConnector component) Update child components caption, description and error message.
protected void	updateComponentSize() Updates the component size based on the shared state, invoking the layout manager if necessary.
void	updateFromUIDL(UIDL uidl, ApplicationConnection client)
protected void	updateWindowMode()
protected void	updateWindowPosition()

Methods inherited from class com.vaadin.client.ui.AbstractSingleComponentContainerConnector

getContent, getContentWidget

Methods inherited from class com.vaadin.client.ui.AbstractHasComponentsConnector

addConnectorHierarchyChangeHandler, getChildComponents, setChildComponents

Methods inherited from class com.vaadin.client.ui.AbstractComponentConnector

createWidget, flush, getIcon, getIconUri, getLayoutManager, getTooltipInfo, isReadOnly, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, registerTouchHandlers, sendContextClickEvent, setWidgetEnabled, setWidgetStyleName, setWidgetStyleNameWithPrefix, shouldHandleLongTap, unregisterTouchHandlers, updateComponentSize, updateEnabledState, updateWidgetSize, updateWidgetStyleNames

Methods inherited from class com.vaadin.client.ui.AbstractConnector

addStateChangeHandler, addStateChangeHandler, createState, doInit, ensureHandlerManager, fireEvent, forceStateChange, getChildren, getConnection, getConnectorId, getParent, getResourceUrl, getRpcImplementations, getRpcProxy, getStateType, hasEventListener, isEnabled, registerRpc, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, unregisterRpc

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.client.ComponentConnector

flush, getLayoutManager, getTooltipInfo, isReadOnly, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, setWidgetEnabled

Methods inherited from interface com.vaadin.client.ServerConnector

addStateChangeHandler, addStateChangeHandler, doInit, fireEvent, getChildren, getConnection, getParent, getRpcImplementations, hasEventListener, isEnabled, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, updateEnabledState

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.client.HasComponentsConnector

addConnectorHierarchyChangeHandler, getChildComponents, setChildComponents

Constructor Detail

WindowConnector

public WindowConnector()

Method Detail

delegateCaptionHandling

public boolean delegateCaptionHandling()

Description copied from interface: ComponentConnector

Return true if parent handles caption, false if the paintable handles the caption itself.

This should always return true and all components should let the parent handle the caption and use other attributes for internal texts in the component

Specified by:

delegateCaptionHandling in interface ComponentConnector

Overrides:

delegateCaptionHandling in class AbstractComponentConnector

Returns:

true if caption handling is delegated to the parent, false if parent should not be allowed to render caption

init

protected void init()

Description copied from class: AbstractConnector

Called when the connector has been initialized. Override this method to perform initialization of the connector.

Overrides:

init in class AbstractConnector

onUnregister

public void onUnregister()

Description copied from interface: ServerConnector

Event called when connector has been unregistered.

Specified by:

onUnregister in interface ServerConnector

Overrides:

onUnregister in class AbstractComponentConnector

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)

Specified by:

updateFromUIDL in interface Paintable

updateCaption

public void updateCaption(ComponentConnector component)

Description copied from interface: HasComponentsConnector

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 HasComponentsConnector

Parameters:

component - Child component for which service is requested.

onBeforeShortcutAction

public void onBeforeShortcutAction(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

getWidget

public VWindow getWidget()

Description copied from class: AbstractComponentConnector

Returns the widget associated with this paintable. The widget returned by this method must not changed during the life time of the paintable.

Specified by:

getWidget in interface ComponentConnector

Overrides:

getWidget in class AbstractComponentConnector

Returns:

The widget associated with this paintable

onConnectorHierarchyChange

public void onConnectorHierarchyChange(ConnectorHierarchyChangeEvent event)

Specified by:

onConnectorHierarchyChange in interface ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler

layout

public void layout()

Specified by:

layout in interface SimpleManagedLayout

postLayout

public void postLayout()

Description copied from interface: PostLayoutListener

Method invoked by LayoutManager to notify the connector that a layout phase has ended. This method can be used to finalize internal layouting, but it is not allowed to change the its own external size or modify the conditions for any children.

Specified by:

postLayout in interface PostLayoutListener

getState

public com.vaadin.shared.ui.window.WindowState getState()

Description copied from class: AbstractConnector

Returns the shared state object for this connector. Override this method to define the shared state type for your connector.

Specified by:

getState in interface ComponentConnector

Specified by:

getState in interface ServerConnector

Overrides:

getState in class AbstractComponentConnector

Returns:

the current shared state (never null)

onStateChanged

public void onStateChanged(StateChangeEvent stateChangeEvent)

Description copied from interface: StateChangeEvent.StateChangeHandler

Notifies the event handler that the state has changed.

Specified by:

onStateChanged in interface StateChangeEvent.StateChangeHandler

Overrides:

onStateChanged in class AbstractComponentConnector

Parameters:

stateChangeEvent - the state change event with details about the change

updateComponentSize

protected void updateComponentSize()

Description copied from class: AbstractComponentConnector

Updates the component size based on the shared state, invoking the layout manager if necessary.

Overrides:

updateComponentSize in class AbstractComponentConnector

updateWindowPosition

protected void updateWindowPosition()

updateWindowMode

protected void updateWindowMode()

onMaximizeRestore

protected void onMaximizeRestore()

setWindowOrderAndPosition

public void setWindowOrderAndPosition()

Gives the WindowConnector an order number. As a side effect, moves the window according to its order number so the windows are stacked. This method should be called for each window in the order they should appear.

hasTooltip

public boolean hasTooltip()

Description copied from interface: ComponentConnector

Check whether there might be a tooltip for this component. The framework will only add event listeners for automatically handling tooltips (using ComponentConnector.getTooltipInfo(Element)) if this method returns true.

This is only done to optimize performance, so in cases where the status is not known, it's safer to return true so that there will be a tooltip handler even though it might not be needed in all cases.

Specified by:

hasTooltip in interface ComponentConnector

Overrides:

hasTooltip in class AbstractComponentConnector

Returns:

true if some part of the component might have a tooltip, otherwise false

onWindowMove

public void onWindowMove(WindowMoveEvent event)

Description copied from interface: WindowMoveHandler

Called when the VWindow was moved by the user.

Specified by:

onWindowMove in interface WindowMoveHandler

Parameters:

event - Contains new coordinates for the VWindow