ro.sync.exml.workspace.api.editor.page.author
Interface WSAuthorEditorPageBase

All Superinterfaces:

WSEditorPage, WSTextBasedEditorPage

All Known Subinterfaces:

AuthorEditorAccess, WSAuthorEditorPage

public interface WSAuthorEditorPageBase
extends WSTextBasedEditorPage

Provides access to methods related to the Author editor actions and information.

*********************************
EXPERIMENTAL - Subject to change
*********************************

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.

Since:

11.2

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.
AuthorHighlighter	getHighlighter() Get the highlighter which can be used to add/remove/manage the custom user highlights
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.
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, viewToModelOffset

Method Detail

viewToModel

AuthorViewToModelInfo viewToModel(int x,
                                  int y)

Get the position in the document corresponding to the point in the author viewport component.

Parameters:

x - The "x" coordinate relative to the viewport origin.

y - The "y" coordinate relative to the viewport origin.

Returns:

The 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.

addAuthorMouseListener

void addAuthorMouseListener(AuthorMouseListener mouseListener)

Adds a mouse listener to the current author page.

Parameters:

mouseListener - The AuthorMouseListener to be added.

removeAuthorMouseListener

void removeAuthorMouseListener(AuthorMouseListener mouseListener)

Removes the specified mouse listener from the current author page.

Parameters:

mouseListener - The AuthorMouseListener to be removed.

addAuthorCaretListener

void addAuthorCaretListener(AuthorCaretListener caretListener)

Adds a caret listener to the Author page.

Parameters:

caretListener - The AuthorCaretListener to be added.

removeAuthorCaretListener

void removeAuthorCaretListener(AuthorCaretListener caretListener)

Removes the specified caret listener from the Author page.

Parameters:

caretListener - The AuthorCaretListener to be removed.

refresh

void refresh(AuthorNode authorNode)

Refresh the rendering layout and CSS styles for this node and all its contents.

Parameters:

authorNode - The node for which the layout and styles will be recomputed.

refresh

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.

getHighlighter

AuthorHighlighter getHighlighter()

Get the highlighter which can be used to add/remove/manage the custom user highlights

Returns:

The highlighter which can be used to add/remove/manage the custom user highlights.