ro.sync.ecss.extensions.api.schemaaware
Interface SchemaAwareHandlerResult

All Superinterfaces:

SchemaAwareHandlerResultInsertConstants

All Known Implementing Classes:

SchemaAwareHandlerResultsImpl

public interface SchemaAwareHandlerResult
extends SchemaAwareHandlerResultInsertConstants

Contains information about the result of the last operation handled by AuthorSchemaAwareEditingHandler. The user can provide a custom implementation in order to transfer useful information about the event handling.

*********************************
EXPERIMENTAL - Subject to change
*********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Since:

11.2

Field Summary

static String	TYPE_HANDLE_DELETE_ELEMENT_TAGS_OPERATION Result generated by a delete element tags operation.
static String	TYPE_HANDLE_DELETE_OPERATION Result generated by a keyboard delete operation (using delete or backspace keys).
static String	TYPE_HANDLE_DELETE_SELECTION_OPERATION Result generated by a delete selection operation.
static String	TYPE_HANDLE_INSERT_FRAGMENT_OPERATION Result generated by an insert fragment operation.
static String	TYPE_HANDLE_JOIN_ELEMENTS_OPERATION Result generated by a join operation.
static String	TYPE_HANDLE_TYPING_OPERATION Result generated by a typing operation.

Fields inherited from interface ro.sync.ecss.extensions.api.schemaaware.SchemaAwareHandlerResultInsertConstants

RESULT_ID_HANDLE_INSERT_FRAGMENT_OFFSET

Method Summary

Object	getResult(String resultId) Get the result for the given id.
String	getType() The type of operation that generated the result.

Field Detail

TYPE_HANDLE_DELETE_OPERATION

static final String TYPE_HANDLE_DELETE_OPERATION

Result generated by a keyboard delete operation (using delete or backspace keys).

See Also:

Constant Field Values

TYPE_HANDLE_DELETE_ELEMENT_TAGS_OPERATION

static final String TYPE_HANDLE_DELETE_ELEMENT_TAGS_OPERATION

Result generated by a delete element tags operation.

See Also:

Constant Field Values

TYPE_HANDLE_DELETE_SELECTION_OPERATION

static final String TYPE_HANDLE_DELETE_SELECTION_OPERATION

Result generated by a delete selection operation.

See Also:

Constant Field Values

TYPE_HANDLE_JOIN_ELEMENTS_OPERATION

static final String TYPE_HANDLE_JOIN_ELEMENTS_OPERATION

Result generated by a join operation.

See Also:

Constant Field Values

TYPE_HANDLE_INSERT_FRAGMENT_OPERATION

static final String TYPE_HANDLE_INSERT_FRAGMENT_OPERATION

Result generated by an insert fragment operation.

See Also:

Constant Field Values

TYPE_HANDLE_TYPING_OPERATION

static final String TYPE_HANDLE_TYPING_OPERATION

Result generated by a typing operation.

See Also:

Constant Field Values

Method Detail

getResult

Object getResult(String resultId)

Get the result for the given id.

Parameters:

resultId - One of the constants defined in this interface.

Returns:

The value for the result. Can be null for an unknown result id.

getType

String getType()

The type of operation that generated the result. Depending on a result type, different information is available through getResult(String) method. Possible values are:

• TYPE_HANDLE_DELETE_ELEMENT_TAGS_OPERATION for delete element tags operation, see AuthorSchemaAwareEditingHandler.handleDeleteElementTags(ro.sync.ecss.extensions.api.node.AuthorNode, AuthorAccess);
• TYPE_HANDLE_DELETE_OPERATION for a keyboard delete operation, see AuthorSchemaAwareEditingHandler.handleDelete(int, int, AuthorAccess, boolean);
• TYPE_HANDLE_DELETE_SELECTION_OPERATION for delete selection operation, see AuthorSchemaAwareEditingHandler.handleDeleteSelection(int, int, int, AuthorAccess);
• TYPE_HANDLE_JOIN_ELEMENTS_OPERATION for join elements operation, see AuthorSchemaAwareEditingHandler.handleJoinElements(ro.sync.ecss.extensions.api.node.AuthorNode, java.util.List, AuthorAccess);
• TYPE_HANDLE_INSERT_FRAGMENT_OPERATION for insert fragment operation, see AuthorSchemaAwareEditingHandler.handlePasteFragment(int, ro.sync.ecss.extensions.api.node.AuthorDocumentFragment[], int, AuthorAccess);
• TYPE_HANDLE_TYPING_OPERATION for typing operation, see AuthorSchemaAwareEditingHandler.handleTyping(int, char, AuthorAccess).

Returns:

One of the constants from above, describing which schema aware operation generated the result.

See Also:

SchemaAwareHandlerResultInsertConstants} is the result returned by the insert operations.