ro.sync.ecss.extensions.tei

Class TEIP4ExtensionsBundle

java.lang.Object

ro.sync.ecss.extensions.api.ExtensionsBundle

ro.sync.ecss.extensions.tei.TEIExtensionsBundleBase

ro.sync.ecss.extensions.tei.TEIP4ExtensionsBundle

All Implemented Interfaces:

Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class TEIP4ExtensionsBundle
extends TEIExtensionsBundleBase

The TEI P4 framework extensions bundle.

Constructor Summary

Constructors

Constructor and Description
TEIP4ExtensionsBundle()

Method Summary

Modifier and Type	Method and 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.
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).
java.lang.String	getDescription()
protected java.lang.String	getDocumentNamespace()
java.lang.String	getDocumentTypeID() This should never return null if the OptionsStorage support it is intended to be used.
java.lang.String	getHelpPageID(java.lang.String currentEditorPage) Get the help page ID for this particular framework extensions bundle.
UniqueAttributesRecognizer	getUniqueAttributesIdentifier() Get an unique attributes creator and identifier.

Methods inherited from class ro.sync.ecss.extensions.tei.TEIExtensionsBundleBase

createAuthorTableCellSpanProvider, createEditPropertiesHandler, createXMLNodeCustomizer, getAuthorActionEventHandler, getAuthorImageDecorator, getAuthorSchemaAwareEditingHandler

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

createAttributesValueEditor, createAuthorAWTDndListener, createAuthorBreadCrumbCustomizer, createAuthorOutlineCustomizer, createAuthorReferenceResolver, createAuthorStylesFilter, createAuthorSWTDndListener, createAuthorTableCellSepProvider, createAuthorTableColumnWidthProvider, createCustomAttributeValueEditor, createElementLocatorProvider, createIDTypeRecognizer, createLinkTextResolver, createSchemaManagerFilter, createTextSWTDndListener, getDocumentTypeName, getProfilingConditionalTextProvider, isContentReference, resolveCustomHref, resolveCustomHref, resolveCustomHref, setDocumentTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

TEIP4ExtensionsBundle

public TEIP4ExtensionsBundle()

Method Detail

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 java.lang.String getDescription()

Returns:

The description of the extension.

See Also:

Extension.getDescription()

getDocumentTypeID

public java.lang.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 java.lang.String getDocumentNamespace()

Specified by:

getDocumentNamespace in class TEIExtensionsBundleBase

Returns:

The document namespace.

See Also:

TEIExtensionsBundleBase.getDocumentNamespace()

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

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 java.lang.String getHelpPageID(java.lang.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)