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

@API(type=INTERNAL,
     src=PUBLIC)
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.
AuthorExternalObjectInsertionHandler	createExternalObjectInsertionHandler() Create a handler which gets notified when external resources need to be inserted in the Author page.
LinkTextResolver	createLinkTextResolver() Creates a new LinkTextResolver instance responsible for resolving a specific link marked in the CSS file and returning a text content from the targeted location.
SchemaManagerFilter	createSchemaManagerFilter() Creates a new SchemaManagerFilter instance used to filter the content completion proposals from the schema manager.
XMLNodeRendererCustomizer	createXMLNodeCustomizer() Create an XML node customizer used for custom nodes rendering in the Author outline, Text page outline, Author bread crumb, content completion window.
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).
java.lang.String	getDescription()
java.lang.String	getDocumentTypeID() This should never return null if the OptionsStorage support it is intended to be used.
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.
boolean	isContentReference(AuthorNode node) Check if this node references another node which should replace it entirely.
java.net.URL	resolveCustomHref(java.net.URL currentEditorURL, java.lang.String linkHref, AuthorAccess authorAccess) 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, createTextSWTDndListener, getDocumentTypeName, resolveCustomHref, setDocumentTypeName

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

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

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

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 java.net.URL resolveCustomHref(java.net.URL currentEditorURL,
                                      java.lang.String linkHref,
                                      AuthorAccess authorAccess)
                               throws java.io.IOException

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:

currentEditorURL - The URL of the current editor.

linkHref - The link href as derrived from the CSS

authorAccess - The Author Access.

Returns:

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

Throws:

java.io.IOException - If the link is recognized by the extensions bundle, but could not be mapped to an URL.

See Also:

ExtensionsBundle.resolveCustomHref(java.net.URL, java.lang.String, ro.sync.ecss.extensions.api.AuthorAccess)

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

createSchemaManagerFilter

public SchemaManagerFilter createSchemaManagerFilter()

Description copied from class: ExtensionsBundle

Creates a new SchemaManagerFilter instance used to filter the content completion proposals from the schema manager. This method is called each time the document type where the extensions bundle is defined matches a document opened in an editor.

Overrides:

createSchemaManagerFilter in class ExtensionsBundle

Returns:

A new SchemaManagerFilter instance.

See Also:

ExtensionsBundle.createSchemaManagerFilter()

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

isContentReference

public boolean isContentReference(AuthorNode node)

Description copied from class: ExtensionsBundle

Check if this node references another node which should replace it entirely. This is used in the tables to replace conreffed table rows entirely

Overrides:

isContentReference in class ExtensionsBundle

Parameters:

node - The node

Returns:

true if this node references another node which should replace it entirely.

See Also:

ExtensionsBundle.isContentReference(ro.sync.ecss.extensions.api.node.AuthorNode)

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

createXMLNodeCustomizer

public XMLNodeRendererCustomizer createXMLNodeCustomizer()

Description copied from class: ExtensionsBundle

Create an XML node customizer used for custom nodes rendering in the Author outline, Text page outline, Author bread crumb, content completion window.

Overrides:

createXMLNodeCustomizer in class ExtensionsBundle

Returns:

The XML node customizer.

See Also:

ExtensionsBundle.createXMLNodeCustomizer()

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

createLinkTextResolver

public LinkTextResolver createLinkTextResolver()

Description copied from class: ExtensionsBundle

Creates a new LinkTextResolver instance responsible for resolving a specific link marked in the CSS file and returning a text content from the targeted location. This text content will be presented as a static text associated with the link in author page. This resolver will be used when function oxy_linktext() is encountered inside the CSS rules on the 'content' property.

Overrides:

createLinkTextResolver in class ExtensionsBundle

Returns:

A new LinkTextResolver instance.

See Also:

ExtensionsBundle.createLinkTextResolver()