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

Modifier and Type	Method and Description
void	delete(boolean del, boolean wordLevel) Deletes the the current selection using information from the schema associated to the document such that document is left in a valid state.
ro.sync.ecss.component.AuthorClipboardObject	handleCopy() Copy from offset to offset inclusive.
void	handleHtmlPaste(java.lang.String html) Handles a paste with an HTML content from an external source.
void	handlePaste(ro.sync.ecss.component.AuthorClipboardObject toPaste, boolean removeSelection, boolean pasteAsXml) Paste a fragment.
void	handleXmlPaste(java.lang.String xml) Handles a paste with an XML content.
void	insertCharAtCurrentOffset(char ch) Inserts the given character at the current caret position.

Method Detail

handleHtmlPaste

void handleHtmlPaste(java.lang.String html)
              throws InvalidEditException

Handles a paste with an HTML content from an external source.

Parameters:

html - The HTML content.

Throws:

InvalidEditException - If the paste could not be performed.

handleXmlPaste

void handleXmlPaste(java.lang.String xml)
             throws InvalidEditException

Handles a paste with an XML content.

Parameters:

xml - the XML content.

Throws:

InvalidEditException - If the paste could not be performed.

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()
                                                 throws javax.swing.text.BadLocationException

Copy from offset to 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.

delete

void delete(boolean del,
            boolean wordLevel)
     throws InvalidEditException

Deletes the the current selection using information from the schema associated to the document such that document is left in a valid state.

Parameters:

del - true if the deletion was triggered by a DEL.

wordLevel - Whether we should delete an entire word.

Throws:

InvalidEditException - If the edit fails.