com.vaadin.client

Interface HasComponentsConnector

All Superinterfaces:

Connector, Serializable, ServerConnector

All Known Subinterfaces:

HasChildMeasurementHintConnector, MayScrollChildren

All Known Implementing Classes:

AbsoluteLayoutConnector, AbstractComponentContainerConnector, AbstractHasComponentsConnector, AbstractLayoutConnector, AbstractOrderedLayoutConnector, AbstractSingleComponentContainerConnector, AbstractSplitPanelConnector, AccordionConnector, CompositeConnector, CssLayoutConnector, CustomComponentConnector, CustomFieldConnector, CustomLayoutConnector, DragAndDropWrapperConnector, FormLayoutConnector, GridConnector, GridLayoutConnector, HorizontalLayoutConnector, HorizontalSplitPanelConnector, LoginFormConnector, PanelConnector, PopupViewConnector, TabsheetBaseConnector, TabsheetConnector, TreeGridConnector, UIConnector, VerticalLayoutConnector, VerticalSplitPanelConnector, WindowConnector

public interface HasComponentsConnector
extends ServerConnector

An interface used by client-side connectors whose widget is a component container (implements HasWidgets).

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addConnectorHierarchyChangeHandler(ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler handler) Adds a handler that is called whenever the child hierarchy of this connector has been updated by the server.
List<ComponentConnector>	getChildComponents() Returns the child components for this connector.
void	setChildComponents(List<ComponentConnector> children) Sets the children for this connector.
void	updateCaption(ComponentConnector connector) Update child components caption, description and error message.

Methods inherited from interface com.vaadin.client.ServerConnector

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Method Detail

updateCaption

void updateCaption(ComponentConnector connector)

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.

Parameters:

connector - Child component for which service is requested.

getChildComponents

List<ComponentConnector> getChildComponents()

Returns the child components for this connector.

The children for this connector are defined as all HasComponentss whose parent is this HasComponentsConnector.

Note that the method ServerConnector.getChildren() can return a larger list of children including both the child components and any extensions registered for the connector.

Returns:

A collection of child components for this connector. An empty collection if there are no children. Never returns null.

setChildComponents

void setChildComponents(List<ComponentConnector> children)

Sets the children for this connector. This method should only be called by the framework to ensure that the connector hierarchy on the client side and the server side are in sync.

Note that calling this method does not call ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler.onConnectorHierarchyChange(ConnectorHierarchyChangeEvent) . The event method is called only when the hierarchy has been updated for all connectors.

Note that this method is separate from ServerConnector.setChildren(List) and contains only child components. Both methods are called separately by the framework if the connector implements HasComponentsConnector.

Parameters:

children - The new child connectors (components only)

addConnectorHierarchyChangeHandler

com.google.gwt.event.shared.HandlerRegistration addConnectorHierarchyChangeHandler(ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler handler)

Adds a handler that is called whenever the child hierarchy of this connector has been updated by the server.

Parameters:

handler - The handler that should be added.

Returns:

A handler registration reference that can be used to unregister the handler