com.vaadin.client.ui.composite.
Class CompositeConnector
- java.lang.Object
-
- com.vaadin.client.ui.AbstractConnector
-
- com.vaadin.client.ui.AbstractComponentConnector
-
- com.vaadin.client.ui.AbstractHasComponentsConnector
-
- com.vaadin.client.ui.composite.CompositeConnector
-
All Implemented Interfaces:
com.google.gwt.event.shared.EventHandler
,StateChangeEvent.StateChangeHandler
,ComponentConnector
,ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler
,HasComponentsConnector
,HasWidget
,ServerConnector
,HasErrorIndicator
,ManagedLayout
,SimpleManagedLayout
,Connector
,Serializable
public class CompositeConnector extends AbstractHasComponentsConnector implements SimpleManagedLayout
Connector for the Composite component. Eagerly loaded.
Since:
8.1
Author:
Vaadin Ltd
See Also:
-
-
Field Summary
-
Fields inherited from class com.vaadin.client.ui.AbstractComponentConnector
SIGNIFICANT_MOVE_THRESHOLD
-
-
Constructor Summary
Constructors Constructor Description CompositeConnector()
-
Method Summary
All Methods Modifier and Type Method Description protected com.google.gwt.user.client.ui.Widget
createWidget()
Creates and returns the widget for this VPaintableWidget.
boolean
delegateCaptionHandling()
Return true if parent handles caption, false if the paintable handles the caption itself.
HasComponentsConnector
getParent()
Returns the parent of this connector.
AbstractComponentState
getState()
Returns the shared state object for this connector.
com.google.gwt.user.client.ui.Widget
getWidget()
Returns the widget associated with this paintable.
void
layout()
void
onConnectorHierarchyChange(ConnectorHierarchyChangeEvent event)
Called by the framework when the list of child components of the connector implementing this interface has changed.
protected void
sendContextClickEvent(MouseEventDetails details, com.google.gwt.dom.client.EventTarget eventTarget)
This method sends the context menu event to the server-side.
void
updateCaption(ComponentConnector component)
Update child components caption, description and error message.
-
Methods inherited from class com.vaadin.client.ui.AbstractHasComponentsConnector
addConnectorHierarchyChangeHandler, getChildComponents, setChildComponents
-
Methods inherited from class com.vaadin.client.ui.AbstractComponentConnector
flush, getIcon, getIconUri, getLayoutManager, getTooltipInfo, hasTooltip, isErrorIndicatorVisible, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, onDragSourceAttached, onDragSourceDetached, onDropTargetAttached, onDropTargetDetached, onStateChanged, onUnregister, registerTouchHandlers, 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, getResourceUrl, getRpcImplementations, getRpcProxy, getStateType, getTag, hasEventListener, init, 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.ServerConnector
addStateChangeHandler, addStateChangeHandler, doInit, fireEvent, getChildren, getConnection, getRpcImplementations, getTag, hasEventListener, isEnabled, onUnregister, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, setTag, updateEnabledState
-
-
-
-
Method Detail
-
createWidget
protected com.google.gwt.user.client.ui.Widget createWidget()
Description copied from class:
AbstractComponentConnector
Creates and returns the widget for this VPaintableWidget. This method should only be called once when initializing the paintable.
You should typically not override this method since the framework by default generates an implementation that uses
GWT.create(Class)
to create a widget of the same type as returned by the most specific override ofAbstractComponentConnector.getWidget()
. If you do override the method, you can't callsuper.createWidget()
since the metadata needed for that implementation is not generated if there's an override of the method.Overrides:
createWidget
in classAbstractComponentConnector
Returns:
a new widget instance to use for this component connector
-
getWidget
public com.google.gwt.user.client.ui.Widget 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 interfaceHasWidget
Overrides:
getWidget
in classAbstractComponentConnector
Returns:
The widget associated with this paintable
-
getParent
public HasComponentsConnector getParent()
Description copied from interface:
ServerConnector
Returns the parent of this connector. Can be null for only the root connector.
Specified by:
getParent
in interfaceConnector
Specified by:
getParent
in interfaceServerConnector
Overrides:
getParent
in classAbstractConnector
Returns:
The parent of this connector, as set by
ServerConnector.setParent(ServerConnector)
.
-
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 interfaceHasComponentsConnector
Parameters:
component
- Child component for which service is requested.
-
getState
public AbstractComponentState 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 interfaceComponentConnector
Specified by:
getState
in interfaceServerConnector
Overrides:
getState
in classAbstractComponentConnector
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 interfaceConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler
Parameters:
event
- the event with information about the hierarchy change
-
sendContextClickEvent
protected void sendContextClickEvent(MouseEventDetails details, com.google.gwt.dom.client.EventTarget eventTarget)
Description copied from class:
AbstractComponentConnector
This method sends the context menu event to the server-side. Can be overridden to provide extra information through an alternative RPC interface.
Overrides:
sendContextClickEvent
in classAbstractComponentConnector
Parameters:
details
- the mouse event detailseventTarget
- the target of the event
-
layout
public void layout()
Specified by:
layout
in interfaceSimpleManagedLayout
-
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 interfaceComponentConnector
Overrides:
delegateCaptionHandling
in classAbstractComponentConnector
Returns:
true if caption handling is delegated to the parent, false if parent should not be allowed to render caption
-
-