com.google.gwt.editor.client.impl

Class AbstractEditorDelegate<T,E extends Editor<T>>

java.lang.Object

com.google.gwt.editor.client.impl.AbstractEditorDelegate<T,E>

Type Parameters:

T - the type of object being edited

E - the type of editor

All Implemented Interfaces:

EditorDelegate<T>

Direct Known Subclasses:

SimpleBeanEditorDelegate

public abstract class AbstractEditorDelegate<T,E extends Editor<T>>
extends Object
implements EditorDelegate<T>

A base implementation of EditorDelegate for use by generated types.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractEditorDelegate.Chain<R,S extends Editor<R>> The machinery for attaching and detaching editors from the hierarchy via a CompositeEditor.

Constructor Summary

Constructors

Constructor and Description
AbstractEditorDelegate()

Method Summary

Modifier and Type	Method and Description
abstract void	accept(EditorVisitor visitor)
protected <R,S extends Editor<R>> void	addSubDelegate(AbstractEditorDelegate<R,S> subDelegate, String path, S subEditor) Initialize a sub-delegate whenever one is added to the editor hierarchy.
protected String	appendPath(String path)
protected static String	appendPath(String prefix, String path)
protected <R,S extends Editor<R>> void	createChain(Class<R> composedElementType)
protected AbstractEditorDelegate<?,?>	createComposedDelegate() Only implemented by delegates for a CompositeEditor.
protected EditorVisitor	createInitializerVisitor()
protected <Q> Q	ensureMutable(Q object)
protected abstract E	getEditor()
protected AbstractEditorDelegate.Chain<?,?>	getEditorChain()
protected List<EditorError>	getErrors()
abstract T	getObject()
String	getPath() Returns the Editor's path, relative to the root object.
protected void	initialize(String pathSoFar, E editor)
protected abstract void	initializeSubDelegates()
boolean	isDirty() Just returns the last value passed to setDirty(boolean).
void	recordError(String message, Object value, Object userData) This method should be called from ValueAwareEditor.flush() or TakesValue.getValue() to record an error that will be reported to the nearest super-Editor that implements the HasEditorErrors interface.
void	recordError(String message, Object value, Object userData, String extraPath, Editor<?> leafEditor)
void	setDirty(boolean dirty) Toggle the dirty-state flag for the Editor.
protected abstract void	setEditor(E editor)
protected abstract void	setObject(T object)
protected boolean	shouldFlush() Indicates whether or not calls to #flush are expected as part of normal operation.
abstract HandlerRegistration	subscribe() Register for notifications if object being edited is updated.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

AbstractEditorDelegate

public AbstractEditorDelegate()

Method Detail

appendPath

protected static String appendPath(String prefix,
                                   String path)

accept

public abstract void accept(EditorVisitor visitor)

getObject

public abstract T getObject()

getPath

public String getPath()

Description copied from interface: EditorDelegate

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

Specified by:

getPath in interface EditorDelegate<T>

Returns:

the path as a String

isDirty

public boolean isDirty()

Just returns the last value passed to setDirty(boolean).

recordError

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

Description copied from interface: EditorDelegate

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

Specified by:

recordError in interface EditorDelegate<T>

Parameters:

message - a textual description of the error

value - the value to be returned by EditorError.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 EditorError.getUserData()

recordError

public void recordError(String message,
                        Object value,
                        Object userData,
                        String extraPath,
                        Editor<?> leafEditor)

setDirty

public void setDirty(boolean dirty)

Description copied from interface: EditorDelegate

Toggle the dirty-state flag for the Editor.

The dirty state of an Editor will be automatically cleared any time the Driver's edit() or flush() methods are called.

The dirty state will be automatically calculated for LeafValueEditor instances based on an Object.equals(Object) comparison of TakesValue.getValue() and the value last passed to TakesValue.setValue(Object), however a clean state can be overridden by calling setDirty(true).

Specified by:

setDirty in interface EditorDelegate<T>

Parameters:

dirty - the dirty state of the Editor

subscribe

public abstract HandlerRegistration subscribe()

Description copied from interface: EditorDelegate

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

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

Specified by:

subscribe in interface EditorDelegate<T>

Returns:

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

addSubDelegate

protected <R,S extends Editor<R>> void addSubDelegate(AbstractEditorDelegate<R,S> subDelegate,
                                                      String path,
                                                      S subEditor)

Initialize a sub-delegate whenever one is added to the editor hierarchy.

appendPath

protected String appendPath(String path)

createChain

protected <R,S extends Editor<R>> void createChain(Class<R> composedElementType)

createComposedDelegate

protected AbstractEditorDelegate<?,?> createComposedDelegate()

Only implemented by delegates for a CompositeEditor.

createInitializerVisitor

protected EditorVisitor createInitializerVisitor()

ensureMutable

protected <Q> Q ensureMutable(Q object)

getEditor

protected abstract E getEditor()

getEditorChain

protected AbstractEditorDelegate.Chain<?,?> getEditorChain()

getErrors

protected List<EditorError> getErrors()

initialize

protected void initialize(String pathSoFar,
                          E editor)

initializeSubDelegates

protected abstract void initializeSubDelegates()

setEditor

protected abstract void setEditor(E editor)

setObject

protected abstract void setObject(T object)

shouldFlush

protected boolean shouldFlush()

Indicates whether or not calls to #flush are expected as part of normal operation.