com.vaadin.client.ui.table.
Class TableConnector
- java.lang.Object
-
- com.vaadin.client.ui.AbstractConnector
-
- com.vaadin.client.ui.AbstractComponentConnector
-
- com.vaadin.client.ui.AbstractFieldConnector
-
- com.vaadin.client.ui.table.TableConnector
-
All Implemented Interfaces:
com.google.gwt.event.shared.EventHandler
,StateChangeEvent.StateChangeHandler
,ComponentConnector
,ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler
,DirectionalManagedLayout
,HasChildMeasurementHintConnector
,HasComponentsConnector
,Paintable
,ServerConnector
,ManagedLayout
,PostLayoutListener
,Connector
,Serializable
Direct Known Subclasses:
public class TableConnector extends AbstractFieldConnector implements HasComponentsConnector, ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler, Paintable, DirectionalManagedLayout, PostLayoutListener, HasChildMeasurementHintConnector
See Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.vaadin.client.HasChildMeasurementHintConnector
HasChildMeasurementHintConnector.ChildMeasurementHint
-
-
Field Summary
-
Fields inherited from class com.vaadin.client.ui.AbstractComponentConnector
SIGNIFICANT_MOVE_THRESHOLD
-
-
Constructor Summary
Constructors Constructor Description TableConnector()
-
Method Summary
All Methods Modifier and Type Method 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.
HasChildMeasurementHintConnector.ChildMeasurementHint
getChildMeasurementHint()
Returns the current child measurement hint value.
protected VScrollTable.VScrollTableBody.VScrollTableRow
getScrollTableRow(com.google.gwt.dom.client.Element e)
TableState
getState()
Returns the shared state object for this connector.
TooltipInfo
getTooltipInfo(com.google.gwt.dom.client.Element element)
Gets the tooltip info for the given element.
VScrollTable
getWidget()
Returns the widget associated with this paintable.
boolean
hasTooltip()
Check whether there might be a tooltip for this component.
protected void
init()
Called when the connector has been initialized.
boolean
isReadOnly()
Checks if the connector is read only.
void
layoutHorizontally()
void
layoutVertically()
void
onConnectorHierarchyChange(ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent)
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.protected void
sendContextClickEvent(MouseEventDetails details, com.google.gwt.dom.client.EventTarget eventTarget)
This method sends the context menu event to the server-side.
void
setChildComponents(List<ComponentConnector> childComponents)
Sets the children for this connector.
void
setChildMeasurementHint(HasChildMeasurementHintConnector.ChildMeasurementHint hint)
Sets the child measurement hint for this component.
void
showSavedContextMenu(VScrollTable.ContextMenuDetails savedContextMenu)
Shows a saved row context menu if the row for the context menu is still visible.
void
updateCaption(ComponentConnector component)
Update child components caption, description and error message.
protected void
updateComponentSize(String newWidth, String newHeight)
Updates the component size, invoking the
layout manager
if necessary.void
updateEnabledState(boolean enabledState)
void
updateFromUIDL(UIDL uidl, ApplicationConnection client)
-
Methods inherited from class com.vaadin.client.ui.AbstractFieldConnector
isModified, isRequired, updateWidgetStyleNames
-
Methods inherited from class com.vaadin.client.ui.AbstractComponentConnector
createWidget, delegateCaptionHandling, flush, getIcon, getIconUri, getLayoutManager, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, onStateChanged, registerTouchHandlers, setWidgetEnabled, setWidgetStyleName, setWidgetStyleNameWithPrefix, shouldHandleLongTap, unregisterTouchHandlers, updateComponentSize, updateWidgetSize
-
Methods inherited from class com.vaadin.client.ui.AbstractConnector
addStateChangeHandler, addStateChangeHandler, createState, doInit, ensureHandlerManager, fireEvent, forceStateChange, getChildren, getConnection, getConnectorId, getParent, getResourceUrl, getRpcImplementations, getRpcProxy, getStateType, hasEventListener, isEnabled, registerRpc, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, 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, 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, hasEventListener, isEnabled, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent
-
-
-
-
Method Detail
-
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 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
-
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:
-
getScrollTableRow
protected VScrollTable.VScrollTableBody.VScrollTableRow getScrollTableRow(com.google.gwt.dom.client.Element e)
-
updateFromUIDL
public void updateFromUIDL(UIDL uidl, ApplicationConnection client)
Specified by:
updateFromUIDL
in interfacePaintable
-
updateEnabledState
public void updateEnabledState(boolean enabledState)
Specified by:
updateEnabledState
in interfaceServerConnector
Overrides:
-
getWidget
public VScrollTable 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 interfaceComponentConnector
Overrides:
getWidget
in classAbstractComponentConnector
Returns:
The widget associated with this paintable
-
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.
-
layoutVertically
public void layoutVertically()
Specified by:
layoutVertically
in interfaceDirectionalManagedLayout
-
layoutHorizontally
public void layoutHorizontally()
Specified by:
layoutHorizontally
in interfaceDirectionalManagedLayout
-
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 interfacePostLayoutListener
-
isReadOnly
public boolean isReadOnly()
Description copied from interface:
ComponentConnector
Checks if the connector is read only.
Specified by:
isReadOnly
in interfaceComponentConnector
Overrides:
isReadOnly
in classAbstractFieldConnector
Returns:
true
-
getState
public TableState 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 classAbstractFieldConnector
Returns:
the current shared state (never null)
-
showSavedContextMenu
public void showSavedContextMenu(VScrollTable.ContextMenuDetails savedContextMenu)
Shows a saved row context menu if the row for the context menu is still visible. Does nothing if a context menu has not been saved.
Parameters:
savedContextMenu
-
-
getTooltipInfo
public TooltipInfo getTooltipInfo(com.google.gwt.dom.client.Element element)
Description copied from interface:
ComponentConnector
Gets the tooltip info for the given element.
When overriding this method,
ComponentConnector.hasTooltip()
should also be overridden to returntrue
in all situations where this method might return a non-empty result.Specified by:
getTooltipInfo
in interfaceComponentConnector
Overrides:
getTooltipInfo
in classAbstractComponentConnector
Parameters:
element
- The element to lookup a tooltip forReturns:
The tooltip for the element or null if no tooltip is defined for this element.
-
hasTooltip
public boolean hasTooltip()
Description copied from interface:
ComponentConnector
Check whether there might be a tooltip for this component. The framework will only add event listeners for automatically handling tooltips (using
ComponentConnector.getTooltipInfo(Element)
) if this method returns true.This is only done to optimize performance, so in cases where the status is not known, it's safer to return
true
so that there will be a tooltip handler even though it might not be needed in all cases.Specified by:
hasTooltip
in interfaceComponentConnector
Overrides:
hasTooltip
in classAbstractComponentConnector
Returns:
true
if some part of the component might have a tooltip, otherwisefalse
-
onConnectorHierarchyChange
public void onConnectorHierarchyChange(ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent)
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:
connectorHierarchyChangeEvent
- the event with information about the hierarchy change
-
updateComponentSize
protected void updateComponentSize(String newWidth, String newHeight)
Description copied from class:
AbstractComponentConnector
Updates the component size, invoking the
layout manager
if necessary.Overrides:
updateComponentSize
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.
-
getChildComponents
public List<ComponentConnector> getChildComponents()
Description copied from interface:
HasComponentsConnector
Returns the child components for this connector.
The children for this connector are defined as all
HasComponents
s whose parent is thisHasComponentsConnector
.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.Specified by:
getChildComponents
in interfaceHasComponentsConnector
Returns:
A collection of child components for this connector. An empty collection if there are no children. Never returns null.
-
setChildComponents
public void setChildComponents(List<ComponentConnector> childComponents)
Description copied from interface:
HasComponentsConnector
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 implementsHasComponentsConnector
.Specified by:
setChildComponents
in interfaceHasComponentsConnector
Parameters:
childComponents
- The new child connectors (components only)
-
addConnectorHierarchyChangeHandler
public com.google.gwt.event.shared.HandlerRegistration addConnectorHierarchyChangeHandler(ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler handler)
Description copied from interface:
HasComponentsConnector
Adds a handler that is called whenever the child hierarchy of this connector has been updated by the server.
Specified by:
addConnectorHierarchyChangeHandler
in interfaceHasComponentsConnector
Parameters:
handler
- The handler that should be added.Returns:
A handler registration reference that can be used to unregister the handler
-
setChildMeasurementHint
public void setChildMeasurementHint(HasChildMeasurementHintConnector.ChildMeasurementHint hint)
Description copied from interface:
HasChildMeasurementHintConnector
Sets the child measurement hint for this component.
Specified by:
setChildMeasurementHint
in interfaceHasChildMeasurementHintConnector
Parameters:
hint
- the value to set
-
getChildMeasurementHint
public HasChildMeasurementHintConnector.ChildMeasurementHint getChildMeasurementHint()
Description copied from interface:
HasChildMeasurementHintConnector
Returns the current child measurement hint value.
Specified by:
getChildMeasurementHint
in interfaceHasChildMeasurementHintConnector
Returns:
a ChildLayoutMeasureMode value
-
-