Package ro.sync.ecss.extensions.docbook

Class DocBook5ExtensionsBundle

java.lang.Object

ro.sync.ecss.extensions.api.ExtensionsBundle

ro.sync.ecss.extensions.docbook.DocBookExtensionsBundleBase

ro.sync.ecss.extensions.docbook.DocBook5ExtensionsBundle

All Implemented Interfaces:

Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class DocBook5ExtensionsBundle
extends DocBookExtensionsBundleBase

The DocBook 5 framework extensions bundle.

Constructor Summary

Constructors

Constructor	Description
DocBook5ExtensionsBundle()

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.
AuthorExternalObjectInsertionHandler	createExternalObjectInsertionHandler()	Create a handler which gets notified when external resources need to be inserted in the Author 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.
ClipboardFragmentProcessor	getClipboardFragmentProcessor()	Get a processor for Author Document Fragments in the clipboard (which will be pasted, dropped, etc).
String	getDescription()
protected String	getDocumentNamespace()
String	getDocumentTypeID()	This should never return null if the OptionsStorage support it is intended to be used.
String	getHelpPageID(String currentEditorPage)	Get the help page ID for this particular framework extensions bundle.
ProfilingConditionalTextProvider	getProfilingConditionalTextProvider()	Creates a new ProfilingConditionalTextProvider instance responsible for providing custom support regarding profiling and conditional text.
UniqueAttributesRecognizer	getUniqueAttributesIdentifier()	Get an unique attributes creator and identifier.

Methods inherited from class ro.sync.ecss.extensions.docbook.DocBookExtensionsBundleBase

createAuthorTableCellSepProvider, createAuthorTableCellSpanProvider, createAuthorTableColumnWidthProvider, createEditPropertiesHandler, createLinkTextResolver, createSchemaManagerFilter, createXMLNodeCustomizer, getAuthorActionEventHandler, getAuthorImageDecorator, getSpellCheckerHelper, resolveCustomHref

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

createAttributesValueEditor, createAuthorAWTDndListener, createAuthorBreadCrumbCustomizer, createAuthorOutlineCustomizer, createAuthorPreloadProcessor, createAuthorReferenceResolver, createAuthorStylesFilter, createAuthorSWTDndListener, createCustomAttributeValueEditor, createElementLocatorProvider, createIDTypeRecognizer, createTextPageExternalObjectInsertionHandler, createTextSWTDndListener, customizeImageTooltipDescription, customizeLinkTooltipDescription, getDocumentTypeName, getWebappExtensionsProvier, isContentReference, resolveCustomAttributeValue, resolveCustomHref, resolveCustomHref, setDocumentTypeName

Methods inherited from class java.lang.Object

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

Constructor Details

DocBook5ExtensionsBundle

public DocBook5ExtensionsBundle()

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 ExtensionsBundle

Returns:

A new AuthorExtensionStateListener instance.

See Also:

• ExtensionsBundle.createAuthorExtensionStateListener()

getDescription

public String getDescription()

Returns:

The description of the extension.

See Also:

• Extension.getDescription()

getDocumentTypeID

public String getDocumentTypeID()

Description copied from class: ExtensionsBundle

This should never return null if the OptionsStorage support it is intended to be used. If this returns null you will not be able to add OptionListener or store and retrieve any options at all.

Specified by:

getDocumentTypeID in class ExtensionsBundle

Returns:

The unique identifier of the Document Type.

See Also:

• ExtensionsBundle.getDocumentTypeID()

getUniqueAttributesIdentifier

public UniqueAttributesRecognizer getUniqueAttributesIdentifier()

Description copied from class: ExtensionsBundle

Get an unique attributes creator and identifier.

Overrides:

getUniqueAttributesIdentifier in class ExtensionsBundle

Returns:

The unique attributes identifier

See Also:

• ExtensionsBundle.getUniqueAttributesIdentifier()

getClipboardFragmentProcessor

public ClipboardFragmentProcessor getClipboardFragmentProcessor()

Description copied from class: ExtensionsBundle

Get a processor for Author Document Fragments in the clipboard (which will be pasted, dropped, etc).

Overrides:

getClipboardFragmentProcessor in class ExtensionsBundle

Returns:

a processor for Author Document Fragments in the clipboard (which will be pasted, dropped, etc).

See Also:

• ExtensionsBundle.getClipboardFragmentProcessor()

getDocumentNamespace

protected String getDocumentNamespace()

Specified by:

getDocumentNamespace in class DocBookExtensionsBundleBase

Returns:

The document namespace.

See Also:

• DocBookExtensionsBundleBase.getDocumentNamespace()

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 ExtensionsBundle

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()

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 ExtensionsBundle

Returns:

The External URLs handler

See Also:

• ExtensionsBundle.createExternalObjectInsertionHandler()

getProfilingConditionalTextProvider

public ProfilingConditionalTextProvider getProfilingConditionalTextProvider()

Description copied from class: ExtensionsBundle

Creates a new ProfilingConditionalTextProvider instance responsible for providing custom support regarding profiling and conditional text.

Overrides:

getProfilingConditionalTextProvider in class ExtensionsBundle

Returns:

A new ProfilingConditionalTextProvider instance.

See Also:

• ExtensionsBundle.getProfilingConditionalTextProvider()

getAuthorTableOperationsHandler

public AuthorTableOperationsHandler getAuthorTableOperationsHandler()

Description copied from class: ExtensionsBundle

Get the AuthorTableOperationsHandler instance responsible for handling table operations.

Overrides:

getAuthorTableOperationsHandler in class ExtensionsBundle

Returns:

Author table operations handler.

See Also:

• ExtensionsBundle.getAuthorTableOperationsHandler()

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 ExtensionsBundle

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)