com.vaadin.client.ui.tree
Class TreeConnector

java.lang.Object
  com.vaadin.client.ui.AbstractConnector
      com.vaadin.client.ui.AbstractComponentConnector
          com.vaadin.client.ui.tree.TreeConnector

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, StateChangeEvent.StateChangeHandler, ComponentConnector, Paintable, ServerConnector, com.vaadin.shared.Connector, java.io.Serializable

public class TreeConnector
extends AbstractComponentConnector
implements Paintable

See Also:

Serialized Form

Field Summary

protected java.util.Map<VTree.TreeNode,TooltipInfo>

tooltipMap

Constructor Summary

TreeConnector()

Method Summary

com.vaadin.shared.ui.tree.TreeState	getState() Returns the shared state object for this connector.
TooltipInfo	getTooltipInfo(Element element) Gets the tooltip info for the given element.
VTree	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	onStateChanged(StateChangeEvent stateChangeEvent) Notifies the event handler that the state has changed.
void	updateFromUIDL(UIDL uidl, ApplicationConnection client)
void	updateNodeFromUIDL(VTree.TreeNode treeNode, UIDL uidl, int level)

Methods inherited from class com.vaadin.client.ui.AbstractComponentConnector

createWidget, delegateCaptionHandling, flush, getIcon, getIconUri, getLayoutManager, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, onUnregister, setWidgetEnabled, setWidgetStyleName, setWidgetStyleNameWithPrefix, updateComponentSize, 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.ServerConnector

addStateChangeHandler, addStateChangeHandler, doInit, fireEvent, getChildren, getConnection, getParent, getRpcImplementations, hasEventListener, isEnabled, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Field Detail

tooltipMap

protected final java.util.Map<VTree.TreeNode,TooltipInfo> tooltipMap

Constructor Detail

TreeConnector

public TreeConnector()

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

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)

Specified by:

updateFromUIDL in interface Paintable

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 interface StateChangeEvent.StateChangeHandler

Overrides:

onStateChanged in class AbstractComponentConnector

Parameters:

stateChangeEvent - the state change event with details about the change

getWidget

public VTree 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

updateNodeFromUIDL

public void updateNodeFromUIDL(VTree.TreeNode treeNode,
                               UIDL uidl,
                               int level)

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.tree.TreeState 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)

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