Eclipse Rich Ajax Platform

org.eclipse.rwt.lifecycle
Interface IWidgetAdapter


public interface IWidgetAdapter

Instances of this interface provide RWT specific operations on widgets. They are used to preserve the state of a widget.

This interface is not intended to be implemented by clients.

Since:
1.0

Method Summary
 java.lang.String getId()
          Returns the id that identifies the widget on the client.
 java.lang.Object getPreserved(java.lang.String propertyName)
          Returns the preserved value for a specified key.
 boolean isInitialized()
          Indicates whether this widget has been initialized already.
 void markDisposed(Widget widget)
          Notifies the receiver that the given widget has beend disposed of.
 void preserve(java.lang.String propertyName, java.lang.Object value)
          Preserves a specified value for a specified key.
 

Method Detail

getId

java.lang.String getId()
Returns the id that identifies the widget on the client.

Returns:
the widget id

isInitialized

boolean isInitialized()
Indicates whether this widget has been initialized already. A widget is considered initialized when the response that creates and initializes the widget has been rendered.

Returns:
true if this widget has already been initialized, false otherwise

preserve

void preserve(java.lang.String propertyName,
              java.lang.Object value)
Preserves a specified value for a specified key. Used to preserve values in the LCA method preserveValues.

Parameters:
propertyName - the key to map the preserved value to
value - the value to preserve

getPreserved

java.lang.Object getPreserved(java.lang.String propertyName)
Returns the preserved value for a specified key.

Parameters:
propertyName - the key for the preserved value
Returns:
the preserved value or null if there is no value preserved for this key

markDisposed

void markDisposed(Widget widget)
Notifies the receiver that the given widget has beend disposed of.

Parameters:
widget - the widget that has been disposed of
Since:
1.2

Eclipse Rich Ajax Platform

Copyright (c) EclipseSource and others 2002, 2012. All rights reserved.