Package ro.sync.ecss.extensions.dita.map

Class DITAMapExtensionsBundle

java.lang.Object

ro.sync.ecss.extensions.api.ExtensionsBundle

ro.sync.ecss.extensions.dita.DITAExtensionsBundle

ro.sync.ecss.extensions.dita.map.DITAMapExtensionsBundle

All Implemented Interfaces:

ContextKeyManagerProvider, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class DITAMapExtensionsBundle
extends DITAExtensionsBundle

DITA Map extensions bundle

Field Summary

Fields inherited from class ro.sync.ecss.extensions.dita.DITAExtensionsBundle

keyManager, keyManagerProvider

Constructor Summary

Constructors

Constructor	Description
DITAMapExtensionsBundle()

Method Summary

Modifier and Type	Method	Description
AuthorExtensionStateListener	createAuthorExtensionStateListener()	Returns the AuthorExtensionStateListener which will be notified when the Author extension where it is defined is activated and deactivated during the detection process.
AuthorPreloadProcessor	createAuthorPreloadProcessor()	Returns the AuthorPreloadProcessor which will be notified before the document is presented in the application.
AuthorReferenceResolver	createAuthorReferenceResolver()	Creates a new AuthorReferenceResolver instance used to expand content references.
EditPropertiesHandler	createEditPropertiesHandler()	A custom implementation to handle editing properties of an author node.
ElementLocatorProvider	createElementLocatorProvider()	Creates a new ElementLocatorProvider instance responsible for providing an implementation of an ElementLocator based on the structure of a link.
AuthorExternalObjectInsertionHandler	createExternalObjectInsertionHandler()	Create a handler which gets notified when external resources need to be inserted in the Author page.
TextPageExternalObjectInsertionHandler	createTextPageExternalObjectInsertionHandler()	Create a handler which gets notified when external resources need to be inserted in the Text page.
AuthorSchemaAwareEditingHandler	getAuthorSchemaAwareEditingHandler()	If Schema Aware mode is active in Oxygen, all actions that can generate invalid content will be redirected toward this support.
AuthorTableOperationsHandler	getAuthorTableOperationsHandler()	Get the AuthorTableOperationsHandler instance responsible for handling table operations.
String	getHelpPageID(String currentEditorPage)	Get the help page ID for this particular framework extensions bundle.

Methods inherited from class ro.sync.ecss.extensions.dita.DITAExtensionsBundle

createAuthorTableCellSepProvider, createAuthorTableCellSpanProvider, createAuthorTableColumnWidthProvider, createContextKeyManager, createIDTypeRecognizer, createLinkTextResolver, createSchemaManagerFilter, createXMLNodeCustomizer, customizeImageTooltipDescription, customizeLinkTooltipDescription, getAuthorActionEventHandler, getAuthorImageDecorator, getClipboardFragmentProcessor, getContextKeyManager, getDescription, getDocumentTypeID, getKeyManager, getProfilingConditionalTextProvider, getSpellCheckerHelper, getUniqueAttributesIdentifier, isContentReference, resolveCustomAttributeValue, resolveCustomHref

Methods inherited from class ro.sync.ecss.extensions.api.ExtensionsBundle

createAttributesValueEditor, createAuthorAWTDndListener, createAuthorBreadCrumbCustomizer, createAuthorOutlineCustomizer, createAuthorStylesFilter, createAuthorSWTDndListener, createCustomAttributeValueEditor, createTextSWTDndListener, getDocumentTypeName, getWebappExtensionsProvier, resolveCustomHref, resolveCustomHref, setDocumentTypeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DITAMapExtensionsBundle

public DITAMapExtensionsBundle()

Method Details

createAuthorExtensionStateListener

public AuthorExtensionStateListener createAuthorExtensionStateListener()

Description copied from class: ExtensionsBundle

Returns the AuthorExtensionStateListener which will be notified when the Author extension where it is defined is activated and deactivated during the detection process. This method is called each time the Document Type association where the Author extension and the extensions bundle are defined matches a document opened in an Author page.

Overrides:

createAuthorExtensionStateListener in class DITAExtensionsBundle

Returns:

A new AuthorExtensionStateListener instance.

See Also:

• DITAExtensionsBundle.createAuthorExtensionStateListener()

createAuthorPreloadProcessor

public AuthorPreloadProcessor createAuthorPreloadProcessor()

Description copied from class: ExtensionsBundle

Returns the AuthorPreloadProcessor which will be notified before the document is presented in the application.

Overrides:

createAuthorPreloadProcessor in class ExtensionsBundle

Returns:

A new AuthorPreloadProcessor instance.

See Also:

• ExtensionsBundle.createAuthorPreloadProcessor()

