com.vaadin.terminal.gwt.client
Interface ComponentConnector

All Superinterfaces:

Connector, Serializable, ServerConnector

All Known Subinterfaces:

ComponentContainerConnector, DirectionalManagedLayout, ManagedLayout, MayScrollChildren, ShortcutActionHandler.BeforeShortcutActionListener, SimpleManagedLayout

All Known Implementing Classes:

AbsoluteLayoutConnector, AbstractComponentConnector, AbstractComponentContainerConnector, AbstractDateFieldConnector, AbstractFieldConnector, AbstractLayoutConnector, AbstractOrderedLayoutConnector, AbstractSplitPanelConnector, AccordionConnector, AudioConnector, ButtonConnector, CheckBoxConnector, ComboBoxConnector, CssLayoutConnector, CustomComponentConnector, CustomFieldConnector, CustomLayoutConnector, DragAndDropWrapperConnector, EmbeddedConnector, FormConnector, FormLayoutConnector, GridLayoutConnector, HorizontalLayoutConnector, HorizontalSplitPanelConnector, InlineDateFieldConnector, LabelConnector, LinkConnector, ListSelectConnector, MediaBaseConnector, MenuBarConnector, NativeButtonConnector, NativeSelectConnector, OptionGroupBaseConnector, OptionGroupConnector, PanelConnector, PasswordFieldConnector, PopupDateFieldConnector, PopupViewConnector, ProgressIndicatorConnector, RichTextAreaConnector, RootConnector, SliderConnector, TableConnector, TabsheetBaseConnector, TabsheetConnector, TextAreaConnector, TextFieldConnector, TextualDateConnector, TreeConnector, TreeTableConnector, TwinColSelectConnector, UnknownComponentConnector, UploadConnector, Vaadin6Connector, VerticalLayoutConnector, VerticalSplitPanelConnector, VideoConnector, WindowConnector

public interface ComponentConnector
extends ServerConnector

An interface used by client-side widgets or paintable parts to receive updates from the corresponding server-side components in the form of UIDL. Updates can be sent back to the server using the ApplicationConnection#updateVariable() methods.

Method Summary

boolean	delegateCaptionHandling() Return true if parent handles caption, false if the paintable handles the caption itself.
LayoutManager	getLayoutManager()
ComponentContainerConnector	getParent() Returns the parent of this connector.
ComponentState	getState() Gets the current shared state of the connector.
com.google.gwt.user.client.ui.Widget	getWidget() Returns the widget for this ComponentConnector
boolean	hasEventListener(String eventIdentifier)
boolean	isReadOnly() Deprecated. This belongs in AbstractFieldConnector, see #8514
boolean	isRelativeHeight() Returns true if the height of this paintable is currently relative.
boolean	isRelativeWidth() Returns true if the width of this paintable is currently relative.
boolean	isUndefinedHeight() Returns true if the height of this paintable is currently undefined.
boolean	isUndefinedWidth() Returns true if the width of this paintable is currently undefined.
void	setParent(ComponentContainerConnector parent) Sets the parent for this connector.
void	setWidgetEnabled(boolean widgetEnabled) Sets the enabled state of the widget associated to this connector.

Methods inherited from interface com.vaadin.terminal.gwt.client.ServerConnector

addStateChangeHandler, doInit, fireEvent, getConnection, getRpcImplementations, isEnabled, onUnregister, setState

Methods inherited from interface com.vaadin.terminal.gwt.client.Connector

getConnectorId

Method Detail

getState

ComponentState getState()

Description copied from interface: Connector

Gets the current shared state of the connector.

Specified by:

getState in interface Connector

Returns:

state The shared state object. Can be any sub type of SharedState. Never null.

getWidget

com.google.gwt.user.client.ui.Widget getWidget()

Returns the widget for this ComponentConnector

getLayoutManager

LayoutManager getLayoutManager()

isUndefinedWidth

boolean isUndefinedWidth()

Returns true if the width of this paintable is currently undefined. If the width is undefined, the actual width of the paintable is defined by its contents.

Returns:

true if the width is undefined, else false

isUndefinedHeight

boolean isUndefinedHeight()

Returns true if the height of this paintable is currently undefined. If the height is undefined, the actual height of the paintable is defined by its contents.

Returns:

true if the height is undefined, else false

isRelativeWidth

boolean isRelativeWidth()

Returns true if the width of this paintable is currently relative. If the width is relative, the actual width of the paintable is a percentage of the size allocated to it by its parent.

Returns:

true if the width is undefined, else false

isRelativeHeight

boolean isRelativeHeight()

Returns true if the height of this paintable is currently relative. If the height is relative, the actual height of the paintable is a percentage of the size allocated to it by its parent.

Returns:

true if the width is undefined, else false

getParent

ComponentContainerConnector getParent()

Returns the parent of this connector. Can be null for only the root connector.

Returns:

The parent of this connector, as set by setParent(ComponentContainerConnector).

setParent

void setParent(ComponentContainerConnector parent)

Sets the parent 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 fire a ConnectorHierarchyChangeEvent. The event is fired only when the whole hierarchy has been updated.

Parameters:

parent - The new parent of the connector

isReadOnly

@Deprecated
boolean isReadOnly()

Deprecated. This belongs in AbstractFieldConnector, see #8514

Checks if the connector is read only.

Returns:

true

hasEventListener

boolean hasEventListener(String eventIdentifier)

delegateCaptionHandling

boolean delegateCaptionHandling()

Return true if parent handles caption, false if the paintable handles the caption itself.

This should always return true and all components should let the parent handle the caption and use other attributes for internal texts in the component

Returns:

true if caption handling is delegated to the parent, false if parent should not be allowed to render caption

setWidgetEnabled

void setWidgetEnabled(boolean widgetEnabled)

Sets the enabled state of the widget associated to this connector.

Parameters:

widgetEnabled - true if the widget should be enabled, false otherwise