com.vaadin.client.ui.gridlayout.
Class GridLayoutConnector
- 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.gridlayout.GridLayoutConnector
-
All Implemented Interfaces:
com.google.gwt.event.shared.EventHandler
,StateChangeEvent.StateChangeHandler
,ComponentConnector
,ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler
,DirectionalManagedLayout
,HasComponentsConnector
,HasWidget
,ServerConnector
,HasErrorIndicator
,ManagedLayout
,Connector
,Serializable
public class GridLayoutConnector extends AbstractComponentContainerConnector implements DirectionalManagedLayout
A connector class for the GridLayout component.
Author:
Vaadin Ltd
See Also:
-
-
Field Summary
-
Fields inherited from class com.vaadin.client.ui.AbstractComponentConnector
SIGNIFICANT_MOVE_THRESHOLD
-
-
Constructor Summary
Constructors Constructor Description GridLayoutConnector()
-
Method Summary
All Methods Modifier and Type Method Description GridLayoutState
getState()
Returns the shared state object for this connector.
VGridLayout
getWidget()
Returns the widget associated with this paintable.
void
init()
Called when the connector has been initialized.
void
layoutHorizontally()
void
layoutVertically()
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
onUnregister()
Event called when connector has been unregistered.
void
updateCaption(ComponentConnector childConnector)
Update child components caption, description and error message.
protected void
updateWidgetSize(String newWidth, String newHeight)
Updates the DOM size of this connector's
widget
.-
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, registerTouchHandlers, sendContextClickEvent, setWidgetEnabled, setWidgetStyleName, setWidgetStyleNameWithPrefix, shouldHandleLongTap, unregisterTouchHandlers, updateComponentSize, updateComponentSize, updateEnabledState, 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, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, setTag, updateEnabledState
-
-
-
-
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 classAbstractConnector
-
onUnregister
public void onUnregister()
Description copied from interface:
ServerConnector
Event called when connector has been unregistered.
Specified by:
onUnregister
in interfaceServerConnector
Overrides:
onUnregister
in classAbstractComponentConnector
-
getState
public GridLayoutState 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)
-
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 interfaceStateChangeEvent.StateChangeHandler
Overrides:
onStateChanged
in classAbstractComponentConnector
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 interfaceConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler
Parameters:
event
- the event with information about the hierarchy change
-
updateCaption
public void updateCaption(ComponentConnector childConnector)
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:
childConnector
- Child component for which service is requested.
-
getWidget
public VGridLayout 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
-
layoutVertically
public void layoutVertically()
Specified by:
layoutVertically
in interfaceDirectionalManagedLayout
-
layoutHorizontally
public void layoutHorizontally()
Specified by:
layoutHorizontally
in interfaceDirectionalManagedLayout
-
updateWidgetSize
protected void updateWidgetSize(String newWidth, String newHeight)
Description copied from class:
AbstractComponentConnector
Updates the DOM size of this connector's
widget
.Overrides:
updateWidgetSize
in classAbstractComponentConnector
Parameters:
newWidth
- The new width as a CSS string. Cannot be null.newHeight
- The new height as a CSS string. Cannot be null.
-
-