Package com.vaadin.client.ui.customlayout

Class CustomLayoutConnector

java.lang.Object

com.vaadin.client.ui.AbstractConnector

com.vaadin.client.ui.AbstractComponentConnector

com.vaadin.client.ui.AbstractHasComponentsConnector

com.vaadin.client.ui.AbstractComponentContainerConnector

com.vaadin.client.ui.AbstractLayoutConnector

com.vaadin.client.ui.customlayout.CustomLayoutConnector

All Implemented Interfaces:

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

public class CustomLayoutConnector
extends AbstractLayoutConnector
implements SimpleManagedLayout, Paintable

A connector class for CustomLayout.

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

Method Summary

Modifier and Type	Method	Description
CustomLayoutState	getState()	Returns the shared state object for this connector.
VCustomLayout	getWidget()	Returns the widget associated with this paintable.
protected 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	onStateChanged(StateChangeEvent stateChangeEvent)	Notifies the event handler that the state has changed.
void	updateCaption(ComponentConnector paintable)	Update child components caption, description and error message.
void	updateFromUIDL(UIDL uidl, ApplicationConnection client)

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

addConnectorHierarchyChangeHandler, getChildComponents, setChildComponents

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

createWidget, delegateCaptionHandling, flush, getIcon, getIconUri, getLayoutManager, getTooltipInfo, hasTooltip, isErrorIndicatorVisible, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, onDragSourceAttached, onDragSourceDetached, onDropTargetAttached, onDropTargetDetached, onUnregister, 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

delegateCaptionHandling, 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.ServerConnector

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

Constructor Detail

CustomLayoutConnector

public CustomLayoutConnector()

Method Detail

getState

public CustomLayoutState 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 AbstractLayoutConnector

Returns:

the current shared state (never null)

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

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

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

getWidget

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

updateCaption

public void updateCaption(ComponentConnector paintable)

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:

paintable - Child component for which service is requested.

layout

public void layout()

Specified by:

layout in interface SimpleManagedLayout

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)

Specified by:

updateFromUIDL in interface Paintable