ro.sync.ecss.extensions.api.access
Interface AuthorEditorAccess

All Superinterfaces:

WSAuthorEditorPageBase, WSEditorBase, WSEditorPage, WSTextBasedEditorPage

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface AuthorEditorAccess
extends WSAuthorEditorPageBase, WSEditorBase

Provides access to methods related to the Author editor actions and information. It also provides methods to save the file, close, etc.

Method Summary

int[]	getLocationOnScreen(int x, int y) Deprecated. Use the getLocationOnScreenAsPoint(int x, int y) method instead.
int[]	modelToView(int offset) Deprecated. use modelToViewRectangle(int offset) instead

Methods inherited from interface ro.sync.exml.workspace.api.editor.page.author.WSAuthorEditorPageBase

addAuthorAttributesDisplayFilter, addAuthorCaretListener, addAuthorMouseListener, addPopUpMenuCustomizer, deleteSelection, editAttribute, getActionsProvider, getAuthorComponent, getAuthorSelectionModel, getBalancedSelectionEnd, getBalancedSelectionStart, getDefaultAuthorSchemaAwareEditingHandler, getFullySelectedNode, getHighlighter, getPersistentHighlighter, getSelectedText, getSelectionEnd, getSelectionStart, getStyles, goToNextEditablePosition, hasSelection, refresh, refresh, removeAuthorAttributesDisplayFilter, removeAuthorCaretListener, removeAuthorMouseListener, removePopUpMenuCustomizer, scrollToRectangle, select, setPopUpMenuCustomizer, viewToModel

Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSTextBasedEditorPage

getCaretOffset, getLocationOnScreenAsPoint, getLocationRelativeToEditorFromScreen, getStartEndOffsets, getWordAtCaret, isEditable, modelToViewRectangle, selectWord, setCaretPosition, setEditable, viewToModelOffset

Methods inherited from interface ro.sync.exml.workspace.api.editor.WSEditorBase

close, createContentReader, getEditorLocation, isModified, isNewDocument, reloadContent, reloadContent, save, saveAs, setEditorTabText, setEditorTabTooltipText, setModified

Method Detail

getLocationOnScreen

@Deprecated
int[] getLocationOnScreen(int x,
                                     int y)

Deprecated. Use the getLocationOnScreenAsPoint(int x, int y) method instead.

Take relative mouse coordinates and translate then to absolute on-screen coordinates.

Parameters:

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

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

Returns:

An array with the "x" and "y" coordinates relative to the screen.

modelToView

@Deprecated
int[] modelToView(int offset)

Deprecated. use modelToViewRectangle(int offset) instead

Returns a representation of the caret shape for the specified document offset.

Parameters:

offset - The document offset to get the corresponding caret shape for.

Returns:

An array of int values corresponding to the caret shape: the caret "x" coordinate relative to the viewport origin, the caret "y" coordinate relative to the viewport origin, the caret rectangle width and the caret rectangle height.