Summary: Methods | [Expand All]
public interface

EditorDelegate

com.google.gwt.editor.client.EditorDelegate<T>
Known Indirect Subclasses

Class Overview

Binds an individual Editor to the backing service. Every Editor has a peer EditorDelegate. If an Editor implements the ValueAwareEditor interface, the EditorDriver will make the delegate available through the setDelegate(EditorDelegate) method.

See Also

Summary

Public Methods
abstract String getPath()
Returns the Editor's path, relative to the root object.
abstract void recordError(String message, Object value, Object userData)
This method should be called from flush() or getValue() to record an error that will be reported to the nearest super-Editor that implements the HasEditorErrors interface.
abstract HandlerRegistration subscribe()
Register for notifications if object being edited is updated.

Public Methods

public abstract String getPath ()

Returns the Editor's path, relative to the root object.

Returns
  • the path as a String

public abstract void recordError (String message, Object value, Object userData)

This method should be called from flush() or getValue() to record an error that will be reported to the nearest super-Editor that implements the HasEditorErrors interface.

Parameters
message a textual description of the error
value the value to be returned by getValue() or null if the value currently associated with the Editor should be used
userData an arbitrary object, possibly null, that can be retrieved with getUserData()

public abstract HandlerRegistration subscribe ()

Register for notifications if object being edited is updated. Not all backends support subscriptions and will return null.

The notification will occur via onPropertyChange(String...) if the backend supports in-place property updates, otherwise updates will be passed via setValue(T).

Returns
  • a HandlerRegistration to unsubscribe from the notifications or null if the delegate does not support subscription