|
Oxygen XML Editor 12.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WSAuthorEditorPageBase
Provides access to methods related to the Author editor actions and information.
Method Summary | |
---|---|
void |
addAuthorCaretListener(AuthorCaretListener caretListener)
Adds a caret listener to the Author page. |
void |
addAuthorMouseListener(AuthorMouseListener mouseListener)
Adds a mouse listener to the current author page. |
AuthorActionsProvider |
getActionsProvider()
Provides access to actions already defined in the Author page like: Undo, Redo, Display Full Tags, Edit Attributes, etc. |
java.lang.Object |
getAuthorComponent()
Get the internal component on which the Author page is rendered. |
int |
getBalancedSelectionEnd()
Usually returns the same value as WSTextBasedEditorPage.getSelectionEnd() . |
int |
getBalancedSelectionStart()
Usually returns the same value as WSTextBasedEditorPage.getSelectionStart() . |
AuthorSchemaAwareEditingHandler |
getDefaultAuthorSchemaAwareEditingHandler()
Get the default schema aware editing handler. |
AuthorHighlighter |
getHighlighter()
Get the highlighter which can be used to add/remove/manage the custom user highlights |
AuthorPersistentHighlighter |
getPersistentHighlighter()
Get the persistent highlighter which can be used to add/remove/manage the custom persistent user highlights. |
Styles |
getStyles(AuthorNode node)
Get the CSS styles which are used to render a particular Author node. |
void |
refresh()
Reload the CSS files and perform a refresh on the whole document to recompute the layout and the styles for all the nodes based on the new CSS files content. |
void |
refresh(AuthorNode authorNode)
Refresh the rendering layout and CSS styles for this node and all its contents. |
void |
removeAuthorCaretListener(AuthorCaretListener caretListener)
Removes the specified caret listener from the Author page. |
void |
removeAuthorMouseListener(AuthorMouseListener mouseListener)
Removes the specified mouse listener from the current author page. |
void |
setPopUpMenuCustomizer(AuthorPopupMenuCustomizer popUpCustomizer)
Set the pop-up menu customizer which can be used to customize the pop-up menu (add/remove actions) before showing it in the Author page. |
AuthorViewToModelInfo |
viewToModel(int x,
int y)
Get the position in the document corresponding to the point in the author viewport component. |
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSTextBasedEditorPage |
---|
deleteSelection, getCaretOffset, getLocationOnScreenAsPoint, getSelectedText, getSelectionEnd, getSelectionStart, getWordAtCaret, hasSelection, modelToViewRectangle, select, selectWord, setCaretPosition, setEditable, viewToModelOffset |
Method Detail |
---|
AuthorViewToModelInfo viewToModel(int x, int y)
x
- The "x" coordinate relative to the viewport origin.y
- The "y" coordinate relative to the viewport origin.
AuthorViewToModelInfo
containing the offset and the node
at offset corresponding to the given point. The method does not return null
,
instead an undefined view to model info object is returned if a valid one could not be determined.void setPopUpMenuCustomizer(AuthorPopupMenuCustomizer popUpCustomizer)
popUpCustomizer
- the pop-up menu customizer.void addAuthorMouseListener(AuthorMouseListener mouseListener)
mouseListener
- The AuthorMouseListener
to be added.void removeAuthorMouseListener(AuthorMouseListener mouseListener)
mouseListener
- The AuthorMouseListener
to be removed.void addAuthorCaretListener(AuthorCaretListener caretListener)
caretListener
- The AuthorCaretListener
to be added.void removeAuthorCaretListener(AuthorCaretListener caretListener)
caretListener
- The AuthorCaretListener
to be removed.void refresh(AuthorNode authorNode)
authorNode
- The node for which the layout and styles will be recomputed.void refresh()
AuthorHighlighter getHighlighter()
AuthorPersistentHighlighter getPersistentHighlighter()
<?oxy_custom_start prop1="val1"....?> xml content <?oxy_custom_end?>
int getBalancedSelectionStart()
WSTextBasedEditorPage.getSelectionStart()
.
int getBalancedSelectionEnd()
WSTextBasedEditorPage.getSelectionEnd()
.
AuthorSchemaAwareEditingHandler getDefaultAuthorSchemaAwareEditingHandler()
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.
AuthorActionsProvider getActionsProvider()
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.
java.lang.Object getAuthorComponent()
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.
Styles getStyles(AuthorNode node)
StylesFilter
.
node
- The node for which we want to obtain the styles.
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.
|
Oxygen XML Editor 12.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |