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

DocBookExtensionsBundleBase()

Method Summary

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.
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.
protected abstract java.lang.String	getDocumentNamespace()
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, createAuthorExtensionStateListener, createAuthorOutlineCustomizer, createAuthorReferenceResolver, createAuthorStylesFilter, createAuthorSWTDndListener, createElementLocatorProvider, createExternalObjectInsertionHandler, createTextSWTDndListener, getAuthorSchemaAwareEditingHandler, getAuthorTableOperationsHandler, getClipboardFragmentProcessor, getDocumentTypeID, getDocumentTypeName, getProfilingConditionalTextProvider, getUniqueAttributesIdentifier, isContentReference, 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 Detail

DocBookExtensionsBundleBase

public DocBookExtensionsBundleBase()

Method Detail

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

getDocumentNamespace

protected abstract java.lang.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.

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

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)