Package ro.sync.ecss.extensions.api

Main API package used for controlling the Author page (making modifications, adding listeners).

Interface Summary

Interface	Description
ArgumentsMap	Map between argument names and values.
AttributeChangedEvent	Event received by the AuthorListener when an Author attribute has been changed.
AttributesValueEditor	Deprecated. Starting with version 15 the CustomAttributeValueEditor can be used instead to edit only specific attributes using a custom editor.
AuthorAccess	Access class to the author functions.
AuthorAccessDeprecated	Contains methods that are deprecated in the AuthorAccess and should no longer be used.
AuthorActionEventHandler	Intercepts action events in the Author mode and can handle them in a special manner.
AuthorAttributesController	Helper used to set attributes
AuthorCaretListener	Listener for changes in the caret position of the Author editor page.
AuthorChangeTrackingController	Controls the change tracking mode.
AuthorClipboardAccess	Access to various content data in the system clipboard.
AuthorConstants	Interface containing the constants used in Author API.
AuthorDocumentController	Provides methods for modifying the Author document.
AuthorDocumentEvent	Marker interface for all document change related events.
AuthorDocumentFilterBypass	Used as a way to circumvent calling back into the AuthorDocumentController to change the AuthorDocument.
AuthorElementBaseInterface	Element represents a tag in an XML document.
AuthorExtensionActionProvider	Provides an author extension action for a given action ID.
AuthorExtensionStateListener	Notified when the Author extension, where the listener is defined, was activated or deactivated in the detection process.
AuthorListener	Listener notified about Author document changes, document structure changes and document content changes. DANGER: You must avoid making live document changes on the received call backs.
AuthorMouseListener	Interface for the author mouse listeners.
AuthorOperation	Interface defining an author extension operation.
AuthorOperationWithCustomUndoBehavior	Marker interface that specifies that a particular operation should not be wrapped in a compound undoable edit.
AuthorPreloadProcessor	This processor is notified before the Author document is loaded and renderer.
AuthorPseudoClassController	Controls setting and resetting pseudo classes.
AuthorReferenceResolver	Interface for the custom handlers used to expand content references.
AuthorResourceBundle	Gives access to translate keys.
AuthorReviewController	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 review highlights).
AuthorReviewerNameController	Provides access to reviewer author name, used in the processing instruction that results when a tracked change or a comment is serialized.
AuthorSchemaAwareEditingHandler	If Schema Aware mode is active in Oxygen, all actions that can generate invalid content will be redirected toward this handler.
AuthorSchemaManager	Author schema manager.
AuthorSelectionAndCaretModel	Interface to the author selection and caret model providing methods to query and modify the selection intervals and caret position.
AuthorSelectionModel	Get the Author selection model containing access to all Author selection intervals and methods for adding simple and multiple selections.
AuthorTableCellSepProvider	This is an interface for classes which are responsible for providing information about the cell separators: "rowsep" and "colsep".
AuthorTableCellSpanProvider	This is an interface for classes which are responsible for providing information about the cell spanning.
AuthorTableColumnWidthProvider	This is an interface for classes which are responsible for providing information and handling modifications regarding table and column widths.
AuthorViewToModelInfo	An implementation of this interface is returned by the WSAuthorEditorPageBase.viewToModel(int, int) method.
AuthorXPathExpressionBuilder	Generates an XPath expression for an XML node.
AWTExtension	The base interface for all AWT Oxygen extension classes.
CacheableAuthorReferencesResolver	Marker for cachable references resolvers.
ChangeTrackingController	Controls the change tracking mode.
ClassPathResourcesAccess	Provides access to all URLs which were added in the classpath for the specific framework when the document type was edited from the Oxygen preferences.
CompoundEditListener	Listener notified when compound edits are started and ended.
Content	Interface to describe a sequence of character content that can be edited.
CustomAttributeValueContext	Context for a custom attribute.
DITAMapReferencesResolver	Resolve references when showing a DITA Map in the editor
DocumentContentChangedEvent	Event received by an AuthorListener when changes have been made in the content of the AuthorDocument.
DocumentContentDeletedEvent	Event received by an AuthorListener when a deletion has been made in the content of the AuthorDocument.
DocumentContentInsertedEvent	Event received by an AuthorListener when insertion have been made in the content of the AuthorDocument.
DocumentTypeCustomRuleMatcher	Interface which can be implemented to provide custom matching to the document type it belongs to.
EditedAttribute	Edited attribute information, like QName, element's QName and the proxy namespace mapping.
EditPropertiesHandler	A custom implementation to handle editing properties for an author node.
Extension	The base interface for all Oxygen extensions classes.
ExternalObjectInsertionSources	Drop and paste sources
OptionsStorage	This interface should be used if Author extension level options need to be stored and retrieved.
ReferenceErrorResolver	Resolver for errors concerning references.
StylesFilter	Filter for the element styles.
SWTExtension	The base interface for all SWT Oxygen extension classes.
UniqueAttributesProcessor	Identifies unique attributes like ID's.
UniqueAttributesRecognizer	Identifies unique attributes like ID's.
ValidatingAuthorReferenceResolver	This resolver also validates the target
WebappExtensionsProvider	Web Author specific extensions for a document type.

