ro.sync.ecss.extensions.dita
Class DITAExtensionsBundle

java.lang.Object
  ro.sync.ecss.extensions.api.ExtensionsBundle
      ro.sync.ecss.extensions.dita.DITAExtensionsBundle

All Implemented Interfaces:

Extension

Direct Known Subclasses:

DITAMapExtensionsBundle

public class DITAExtensionsBundle
extends ExtensionsBundle

The DITA framework extensions bundle.

Constructor Summary

DITAExtensionsBundle()

Method Summary

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.
AuthorReferenceResolver	createAuthorReferenceResolver() Creates a new AuthorReferenceResolver instance used to expand content references.
AuthorTableCellSpanProvider	createAuthorTableCellSpanProvider() Creates a new AuthorTableCellSpanProvider instance responsible for providing information about the table cells spanning.
AuthorTableColumnWidthProvider	createAuthorTableColumnWidthProvider() Creates a new AuthorTableColumnWidthProvider instance responsible for providing information and for handling modifications regarding table width and column widths.
ElementLocatorProvider	createElementLocatorProvider() Creates a new ElementLocatorProvider instance responsible for providing an implementation of an ElementLocator based on the structure of a link.
AuthorSchemaAwareEditingHandler	getAuthorSchemaAwareEditingHandler() If Schema Aware mode is active in Oxygen, all actions that can generate invalid content will be redirected toward this support.
String	getDescription()
String	getDocumentTypeID() This should never return null if the OptionsStorage support it is intended to be used.
UniqueAttributesRecognizer	getUniqueAttributesIdentifier()
URL	resolveCustomHref(String linkHref) When clicking a href the bundle can custom solve the href to an URL

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

createAttributesValueEditor, createAuthorAWTDndListener, createAuthorBreadCrumbCustomizer, createAuthorOutlineCustomizer, createAuthorStylesFilter, createAuthorSWTDndListener, createSchemaManagerFilter, createTextSWTDndListener

Methods inherited from class java.lang.Object

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

Constructor Detail

DITAExtensionsBundle

public DITAExtensionsBundle()

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

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 ExtensionsBundle

Returns:

A new AuthorReferenceResolver instance.

See Also:

ExtensionsBundle.createAuthorReferenceResolver()

createAuthorTableCellSpanProvider

public AuthorTableCellSpanProvider createAuthorTableCellSpanProvider()

Description copied from class: ExtensionsBundle

Creates a new AuthorTableCellSpanProvider instance responsible for providing information about the table cells spanning. The table cell span provider is not reused between different tables. The method is called for each table in the document so a new instance should be provided each time.

Overrides:

createAuthorTableCellSpanProvider in class ExtensionsBundle

Returns:

A new AuthorTableCellSpanProvider instance.

See Also:

ExtensionsBundle.createAuthorTableCellSpanProvider()

createAuthorTableColumnWidthProvider

public AuthorTableColumnWidthProvider createAuthorTableColumnWidthProvider()

Description copied from class: ExtensionsBundle

Creates a new AuthorTableColumnWidthProvider instance responsible for providing information and for handling modifications regarding table width and column widths. The table column width provider is not reused between different tables. The method is called for each table in the document so a new instance should be provided each time.

Overrides:

createAuthorTableColumnWidthProvider in class ExtensionsBundle

Returns:

A new AuthorTableColumnWidthProvider instance.

See Also:

ExtensionsBundle.createAuthorTableColumnWidthProvider()

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

Overrides:

getUniqueAttributesIdentifier in class ExtensionsBundle

Returns:

the unique attributes identifier

See Also:

ExtensionsBundle.getUniqueAttributesIdentifier()

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 ExtensionsBundle

Returns:

A new ElementLocatorProvider instance.

See Also:

ExtensionsBundle.createElementLocatorProvider()

resolveCustomHref

public URL resolveCustomHref(String linkHref)

Description copied from class: ExtensionsBundle

When clicking a href the bundle can custom solve the href to an URL

Overrides:

resolveCustomHref in class ExtensionsBundle

Parameters:

linkHref - The link href as derrived from the CSS

Returns:

The resolved absolute URL if null if the default behavior will be performed

See Also:

ExtensionsBundle.resolveCustomHref(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 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()