createAuthorReferenceResolver

public AuthorReferenceResolver createAuthorReferenceResolver()

Description copied from class: ExtensionsBundle

Creates a new AuthorReferenceResolver instance used to expand content references. The method is called each time an opened document in an Author editor page matches the document type association where the extensions bundle is defined.

Overrides:

createAuthorReferenceResolver in class DITAExtensionsBundle

Returns:

A new AuthorReferenceResolver instance.

See Also:

• ExtensionsBundle.createAuthorReferenceResolver()

createExternalObjectInsertionHandler

public AuthorExternalObjectInsertionHandler createExternalObjectInsertionHandler()

Description copied from class: ExtensionsBundle

Create a handler which gets notified when external resources need to be inserted in the Author page. The usual usage for this is to get notified when URLs are dropped from the project or DITA Maps manager in the Author page.

Overrides:

createExternalObjectInsertionHandler in class DITAExtensionsBundle

Returns:

The External URLs handler

See Also:

• DITAExtensionsBundle.createExternalObjectInsertionHandler()

createElementLocatorProvider

public ElementLocatorProvider createElementLocatorProvider()

Description copied from class: ExtensionsBundle

Creates a new ElementLocatorProvider instance responsible for providing an implementation of an ElementLocator based on the structure of a link. The ElementLocator is capable of locating an element pointed by the supplied link. This method is called each time an element needs to be located based on a link specification.

Overrides:

createElementLocatorProvider in class DITAExtensionsBundle

Returns:

A new ElementLocatorProvider instance.

See Also:

• DITAExtensionsBundle.createElementLocatorProvider()

getAuthorTableOperationsHandler

public AuthorTableOperationsHandler getAuthorTableOperationsHandler()

Description copied from class: ExtensionsBundle

Get the AuthorTableOperationsHandler instance responsible for handling table operations.

Overrides:

getAuthorTableOperationsHandler in class DITAExtensionsBundle

Returns:

Author table operations handler.

See Also:

• ExtensionsBundle.getAuthorTableOperationsHandler()

createEditPropertiesHandler

public EditPropertiesHandler createEditPropertiesHandler()

Description copied from class: ExtensionsBundle

A custom implementation to handle editing properties of an author node. For example when a user double clicks on an element tag we will invoke this extension and a specific dialog can be presented.

Overrides:

createEditPropertiesHandler in class DITAExtensionsBundle

Returns:

An implementation that can edit the properties of nodes.

See Also:

• ExtensionsBundle.createEditPropertiesHandler()

createTextPageExternalObjectInsertionHandler

public TextPageExternalObjectInsertionHandler createTextPageExternalObjectInsertionHandler()

Description copied from class: ExtensionsBundle

Create a handler which gets notified when external resources need to be inserted in the Text page. The usual usage for this is to get notified when URLs are dropped from the project or DITA Maps manager in the Text page.

Overrides:

createTextPageExternalObjectInsertionHandler in class DITAExtensionsBundle

Returns:

The External URLs handler

See Also:

• DITAExtensionsBundle.createTextPageExternalObjectInsertionHandler()

getHelpPageID

public String getHelpPageID(String currentEditorPage)

Description copied from class: ExtensionsBundle

Get the help page ID for this particular framework extensions bundle. If the returned help page ID is an URL, a web browser will be opened pointing to that URL when the user presses F1 in the dialog or when using the Help button. If the returned help page ID is an identifier, when help is invoked, the application will open the Oxygen User's Manual and locate this identifier inside it.

Overrides:

getHelpPageID in class DITAExtensionsBundle

Parameters:

currentEditorPage - The current editor page mode (Text/Grid/Author/Schema), one of the constants in the "ro.sync.exml.editor.EditorPageConstants" interface.

Returns:

The help page ID, by default no help page ID is returned.

See Also:

• ExtensionsBundle.getHelpPageID(java.lang.String)

getAuthorSchemaAwareEditingHandler

public AuthorSchemaAwareEditingHandler getAuthorSchemaAwareEditingHandler()

Description copied from class: ExtensionsBundle

If Schema Aware mode is active in Oxygen, all actions that can generate invalid content will be redirected toward this support. The support can either resolve a specific case, let the default implementation take place or reject the edit entirely by throwing an InvalidEditException. It is recommended to extend class AuthorSchemaAwareEditingHandlerAdapter in order to be protected from any API additions that may occur in interface AuthorSchemaAwareEditingHandler.

Overrides:

getAuthorSchemaAwareEditingHandler in class DITAExtensionsBundle

Returns:

A custom editing handler for schema aware actions, or null if there is no handler and the default processing should take place.

See Also:

• ExtensionsBundle.getAuthorSchemaAwareEditingHandler()