com.vaadin.client.ui.table
Class TableConnector

java.lang.Object
  extended by com.vaadin.client.ui.AbstractConnector
      extended by com.vaadin.client.ui.AbstractComponentConnector
          extended by com.vaadin.client.ui.AbstractHasComponentsConnector
              extended by com.vaadin.client.ui.table.TableConnector
All Implemented Interfaces:
com.google.gwt.event.shared.EventHandler, StateChangeEvent.StateChangeHandler, ComponentConnector, ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler, DirectionalManagedLayout, HasComponentsConnector, Paintable, ServerConnector, ManagedLayout, PostLayoutListener, com.vaadin.shared.Connector, java.io.Serializable
Direct Known Subclasses:
TreeTableConnector

public class TableConnector
extends AbstractHasComponentsConnector
implements Paintable, DirectionalManagedLayout, PostLayoutListener

See Also:
Serialized Form

Constructor Summary
TableConnector()
           
 
Method Summary
 com.vaadin.shared.ui.table.TableState getState()
          Returns the shared state object for this connector.
 TooltipInfo getTooltipInfo(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)
           
 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.
 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(java.lang.String newWidth, java.lang.String newHeight)
          Updates the component size, invoking the layout manager if necessary.
 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, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, onStateChanged, setWidgetEnabled, setWidgetStyleName, setWidgetStyleNameWithPrefix, 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, 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.client.ServerConnector
addStateChangeHandler, addStateChangeHandler, doInit, fireEvent, getChildren, getConnection, getParent, getRpcImplementations, hasEventListener, isEnabled, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, updateEnabledState
 
Methods inherited from interface com.vaadin.shared.Connector
getConnectorId
 

Constructor Detail

TableConnector

public TableConnector()
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 class AbstractConnector

onUnregister

public void onUnregister()
Description copied from interface: ServerConnector
Event called when connector has been unregistered.

Specified by:
onUnregister in interface ServerConnector
Overrides:
onUnregister in class AbstractComponentConnector

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)
Specified by:
updateFromUIDL in interface Paintable

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 interface ComponentConnector
Overrides:
getWidget in class AbstractComponentConnector
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 interface HasComponentsConnector
Parameters:
component - Child component for which service is requested.

layoutVertically

public void layoutVertically()
Specified by:
layoutVertically in interface DirectionalManagedLayout

layoutHorizontally

public void layoutHorizontally()
Specified by:
layoutHorizontally in interface DirectionalManagedLayout

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 interface PostLayoutListener

isReadOnly

public boolean isReadOnly()
Description copied from interface: ComponentConnector
Checks if the connector is read only.

Specified by:
isReadOnly in interface ComponentConnector
Overrides:
isReadOnly in class AbstractComponentConnector
Returns:
true

getState

public com.vaadin.shared.ui.table.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 interface ComponentConnector
Specified by:
getState in interface ServerConnector
Overrides:
getState in class AbstractComponentConnector
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(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 return true in all situations where this method might return a non-empty result.

Specified by:
getTooltipInfo in interface ComponentConnector
Overrides:
getTooltipInfo in class AbstractComponentConnector
Parameters:
element - The element to lookup a tooltip for
Returns:
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 interface ComponentConnector
Overrides:
hasTooltip in class AbstractComponentConnector
Returns:
true if some part of the component might have a tooltip, otherwise false

onConnectorHierarchyChange

public void onConnectorHierarchyChange(ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent)
Specified by:
onConnectorHierarchyChange in interface ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler

updateComponentSize

protected void updateComponentSize(java.lang.String newWidth,
                                   java.lang.String newHeight)
Description copied from class: AbstractComponentConnector
Updates the component size, invoking the layout manager if necessary.

Overrides:
updateComponentSize in class AbstractComponentConnector
Parameters:
newWidth - The new width as a CSS string. Cannot be null.
newHeight - The new height as a CSS string. Cannot be null.


Copyright © 2000-2014 Vaadin Ltd. All Rights Reserved.