Package com.vaadin.client.ui.panel

Class PanelConnector

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

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, StateChangeEvent.StateChangeHandler, ComponentConnector, ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler, HasComponentsConnector, HasWidget, Paintable, ServerConnector, HasErrorIndicator, MayScrollChildren, ManagedLayout, PostLayoutListener, SimpleManagedLayout, Connector, Serializable

public class PanelConnector
extends AbstractSingleComponentContainerConnector
implements Paintable, SimpleManagedLayout, PostLayoutListener, MayScrollChildren

A connector class for the Panel component.

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

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

SIGNIFICANT_MOVE_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
PanelConnector()

Method Summary

Modifier and Type	Method	Description
boolean	delegateCaptionHandling()	Return true if parent handles caption, false if the paintable handles the caption itself.
PanelState	getState()	Returns the shared state object for this connector.
VPanel	getWidget()	Returns the widget associated with this paintable.
protected boolean	hasCaption()	Detects if caption div should be visible.
void	init()	Called when the connector has been initialized.
void	layout()
void	onConnectorHierarchyChange(ConnectorHierarchyChangeEvent event)	Called by the framework when the list of child components of the connector implementing this interface has changed.
void	onUnregister()	Event called when connector has been unregistered.
void	postLayout()	Method invoked by LayoutManager to notify the connector that a layout phase has ended.
void	updateCaption(ComponentConnector component)	Update child components caption, description and error message.
void	updateFromUIDL(UIDL uidl, ApplicationConnection client)

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, hasTooltip, isErrorIndicatorVisible, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, onDragSourceAttached, onDragSourceDetached, onDropTargetAttached, onDropTargetDetached, onStateChanged, registerTouchHandlers, sendContextClickEvent, setWidgetEnabled, setWidgetStyleName, setWidgetStyleNameWithPrefix, shouldHandleLongTap, unregisterTouchHandlers, updateComponentSize, 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, getTag, hasEventListener, isEnabled, registerRpc, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, setTag, 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, hasTooltip, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, setWidgetEnabled

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.client.HasComponentsConnector

addConnectorHierarchyChangeHandler, getChildComponents, setChildComponents

Methods inherited from interface com.vaadin.client.ServerConnector

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

Constructor Detail

PanelConnector

public PanelConnector()

Method Detail

init

public 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

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

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)

Specified by:

updateFromUIDL in interface Paintable

hasCaption

protected boolean hasCaption()

Detects if caption div should be visible.

Returns:

true if caption div should be shown

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.

getWidget

public VPanel 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 HasWidget

Overrides:

getWidget in class AbstractComponentConnector

Returns:

The widget associated with this paintable

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

onConnectorHierarchyChange

public void onConnectorHierarchyChange(ConnectorHierarchyChangeEvent event)

Description copied from interface: ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler

Called by the framework when the list of child components of the connector implementing this interface has changed. The implementation is responsible for attaching the widgets of any new children and detaching the widgets of any removed children. Implementations should typically also make sure that the child widgets are attached according to the ordering of the child components.

This method is called after the shared state and hierarchy data (i.e. AbstractHasComponentsConnector.setChildComponents(List)) been updated for all affected connectors, but before updating captions, firing state change events, invoking updateFromUIDL for legacy connectors, invoking RPC and starting the layout phase.

Please note that hierarchy change events are fired in a non-deterministic order when a message from the server causes multiple parts of the hierarchy to change. This means that the old parent connector might not yet have detached a child widget and that the widget of a removed child might already have been attached by its new parent.

Specified by:

onConnectorHierarchyChange in interface ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler

Parameters:

event - the event with information about the hierarchy change