com.vaadin.terminal.gwt.client.ui.root
Class RootConnector

java.lang.Object
  com.vaadin.terminal.gwt.client.ui.AbstractConnector
      com.vaadin.terminal.gwt.client.ui.AbstractComponentConnector
          com.vaadin.terminal.gwt.client.ui.AbstractComponentContainerConnector
              com.vaadin.terminal.gwt.client.ui.root.RootConnector

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, StateChangeEvent.StateChangeHandler, ComponentConnector, ComponentContainerConnector, Connector, ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler, Paintable, ServerConnector, MayScrollChildren, Serializable

public class RootConnector
extends AbstractComponentContainerConnector
implements Paintable, MayScrollChildren

See Also:

Serialized Form

Field Summary

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

styleNames

Constructor Summary

RootConnector()

Method Summary

protected ComponentConnector	getContent()
RootState	getState() Returns the shared state object for this connector.
List<WindowConnector>	getSubWindows() Return an iterator for current subwindows.
VRoot	getWidget() Returns the widget associated with this paintable.
boolean	hasSubWindow(WindowConnector wc) Deprecated. Should be replaced by a more generic mechanism for getting non-ComponentConnector children
protected void	init() Called when the connector has been initialized.
void	init(String rootPanelId, ApplicationConnection applicationConnection)
protected void	onChildSizeChange()
void	onConnectorHierarchyChange(ConnectorHierarchyChangeEvent event)
void	scrollIntoView(ComponentConnector componentConnector) Tries to scroll the viewport so that the given connector is in view.
void	updateCaption(ComponentConnector component) Update child components caption, description and error message.
void	updateFromUIDL(UIDL uidl, ApplicationConnection client)

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

addConnectorHierarchyChangeHandler, getChildComponents, setChildComponents

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

createWidget, delegateCaptionHandling, getLayoutManager, getTooltipInfo, hasEventListener, isReadOnly, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, onStateChanged, onUnregister, setWidgetEnabled, setWidgetStyleName, setWidgetStyleNameWithPrefix, updateEnabledState, updateWidgetStyleNames

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

addStateChangeHandler, createState, doInit, ensureHandlerManager, fireEvent, getChildren, getConnection, getConnectorId, getParent, getRpcImplementations, isEnabled, registerRpc, 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.terminal.gwt.client.ComponentContainerConnector

addConnectorHierarchyChangeHandler, getChildComponents, setChildComponents

Methods inherited from interface com.vaadin.terminal.gwt.client.ServerConnector

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

Methods inherited from interface com.vaadin.terminal.gwt.client.Connector

getConnectorId

Constructor Detail

RootConnector

public RootConnector()

Method Detail

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 AbstractComponentConnector

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)

Specified by:

updateFromUIDL in interface Paintable

init

public void init(String rootPanelId,
                 ApplicationConnection applicationConnection)

updateCaption

public void updateCaption(ComponentConnector component)

Description copied from interface: ComponentContainerConnector

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 ComponentContainerConnector

Parameters:

component - Child component for which service is requested.

getWidget

public VRoot 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

getContent

protected ComponentConnector getContent()

onChildSizeChange

protected void onChildSizeChange()

hasSubWindow

@Deprecated
public boolean hasSubWindow(WindowConnector wc)

Deprecated. Should be replaced by a more generic mechanism for getting non-ComponentConnector children

Checks if the given sub window is a child of this Root Connector

Parameters:

wc -

Returns:

getSubWindows

public List<WindowConnector> getSubWindows()

Return an iterator for current subwindows. This method is meant for testing purposes only.

Returns:

getState

public RootState 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 Connector

Overrides:

getState in class AbstractComponentConnector

Returns:

the current shared state (never null)

onConnectorHierarchyChange

public void onConnectorHierarchyChange(ConnectorHierarchyChangeEvent event)

Specified by:

onConnectorHierarchyChange in interface ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler

Overrides:

onConnectorHierarchyChange in class AbstractComponentContainerConnector

scrollIntoView

public void scrollIntoView(ComponentConnector componentConnector)

Tries to scroll the viewport so that the given connector is in view.

Parameters:

componentConnector - The connector which should be visible