com.vaadin.terminal.gwt.client.communication
Class SharedState

java.lang.Object
  com.vaadin.terminal.gwt.client.communication.SharedState

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ComponentState, JavaScriptExtensionState, JavaScriptManagerState

public class SharedState
extends Object
implements Serializable

Interface to be implemented by all shared state classes used to communicate basic information about a Connector from server to client. Shared state classes have to be declared in client side packages to be accessible both for server and client code. They can be static nested classes of a ServerConnector. Shared state objects are only sent from the server to the client, and any modifications from the client should be performed via an RPC call that modifies the authoritative state on the server. A shared state class should be a bean with getters and setters for each field. Supported data types are simple Java types, other beans and maps and arrays of these. On the client side the connector should override AbstractConnector.createState() to create the correct state class and AbstractComponentConnector.getState() override the return type. Subclasses of a Connector using shared state should also provide a subclass of the shared state class of the parent class to extend the state. A single Connector can only have one shared state object.

Since:

7.0

See Also:

Serialized Form

Constructor Summary

SharedState()

Method Summary

boolean	isEnabled() Returns true if the component is enabled.
void	setEnabled(boolean enabled) Enables or disables the component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SharedState

public SharedState()

Method Detail

isEnabled

public boolean isEnabled()

Returns true if the component is enabled.

Returns:

true if the component is enabled

See Also:

Component.isEnabled()

setEnabled

public void setEnabled(boolean enabled)

Enables or disables the component.

Parameters:

enabled - new mode for the component

See Also:

Component.setEnabled(boolean)