ro.sync.ecss.extensions.api.webapp

Interface WebappAuthorSchemaAwareActionsHandler

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface WebappAuthorSchemaAwareActionsHandler

Handles schema aware actions like paste.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteBetweenOffsets(int start, int end, boolean backspace) Deletes the content between the two given offsets using information from the schema associated to the document such that document is left in a valid state.
void	deleteChar(int deleteOffset, boolean del, boolean wordLevel) Deletes the character to the right of the caret if del is true else delete the left character.
ro.sync.ecss.component.AuthorClipboardObject	handleCopy(int startOffset, int endOffset) Copy from offset to offset inclusive.
void	handlePaste(ro.sync.ecss.component.AuthorClipboardObject toPaste, boolean removeSelection, boolean pasteAsXml) Paste a fragment.
void	insertCharAtCurrentOffset(char ch) Inserts the given character at the current caret position.

Method Detail

handlePaste

void handlePaste(ro.sync.ecss.component.AuthorClipboardObject toPaste,
               boolean removeSelection,
               boolean pasteAsXml)
                 throws InvalidEditException

Paste a fragment.

Parameters:

toPaste - The fragment to paste

removeSelection - Remove the selection

pasteAsXml - If true treat the pasted text as an xml fragment. Else escape it and insert it.

Throws:

InvalidEditException - When paste was rejected.

handleCopy

ro.sync.ecss.component.AuthorClipboardObject handleCopy(int startOffset,
                                                      int endOffset)
                                                        throws javax.swing.text.BadLocationException

Copy from offset to offset inclusive.

Parameters:

startOffset - Start offset (inclusive)

endOffset - End offset (inclusive)

Returns:

The doc fragment with the copy text.

Throws:

javax.swing.text.BadLocationException

insertCharAtCurrentOffset

void insertCharAtCurrentOffset(char ch)

Inserts the given character at the current caret position. Any selected content is first deleted.

Parameters:

ch - The character to insert.

deleteBetweenOffsets

boolean deleteBetweenOffsets(int start,
                           int end,
                           boolean backspace)
                             throws InvalidEditException

Deletes the content between the two given offsets using information from the schema associated to the document such that document is left in a valid state.

Parameters:

start - The start offset (inclusive).

end - The end offset (inclusive).

backspace - Whether the deletion was triggered by a backspace.

Returns:

true if successful.

Throws:

InvalidEditException - If the edit fails.

deleteChar

void deleteChar(int deleteOffset,
              boolean del,
              boolean wordLevel)
                throws InvalidEditException

Deletes the character to the right of the caret if del is true else delete the left character.

Parameters:

deleteOffset - The caret offset where the deletion is performed.

del - Delete or Backspace.

wordLevel - true if the delete should work at a word level.

Throws:

InvalidEditException - Thrown when delete operation was rejected.