Oxygen XML Editor 15.0 Author API

ro.sync.ecss.extensions.api
Class AuthorSchemaAwareEditingHandlerAdapter

java.lang.Object
  extended by ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandlerAdapter
All Implemented Interfaces:
ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler
Direct Known Subclasses:
DITASchemaAwareEditingHandler, DocbookSchemaAwareEditingHandler, TEISchemaAwareEditingHandler

@API(type=EXTENDABLE,
     src=PUBLIC)
public class AuthorSchemaAwareEditingHandlerAdapter
extends java.lang.Object
implements ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler

Adapter class.


Field Summary
protected  SchemaAwareHandlerResult lastHandlerResult
          Last handler result.
 
Fields inherited from interface ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler
ACTION_ID_BACKSPACE, ACTION_ID_CUT, ACTION_ID_DELETE, ACTION_ID_DND, ACTION_ID_INSERT_FRAGMENT, ACTION_ID_PASTE, ACTION_ID_TYPING, CREATE_FRAGMENT_PURPOSE_COPY, CREATE_FRAGMENT_PURPOSE_CUT, CREATE_FRAGMENT_PURPOSE_DND_COPY, CREATE_FRAGMENT_PURPOSE_DND_MOVE
 
Constructor Summary
AuthorSchemaAwareEditingHandlerAdapter()
           
 
Method Summary
 SchemaAwareHandlerResult getLastResult()
          Deprecated. Will be removed in a future version
 AuthorDocumentFragment handleCreateDocumentFragment(int startOffset, int endOffset, int creationPurposeID, AuthorAccess authorAccess)
          Create an AuthorDocumentFragment for a paste or DnD purpose
 boolean handleDelete(int offset, int deleteType, AuthorAccess authorAccess, boolean wordLevel)
           
 boolean handleDeleteElementTags(AuthorNode nodeToUnwrap, AuthorAccess authorAccess)
           
 boolean handleDeleteNodes(AuthorNode[] nodes, int deleteType, AuthorAccess authorAccess)
           
 boolean handleDeleteSelection(int selectionStart, int selectionEnd, int generatedByActionId, AuthorAccess authorAccess)
           
 boolean handleJoinElements(AuthorNode targetNode, java.util.List<AuthorNode> nodesToJoin, AuthorAccess authorAccess)
           
 boolean handlePasteFragment(int offset, AuthorDocumentFragment[] fragmentsToInsert, int actionId, AuthorAccess authorAccess)
           
 boolean handleTyping(int offset, char ch, AuthorAccess authorAccess)
           
 boolean handleTypingFallback(int offset, char ch, AuthorAccess authorAccess)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

lastHandlerResult

protected SchemaAwareHandlerResult lastHandlerResult
Last handler result.

Constructor Detail

AuthorSchemaAwareEditingHandlerAdapter

public AuthorSchemaAwareEditingHandlerAdapter()
Method Detail

handleDelete

public boolean handleDelete(int offset,
                            int deleteType,
                            AuthorAccess authorAccess,
                            boolean wordLevel)
                     throws InvalidEditException
Specified by:
handleDelete in interface ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler
Throws:
InvalidEditException
See Also:
AuthorSchemaAwareEditingHandler.handleDelete(int, int, ro.sync.ecss.extensions.api.AuthorAccess, boolean)

handleDeleteElementTags

public boolean handleDeleteElementTags(AuthorNode nodeToUnwrap,
                                       AuthorAccess authorAccess)
                                throws InvalidEditException
Specified by:
handleDeleteElementTags in interface ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler
Throws:
InvalidEditException
See Also:
AuthorSchemaAwareEditingHandler.handleDeleteElementTags(ro.sync.ecss.extensions.api.node.AuthorNode, ro.sync.ecss.extensions.api.AuthorAccess)

handleDeleteSelection

public boolean handleDeleteSelection(int selectionStart,
                                     int selectionEnd,
                                     int generatedByActionId,
                                     AuthorAccess authorAccess)
                              throws InvalidEditException
Specified by:
handleDeleteSelection in interface ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler
Throws:
InvalidEditException
See Also:
AuthorSchemaAwareEditingHandler.handleDeleteSelection(int, int, int, ro.sync.ecss.extensions.api.AuthorAccess)

handleJoinElements

public boolean handleJoinElements(AuthorNode targetNode,
                                  java.util.List<AuthorNode> nodesToJoin,
                                  AuthorAccess authorAccess)
                           throws InvalidEditException
Specified by:
handleJoinElements in interface ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler
Throws:
InvalidEditException
See Also:
AuthorSchemaAwareEditingHandler.handleJoinElements(ro.sync.ecss.extensions.api.node.AuthorNode, java.util.List, ro.sync.ecss.extensions.api.AuthorAccess)

handlePasteFragment

public boolean handlePasteFragment(int offset,
                                   AuthorDocumentFragment[] fragmentsToInsert,
                                   int actionId,
                                   AuthorAccess authorAccess)
                            throws InvalidEditException
Specified by:
handlePasteFragment in interface ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler
Throws:
InvalidEditException
See Also:
AuthorSchemaAwareEditingHandler.handlePasteFragment(int, ro.sync.ecss.extensions.api.node.AuthorDocumentFragment[], int, ro.sync.ecss.extensions.api.AuthorAccess)

handleTyping

public boolean handleTyping(int offset,
                            char ch,
                            AuthorAccess authorAccess)
                     throws InvalidEditException
Specified by:
handleTyping in interface ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler
Throws:
InvalidEditException
See Also:
AuthorSchemaAwareEditingHandler.handleTyping(int, char, ro.sync.ecss.extensions.api.AuthorAccess)

getLastResult

@Deprecated
public SchemaAwareHandlerResult getLastResult()
Deprecated. Will be removed in a future version

Returns:
The result generated by the last handler method invoked before this call. Is null if event was not handled.

handleCreateDocumentFragment

public AuthorDocumentFragment handleCreateDocumentFragment(int startOffset,
                                                           int endOffset,
                                                           int creationPurposeID,
                                                           AuthorAccess authorAccess)
                                                    throws javax.swing.text.BadLocationException
Create an AuthorDocumentFragment for a paste or DnD purpose

Specified by:
handleCreateDocumentFragment in interface ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler
Throws:
javax.swing.text.BadLocationException
Since:
12.1
See Also:
AuthorSchemaAwareEditingHandler.handleCreateDocumentFragment(int, int, int, ro.sync.ecss.extensions.api.AuthorAccess)

handleDeleteNodes

public boolean handleDeleteNodes(AuthorNode[] nodes,
                                 int deleteType,
                                 AuthorAccess authorAccess)
                          throws InvalidEditException
Specified by:
handleDeleteNodes in interface ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler
Throws:
InvalidEditException
See Also:
AuthorSchemaAwareEditingHandler.handleDeleteNodes(ro.sync.ecss.extensions.api.node.AuthorNode[], int, ro.sync.ecss.extensions.api.AuthorAccess)

handleTypingFallback

public boolean handleTypingFallback(int offset,
                                    char ch,
                                    AuthorAccess authorAccess)
                             throws InvalidEditException
Specified by:
handleTypingFallback in interface ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler
Throws:
InvalidEditException
See Also:
AuthorSchemaAwareEditingHandler.handleTypingFallback(int, char, ro.sync.ecss.extensions.api.AuthorAccess)

Oxygen XML Editor 15.0 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.