|
Oxygen XML Editor, Version 13.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface WSAuthorEditorPageBase
Provides access to methods related to the Author editor actions and information.
Method Summary | |
---|---|
void |
addAuthorAttributesDisplayFilter(ro.sync.ecss.extensions.api.attributes.AuthorAttributesDisplayFilter attributesDisplayFilter)
Adds a filter for displaying attributes to the current author page. |
void |
addAuthorCaretListener(ro.sync.ecss.extensions.api.AuthorCaretListener caretListener)
Adds a caret listener to the Author page. |
void |
addAuthorMouseListener(ro.sync.ecss.extensions.api.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() . |
ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler |
getDefaultAuthorSchemaAwareEditingHandler()
Get the default schema aware editing handler. |
ro.sync.ecss.extensions.api.node.AuthorNode |
getFullySelectedNode()
Get the node which is fully and perfectly surrounded by the current selection in the Author editor. If the selection surrounds perfectly the node (the selection starts at the node start offset and ends immediately after the node end offset), the node will be returned, otherwise null will be returned.For example if a node is selected using Outline or the Breadcrumb, the method will return the corresponding node. |
ro.sync.ecss.extensions.api.highlights.AuthorHighlighter |
getHighlighter()
Get the highlighter which can be used to add/remove/manage the custom user highlights |
ro.sync.ecss.extensions.api.highlights.AuthorPersistentHighlighter |
getPersistentHighlighter()
Get the persistent highlighter which can be used to add/remove/manage the custom persistent user highlights. |
ro.sync.ecss.css.Styles |
getStyles(ro.sync.ecss.extensions.api.node.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(ro.sync.ecss.extensions.api.node.AuthorNode authorNode)
Refresh the rendering layout and CSS styles for this node and all its contents. |
void |
removeAuthorAttributesDisplayFilter(ro.sync.ecss.extensions.api.attributes.AuthorAttributesDisplayFilter attributesDisplayFilter)
Remove a filter for displaying attributes to the current author page. |
void |
removeAuthorCaretListener(ro.sync.ecss.extensions.api.AuthorCaretListener caretListener)
Removes the specified caret listener from the Author page. |
void |
removeAuthorMouseListener(ro.sync.ecss.extensions.api.AuthorMouseListener mouseListener)
Removes the specified mouse listener from the current author page. |
void |
setPopUpMenuCustomizer(ro.sync.ecss.extensions.api.structure.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. |
ro.sync.ecss.extensions.api.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 |
---|
ro.sync.ecss.extensions.api.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(ro.sync.ecss.extensions.api.structure.AuthorPopupMenuCustomizer popUpCustomizer)
popUpCustomizer
- the pop-up menu customizer.void addAuthorMouseListener(ro.sync.ecss.extensions.api.AuthorMouseListener mouseListener)
mouseListener
- The AuthorMouseListener
to be added.void removeAuthorMouseListener(ro.sync.ecss.extensions.api.AuthorMouseListener mouseListener)
mouseListener
- The AuthorMouseListener
to be removed.void addAuthorCaretListener(ro.sync.ecss.extensions.api.AuthorCaretListener caretListener)
caretListener
- The AuthorCaretListener
to be added.void removeAuthorCaretListener(ro.sync.ecss.extensions.api.AuthorCaretListener caretListener)
caretListener
- The AuthorCaretListener
to be removed.void refresh(ro.sync.ecss.extensions.api.node.AuthorNode authorNode)
authorNode
- The node for which the layout and styles will be recomputed.void refresh()
ro.sync.ecss.extensions.api.highlights.AuthorHighlighter getHighlighter()
ro.sync.ecss.extensions.api.highlights.AuthorPersistentHighlighter getPersistentHighlighter()
<?oxy_custom_start prop1="val1"....?> xml content <?oxy_custom_end?>
int getBalancedSelectionStart()
WSTextBasedEditorPage.getSelectionStart()
.
int getBalancedSelectionEnd()
WSTextBasedEditorPage.getSelectionEnd()
.
ro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler getDefaultAuthorSchemaAwareEditingHandler()
AuthorActionsProvider getActionsProvider()
java.lang.Object getAuthorComponent()
ro.sync.ecss.css.Styles getStyles(ro.sync.ecss.extensions.api.node.AuthorNode node)
StylesFilter
.
node
- The node for which we want to obtain the styles.
void addAuthorAttributesDisplayFilter(ro.sync.ecss.extensions.api.attributes.AuthorAttributesDisplayFilter attributesDisplayFilter)
attributesDisplayFilter
- The AuthorAttributesDisplayFilter
to be added.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.
void removeAuthorAttributesDisplayFilter(ro.sync.ecss.extensions.api.attributes.AuthorAttributesDisplayFilter attributesDisplayFilter)
attributesDisplayFilter
- The AuthorAttributesDisplayFilter
to be added.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.
ro.sync.ecss.extensions.api.node.AuthorNode getFullySelectedNode()
null
will be returned.AuthorDocumentController.getNodeAtOffset(int)
called for the caret offset always returns the parent of the selected element
as the caret is actually outside the selected element.
Thus, in order to obtain the context node, this method should be used and if it returns null
you can use the AuthorDocumentController.getNodeAtOffset(int)
method.
null
otherwise.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, Version 13.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |