Interface AuthorEditorAccess
- All Superinterfaces:
AuthorTooltipCustomizerProvider
,ModifiedStatusProvider
,ScenarioInvoker
,TransformationScenarioInvoker
,ValidationScenarioInvoker
,WSAuthorEditorPageBase
,WSEditorBase
,WSEditorPage
,WSTextBasedEditorPage
- All Known Subinterfaces:
IWebappAuthorEditorAccess
@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
Modifier and TypeMethodDescriptionThe editing session context.Get the extensions bundle Java extension associated to this XML document's document type.int[]
getLocationOnScreen
(int x, int y) Deprecated.Use the getLocationOnScreenAsPoint(int x, int y) method instead.Get the manager that can be used to find (and save) the resources whose content has been modified in-place, by editing the expanded references.int[]
modelToView
(int offset) Deprecated.use modelToViewRectangle(int offset) insteadMethods inherited from interface ro.sync.exml.workspace.api.editor.page.author.tooltip.AuthorTooltipCustomizerProvider
addTooltipCustomizer, removeTooltipCustomizer
Methods inherited from interface ro.sync.exml.workspace.api.base.ModifiedStatusProvider
isModified
Methods inherited from interface ro.sync.exml.workspace.api.editor.transformation.TransformationScenarioInvoker
runTransformationScenario, runTransformationScenarios, stopCurrentTransformationScenario
Methods inherited from interface ro.sync.exml.workspace.api.editor.validation.ValidationScenarioInvoker
runValidationScenarios
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.author.WSAuthorEditorPageBase
addAuthorAttributesDisplayFilter, addAuthorCaretListener, addAuthorMouseListener, addDNDListener, addPopUpMenuCustomizer, buildURLForReferencedContent, deleteSelection, editAttribute, getActionsProvider, getAuthorComponent, getAuthorFoldManager, getAuthorSelectionModel, getBalancedSelection, getBalancedSelectionEnd, getBalancedSelectionStart, getDefaultAuthorSchemaAwareEditingHandler, getFullySelectedNode, getFullySelectedNode, getHighlighter, getPersistentHighlighter, getPseudoElementStyles, getSelectedText, getSelectionEnd, getSelectionStart, getStyles, getTagsDisplayMode, goToNextEditablePosition, hasSelection, isOffsetInInvisibleBounds, moveOutOfInvisibleBounds, refresh, refresh, removeAuthorAttributesDisplayFilter, removeAuthorCaretListener, removeAuthorMouseListener, removeDNDListener, removePopUpMenuCustomizer, scrollToRectangle, select, setPopUpMenuCustomizer, setTagsDisplayMode, viewToModel
Methods inherited from interface ro.sync.exml.workspace.api.editor.WSEditorBase
close, createContentInputStream, createContentReader, getDocumentTypeInformation, getEditorLocation, getEncodingForSerialization, isNewDocument, reloadContent, reloadContent, save, saveAs, setEditorTabText, setEditorTabTooltipText, setModified
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSEditorPage
getParentEditor, hasFocus, isEditable, requestFocus, setEditable, setReadOnly, setReadOnly
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSTextBasedEditorPage
copy, createAnchor, getCaretOffset, getLocationOnScreenAsPoint, getLocationRelativeToEditorFromScreen, getOffsetForAnchor, getStartEndOffsets, getWordAtCaret, modelToViewRectangle, scrollCaretToVisible, selectWord, setCaretPosition, viewToModelOffset
-
Method Details
-
getLocationOnScreen
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.use modelToViewRectangle(int offset) insteadReturns 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.
-
getEditingContext
EditingSessionContext getEditingContext()The editing session context. An editing session corresponds to an editor instance, contains custom attributes that can be set from the API.- Returns:
- The editing session context.
- Since:
- 15.2
-
getExtensionsBundle
ExtensionsBundle getExtensionsBundle()Get the extensions bundle Java extension associated to this XML document's document type.- Returns:
- the extensions bundle Java extension associated to this XML document's document type, may be
null
. - Since:
- 20.1
-
getUnsavedContentReferenceManager
UnsavedContentReferenceManager getUnsavedContentReferenceManager()Get the manager that can be used to find (and save) the resources whose content has been modified in-place, by editing the expanded references.- Returns:
- The unsaved reference manager. Can be
null
, if the references cannot be edited in place in this editor. - Since:
- 23
-