Summary: Methods | [Expand All]
public interface

EditorError

com.google.gwt.editor.client.EditorError
Known Indirect Subclasses

Class Overview

Allows invalid Editor state to be propagated through an Editor hierarchy. Instances of EditorError are typically created as a side effect of calling recordError(String, Object, Object).

See Also

Summary

Public Methods
abstract String getAbsolutePath()
Returns the absolute path location of the error, relative to the object that was passed into the EditorDriver.
abstract Editor<?> getEditor()
Returns the Editor that holds the invalid value.
abstract String getMessage()
Returns a message associated with the error.
abstract String getPath()
Returns the path of the error relative to the Editor receiving the error.
abstract Object getUserData()
Returns the object passed into recordError(String, Object, Object).
abstract Object getValue()
Returns the value that triggered the error.
abstract boolean isConsumed()
Indicates whether or not the EditorError will be propagated to the enclosing Editor.
abstract void setConsumed(boolean consumed)
Indicates whether or not the EditorError will be propagated to the enclosing Editor.

Public Methods

public abstract String getAbsolutePath ()

Returns the absolute path location of the error, relative to the object that was passed into the EditorDriver.

Returns
  • the absolute path as a String

public abstract Editor<?> getEditor ()

Returns the Editor that holds the invalid value.

Returns
  • the Editor instance

public abstract String getMessage ()

Returns a message associated with the error.

Returns
  • the error message as a String

public abstract String getPath ()

Returns the path of the error relative to the Editor receiving the error. If the error concerns the Editor that is receiving the error, this method will return an empty string.

Returns
  • the error path as a String

public abstract Object getUserData ()

Returns the object passed into recordError(String, Object, Object).

Returns
  • the user data Object

public abstract Object getValue ()

Returns the value that triggered the error.

Returns
  • the error value Object

public abstract boolean isConsumed ()

Indicates whether or not the EditorError will be propagated to the enclosing Editor.

Returns
  • true if the error will not be propagated
See Also

public abstract void setConsumed (boolean consumed)

Indicates whether or not the EditorError will be propagated to the enclosing Editor.

Parameters
consumed true if the error will not be propagated
See Also