Class Summary

Class	Description
ArgumentDescriptor	Descriptor class for an author operation argument.
AuthorActionEventDetails	Class offering details about an author action event.
AuthorActionEventHandlerBase	Adds various API methods, for example it adds a method which intercepts action events in the Author mode and can handle them in a special manner.
AuthorCaretEvent	AuthorCaretEvent is used to notify interested AuthorCaretListener that the position of the caret has changed in the Author editor page.
AuthorDocumentFilter	AuthorDocumentFilter, is a filter for the methods which modify the AuthorDocument.
AuthorDocumentType	Author structure representing DOCTYPE information as present in the Author document.
AuthorExtensionStateAdapter	Adapter class for AuthorExtensionStateListener.
AuthorExtensionStateListenerDelegator	A single Author extension state listeners which delegates to other registered listeners.
AuthorExternalObjectInsertionHandler	This class is notified when URLs are dropped or pasted to an Author Editor page or when XHTML fragments are pasted or dropped from external applications (like web browsers or office applications) to the Author page. If you want to use a stylesheet to convert the pasted XHTML to your own XML vocabulary you can just overwrite the method: "ro.sync.ecss.extensions.api.AuthorExternalObjectInsertionHandler.getImporterStylesheetFileName(AuthorAccess)" and return the file name of the stylesheet which will be applied.
AuthorImageDecorator	Permits decoration of the images that are displayed in the Author view.
AuthorInputEvent	Base class for Author input events.
AuthorListenerAdapter	Convenience implementation of the AuthorListener.
AuthorMouseAdapter	Empty implementation of the AuthorMouseListener.
AuthorMouseEvent	Mouse event received by the AuthorMouseListener.
AuthorSchemaAwareEditingHandlerAdapter	Adapter class.
AuthorSchemaAwareEditingHandlerAdapter.WrapInAncestorsOptions	One of the default smart paste strategies involves detecting an path o ancestors from the context element to the inserted one.
AuthorTableColumnWidthProviderBase	This is an interface for classes which are responsible for providing information and handling modifications regarding table and column widths.
AuthorUndoManager	Undo manager for Author edits.
ContentInterval	A content interval containing the inclusive start offset and exclusive end offset.
CustomAttributeValueEditor	A custom editor which gets invoked to edit the value for an attribute.
DefaultAuthorActionEventHandler	Intercepts TAB and SHIFT+TAB events inside a list item and promotes or demotes it.
DITAAuthorActionEventHandler	Author action event handler for DITA.
DITAConrefsResolverBase	Resolve references when showing DITA content in the editor
DocbookAuthorActionEventHandler	Author action event handler for DocBook.
DocumentTypeAdvancedCustomRuleMatcher	Abstract class which can be implemented to provide custom matching to the document type it belongs to.
EditPropertiesHandlerAdapter	Adapter class.
ErrorResolverContextInfo	Class that contains some information about the current error.
ExtensionsBundle	Abstract class representing a bundle for all extensions handlers.
OptionChangedEvent	Represents an event which indicates that the value of an option has been changed.
OptionListener	The listener which is notified about the value changes of an author extension level option.
ProfilingConditionalTextProvider	Profiling/Conditional Text is a way to mark elements meant to appear in some renditions of the document, but not in others.
ReferenceErrorResolverExt	Resolver for errors concerning references.
SpellCheckingProblemInfo
SpellCheckingProblemInfoWithSuggestions
SpellSuggestionsInfo	Container for spellchecking suggestions information.
TEIAuthorActionEventHandler	Author action event handler for TEI.
TooltipIconInfo	The information(tooltip and icon) used to describe the editing of the value for an attribute.
WidthRepresentation	Specifies the fixed and relative width determined from the value of width/colwidth attribute of the col.
XHTMLAuthorActionEventHandler	Author action event handler for XHTML.

Enum Summary

Enum	Description
AuthorActionEventHandler.AuthorActionEventType	Events that are delegated to this handler.
CursorType	Supported cursor types for author.
CustomAttributeValueEditingContext	Provides the contexts for the custom attribute value editing.
ReferenceType	The type of a resource denoted by an URL.
SelectionInterpretationMode	Impose how the selection is interpreted by the application.
WidthRepresentation.Unit	The fixed width unit.
XPathVersion	XPath version types.

Exception Summary

Exception	Description
AuthorOperationException	An exception thrown by an AuthorOperation when it fails.
AuthorOperationStoppedByUserException	An exception thrown by an AuthorOperation when it interacts with the user and the user cancels it.
CancelledByUserException	A custom class used for the exceptions generated by an operation canceled by user.
CustomResolverException	Signals an custom reference that wasn't resolved.
InvalidEditException	Exception thrown by AuthorSchemaAwareEditingHandler methods when an edit is considered invalid and must be rejected.
ReferenceResolverException	Exception thrown if the reference resolver could not resolve a target.
ReferenceResolverSAXParseException	Exception thrown if the reference resolver could not resolve a target.
ValidatingReferenceResolverException	Exception thrown if the source does not accept the target as a resolved reference

Annotation Types Summary

Annotation Type	Description
WebappCompatible	Annotation that should be placed on AuthorOperations to indicate whether they are suitable to be invoked from the WebApp.