com.vaadin.client.ui.orderedlayout
Class AbstractOrderedLayoutConnector

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.AbstractLayoutConnector
                      com.vaadin.client.ui.orderedlayout.AbstractOrderedLayoutConnector

All Implemented Interfaces:

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

Direct Known Subclasses:

HorizontalLayoutConnector, VerticalLayoutConnector

public abstract class AbstractOrderedLayoutConnector
extends AbstractLayoutConnector

Base class for vertical and horizontal ordered layouts

See Also:

Serialized Form

Constructor Summary

AbstractOrderedLayoutConnector()

Method Summary

com.vaadin.shared.ui.orderedlayout.AbstractOrderedLayoutState	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.
VAbstractOrderedLayout	getWidget() Returns the widget associated with this paintable.
boolean	hasTooltip() Check whether there might be a tooltip for this component.
void	init() Called when the connector has been initialized.
void	onConnectorHierarchyChange(ConnectorHierarchyChangeEvent event)
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 connector) 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

createWidget, delegateCaptionHandling, flush, getIcon, getIconUri, getLayoutManager, isReadOnly, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, 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, updateEnabledState

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

AbstractOrderedLayoutConnector

public AbstractOrderedLayoutConnector()

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 class AbstractConnector

getState

public com.vaadin.shared.ui.orderedlayout.AbstractOrderedLayoutState 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 AbstractLayoutConnector

Returns:

the current shared state (never null)

getWidget

public VAbstractOrderedLayout 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 connector)

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.

Parameters:

connector - Child component for which service is requested.

onConnectorHierarchyChange

public void onConnectorHierarchyChange(ConnectorHierarchyChangeEvent event)

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

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

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