Package ro.sync.ecss.extensions.tei

Class TEIExtensionsBundleBase

java.lang.Object

ro.sync.ecss.extensions.api.ExtensionsBundle

ro.sync.ecss.extensions.tei.TEIExtensionsBundleBase

All Implemented Interfaces:

Extension

Direct Known Subclasses:

TEI_jteiExtensionsBundle, TEIP5ExtensionsBundle

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

The TEI framework extensions bundle.

Constructor Summary

Constructors

Constructor	Description
TEIExtensionsBundleBase()

Method Summary

Modifier and Type	Method	Description
AuthorTableCellSpanProvider	createAuthorTableCellSpanProvider()	Creates a new AuthorTableCellSpanProvider instance responsible for providing information about the table cells spanning.
EditPropertiesHandler	createEditPropertiesHandler()	A custom implementation to handle editing properties of an author node.
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 or the DITA Map view.
AuthorActionEventHandler	getAuthorActionEventHandler()	Creates a special handler for author actions events (such as key events).
AuthorImageDecorator	getAuthorImageDecorator()	Get an AuthorImageDecorator.
AuthorSchemaAwareEditingHandler	getAuthorSchemaAwareEditingHandler()	If Schema Aware mode is active in Oxygen, all actions that can generate invalid content will be redirected toward this support.
protected abstract String	getDocumentNamespace()
SpellCheckerHelper	getSpellCheckerHelper()	Get a helper for the spell checker.

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

createAttributesValueEditor, createAuthorAWTDndListener, createAuthorBreadCrumbCustomizer, createAuthorExtensionStateListener, createAuthorOutlineCustomizer, createAuthorPreloadProcessor, createAuthorReferenceResolver, createAuthorStylesFilter, createAuthorSWTDndListener, createAuthorTableCellSepProvider, createAuthorTableColumnWidthProvider, createCustomAttributeValueEditor, createElementLocatorProvider, createExternalObjectInsertionHandler, createIDTypeRecognizer, createLinkTextResolver, createSchemaManagerFilter, createTextPageExternalObjectInsertionHandler, createTextSWTDndListener, customizeImageTooltipDescription, customizeLinkTooltipDescription, getAuthorTableOperationsHandler, getClipboardFragmentProcessor, getDocumentTypeID, getDocumentTypeName, getHelpPageID, getProfilingConditionalTextProvider, getUniqueAttributesIdentifier, getWebappExtensionsProvier, isContentReference, resolveCustomAttributeValue, resolveCustomHref, resolveCustomHref, resolveCustomHref, setDocumentTypeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface ro.sync.ecss.extensions.api.Extension

getDescription

Constructor Details

TEIExtensionsBundleBase

public TEIExtensionsBundleBase()

Method Details

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

getDocumentNamespace

protected abstract String getDocumentNamespace()

Returns:

The document namespace.

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

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 or the DITA Map view.

Overrides:

createXMLNodeCustomizer in class ExtensionsBundle

Returns:

The XML node customizer.

See Also:

• ExtensionsBundle.createXMLNodeCustomizer()

getAuthorActionEventHandler

public AuthorActionEventHandler getAuthorActionEventHandler()

Description copied from class: ExtensionsBundle

Creates a special handler for author actions events (such as key events). These events normally have built-in handling but this handler gets a chance to perform something different.

Overrides:

getAuthorActionEventHandler in class ExtensionsBundle

Returns:

An event handler.

See Also:

• ExtensionsBundle.getAuthorActionEventHandler()

getAuthorImageDecorator

public AuthorImageDecorator getAuthorImageDecorator()

Description copied from class: ExtensionsBundle

Get an AuthorImageDecorator. Permits decoration of the images that are displayed in the Author view. For instance it can overlay some meta-information over the image.

Overrides:

getAuthorImageDecorator in class ExtensionsBundle

Returns:

An AuthorImageDecorator, or null.

See Also:

• ExtensionsBundle.getAuthorImageDecorator()

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 ExtensionsBundle

Returns:

An implementation that can edit the properties of nodes.

See Also:

• ExtensionsBundle.createEditPropertiesHandler()

getSpellCheckerHelper

public SpellCheckerHelper getSpellCheckerHelper()

Description copied from class: ExtensionsBundle

Get a helper for the spell checker.

Overrides:

getSpellCheckerHelper in class ExtensionsBundle

Returns:

Helper utilities implemented at framework level.

See Also:

• ExtensionsBundle.getSpellCheckerHelper()