Package ro.sync.ecss.extensions.xhtml

Class XHTMLExtensionsBundle

java.lang.Object

ro.sync.ecss.extensions.api.ExtensionsBundle

ro.sync.ecss.extensions.xhtml.XHTMLExtensionsBundle

All Implemented Interfaces:

Extension

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

The XHTML framework extensions bundle.

Constructor Summary

Constructors

Constructor	Description
XHTMLExtensionsBundle()

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.
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.
EditPropertiesHandler	createEditPropertiesHandler()	A custom implementation to handle editing properties of an author node.
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.
IDTypeRecognizer	createIDTypeRecognizer()	Creates a new IDTypeRecognizer instance responsible for providing an implementation which can recognize ID declarations and references.
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 or the DITA Map view.
AuthorActionEventHandler	getAuthorActionEventHandler()	Creates a special handler for author actions events (such as key events).
AuthorImageDecorator	getAuthorImageDecorator()	Get an AuthorImageDecorator.
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()
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.
UniqueAttributesRecognizer	getUniqueAttributesIdentifier()	Get an unique attributes creator and identifier.

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

createAttributesValueEditor, createAuthorAWTDndListener, createAuthorBreadCrumbCustomizer, createAuthorOutlineCustomizer, createAuthorPreloadProcessor, createAuthorReferenceResolver, createAuthorStylesFilter, createAuthorSWTDndListener, createAuthorTableCellSepProvider, createCustomAttributeValueEditor, createLinkTextResolver, createTextPageExternalObjectInsertionHandler, createTextSWTDndListener, customizeImageTooltipDescription, customizeLinkTooltipDescription, getAuthorSchemaAwareEditingHandler, getDocumentTypeName, getProfilingConditionalTextProvider, getSpellCheckerHelper, 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

Constructor Details

XHTMLExtensionsBundle

public XHTMLExtensionsBundle()

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

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

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

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

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

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

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

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

createIDTypeRecognizer

public IDTypeRecognizer createIDTypeRecognizer()

Description copied from class: ExtensionsBundle

Creates a new IDTypeRecognizer instance responsible for providing an implementation which can recognize ID declarations and references. This method is called each time an ID must be recognized or certain ID-aware searches or refactory actions are performed.

Overrides:

createIDTypeRecognizer in class ExtensionsBundle

Returns:

A new IDTypeRecognizer instance.

See Also:

• ExtensionsBundle.createIDTypeRecognizer()

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

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)