ro.sync.ecss.extensions.api

Interface AuthorAccess

All Superinterfaces:

AuthorAccessDeprecated, AuthorConstants

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface AuthorAccess
extends AuthorConstants, AuthorAccessDeprecated

Access class to the author functions. Provides access to specific components corresponding to editor, document, workspace, tables, change tracking and utility informations and actions.

Field Summary

Fields inherited from interface ro.sync.ecss.extensions.api.AuthorConstants

ARG_VALUE_FALSE, ARG_VALUE_TRUE, POSITION_AFTER, POSITION_BEFORE, POSITION_INSIDE, POSITION_INSIDE_AT_THE_BEGINNING, POSITION_INSIDE_AT_THE_END, POSITION_INSIDE_FIRST, POSITION_INSIDE_LAST, SELECT_CONTENT, SELECT_ELEMENT, SELECT_NONE

Method Summary

Modifier and Type	Method and Description
ro.sync.ecss.component.AuthorClipboardObject	getAuthorObjectFromClipboard() Get the author object previously copied in the clipboard.
AuthorResourceBundle	getAuthorResourceBundle() A message bundle that holds all the internationalized messages displayed in Oxygen frameworks for a language set in Preferences.
ClassPathResourcesAccess	getClassPathResourcesAccess() Get access to the list of resources the user has added to the classpath of the corresponding framework.
AuthorDocumentController	getDocumentController() Returns the Author document controller.
AuthorEditorAccess	getEditorAccess() Get the author editor access providing editor related information.
AuthorElement	getElementByAnchor(java.lang.String anchor) Get the author element identified by the given URL anchor.
OptionsStorage	getOptionsStorage() The object that manages the options stored for author extensions.
AuthorOutlineAccess	getOutlineAccess() Get the author Outline access providing Outline related information.
AuthorReviewController	getReviewController() Controller that can be used to toggle the change tracking state, modify the review highlight author name, the highlight painting or to obtain information about the properties used in the serialization and representation of the review highlight (author name, reviewer auto color or the current time stamp in a format identical to the one used by Oxygen for insert, delete and comment markers).
AuthorTableAccess	getTableAccess() Returns the author table access provider responsible for obtaining table related information and executing table actions.
AuthorUtilAccess	getUtilAccess() Get the author access utility methods provider.
AuthorWorkspaceAccess	getWorkspaceAccess() Get the workspace access.
AuthorXMLUtilAccess	getXMLUtilAccess() Get the author access utility methods provider.

Methods inherited from interface ro.sync.ecss.extensions.api.AuthorAccessDeprecated

addAuthorListener, chooseFile, chooseFile, chooseURL, correctURL, deleteSelection, escapeAttributeValue, evaluateXPath, findNodesByXPath, getCaretOffset, getChangeTrackingController, getEditorLocation, getParentFrame, getSelectedText, getSelectionEnd, getSelectionStart, getTableCellAbove, getTableCellAt, getTableCellBelow, getTableCellIndex, getTableColSpanIndices, getTableNumberOfColumns, getTableRow, getTableRowCount, getWordAtCaret, hasSelection, inInlineContext, insertMultipleElements, insertText, insertXMLFragment, insertXMLFragment, isStandalone, isTrackingChanges, locateFile, makeRelative, multipleDelete, newNonValidatingXMLReader, removeAuthorListener, removeClonedElementAttribute, resolvePath, select, selectWord, setCaretPosition, setClonedElementAttribute, showConfirmDialog, showErrorMessage, surroundInFragment, surroundInText, toggleTrackChanges, viewToModel

Method Detail

getEditorAccess

AuthorEditorAccess getEditorAccess()

Get the author editor access providing editor related information.

Returns:

The editor related informations and actions provider. Cannot be null.

getDocumentController

AuthorDocumentController getDocumentController()

Returns the Author document controller. It has methods for changing the document model.

Returns:

The controller for Author document. Cannot be null.

getWorkspaceAccess

AuthorWorkspaceAccess getWorkspaceAccess()

Get the workspace access. Provides methods for obtaining workspace related informations and performing workspace specific actions.

Returns:

The workspace access provider. Cannot be null.

getUtilAccess

AuthorUtilAccess getUtilAccess()

Get the author access utility methods provider.

Returns:

The provider for utility methods. Cannot be null.

getXMLUtilAccess

AuthorXMLUtilAccess getXMLUtilAccess()

Get the author access utility methods provider.

Returns:

The provider for XML utility methods. Cannot be null.

getTableAccess

AuthorTableAccess getTableAccess()

Returns the author table access provider responsible for obtaining table related information and executing table actions.

Returns:

The table related information and actions provider. Cannot be null.

getReviewController

AuthorReviewController getReviewController()

Controller that can be used to toggle the change tracking state, modify the review highlight author name, the highlight painting or to obtain information about the properties used in the serialization and representation of the review highlight (author name, reviewer auto color or the current time stamp in a format identical to the one used by Oxygen for insert, delete and comment markers).

Returns:

The review controller. Cannot be null.

Since:

12

getOptionsStorage

OptionsStorage getOptionsStorage()

The object that manages the options stored for author extensions. This is also responsible for adding and removing listeners that are notified about the option changes.

Returns:

The object that manages the options stored for author extensions.

getOutlineAccess

AuthorOutlineAccess getOutlineAccess()

Get the author Outline access providing Outline related information.

Returns:

The Outline related informations and actions provider. Cannot be null.

getClassPathResourcesAccess

ClassPathResourcesAccess getClassPathResourcesAccess()

Get access to the list of resources the user has added to the classpath of the corresponding framework.

Returns:

access to the list of resources the user has added to the classpath of the corresponding framework.

Since:

12.1

getAuthorResourceBundle

AuthorResourceBundle getAuthorResourceBundle()

A message bundle that holds all the internationalized messages displayed in Oxygen frameworks for a language set in Preferences. It works as a map in which any message is accessed by a key defined in the ExtensionTags interface.

Returns:

The message bundle.

Since:

14

getAuthorObjectFromClipboard

ro.sync.ecss.component.AuthorClipboardObject getAuthorObjectFromClipboard()

Get the author object previously copied in the clipboard.

Returns:

The author object from the clipboard or null if no such object exists.

Since:

17.1

getElementByAnchor

AuthorElement getElementByAnchor(java.lang.String anchor)

Get the author element identified by the given URL anchor. The syntax of the anchor is interpreted by the ElementLocatorProvider provided by the framework.

Parameters:

anchor - The anchor.

Returns:

The element identified by the anchor.

Since:

18.0

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