Package ro.sync.ecss.extensions.docbook

Class DocBookExtensionsBundleBase

java.lang.Object

ro.sync.ecss.extensions.api.ExtensionsBundle

ro.sync.ecss.extensions.docbook.DocBookExtensionsBundleBase

All Implemented Interfaces:

Extension

Direct Known Subclasses:

DocBook4ExtensionsBundle, DocBook5ExtensionsBundle

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

The DocBook framework extensions bundle.

Constructor Summary

Constructors

Constructor	Description
DocBookExtensionsBundleBase()

Method Summary

Modifier and Type	Method	Description
AuthorTableCellSepProvider	createAuthorTableCellSepProvider()	Creates a new AuthorTableCellSepProvider instance responsible for providing information about the table cells painting their separators.
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.
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 or the DITA Map view.
AuthorActionEventHandler	getAuthorActionEventHandler()	Creates a special handler for author actions events (such as key events).
AuthorImageDecorator	getAuthorImageDecorator()	Get an AuthorImageDecorator.
protected abstract String	getDocumentNamespace()
SpellCheckerHelper	getSpellCheckerHelper()	Get a helper for the spell checker.
URL	resolveCustomHref(URL currentEditorURL, AuthorNode contextNode, 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, createAuthorExtensionStateListener, createAuthorOutlineCustomizer, createAuthorPreloadProcessor, createAuthorReferenceResolver, createAuthorStylesFilter, createAuthorSWTDndListener, createCustomAttributeValueEditor, createElementLocatorProvider, createExternalObjectInsertionHandler, createIDTypeRecognizer, createTextPageExternalObjectInsertionHandler, createTextSWTDndListener, customizeImageTooltipDescription, customizeLinkTooltipDescription, getAuthorSchemaAwareEditingHandler, getAuthorTableOperationsHandler, getClipboardFragmentProcessor, getDocumentTypeID, getDocumentTypeName, getHelpPageID, getProfilingConditionalTextProvider, getUniqueAttributesIdentifier, getWebappExtensionsProvier, isContentReference, resolveCustomAttributeValue, 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

DocBookExtensionsBundleBase

public DocBookExtensionsBundleBase()

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

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

createAuthorTableCellSepProvider

public AuthorTableCellSepProvider createAuthorTableCellSepProvider()

Description copied from class: ExtensionsBundle

Creates a new AuthorTableCellSepProvider instance responsible for providing information about the table cells painting their separators. The table cell separators 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:

createAuthorTableCellSepProvider in class ExtensionsBundle

Returns:

A new AuthorTableCellSepProvider instance.

See Also:

• ExtensionsBundle.createAuthorTableCellSepProvider()

getDocumentNamespace

protected abstract String getDocumentNamespace()

Returns:

The document namespace.

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

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_link-text() is encountered inside the CSS rules on the 'content' property.

Overrides:

createLinkTextResolver in class ExtensionsBundle

Returns:

A new LinkTextResolver instance.

See Also:

• ExtensionsBundle.createLinkTextResolver()

resolveCustomHref

public URL resolveCustomHref(URL currentEditorURL,
 AuthorNode contextNode,
 String linkHref,
 AuthorAccess authorAccess)
                      throws 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.

contextNode - The context node in which the href needs to be computed.

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:

CustomResolverException - If the link is recognized by the extensions bundle, but could not be mapped to an URL. It offers a solution to the user. This solution is invoked when the user clicks on the error message.

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, ro.sync.ecss.extensions.api.node.AuthorNode, java.lang.String, ro.sync.ecss.extensions.api.AuthorAccess)

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