Oxygen XML Editor 14.2 Author API

ro.sync.ecss.extensions.xhtml
Class XHTMLExtensionsBundle

java.lang.Object
  extended by ro.sync.ecss.extensions.api.ExtensionsBundle
      extended by 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
XHTMLExtensionsBundle()
           
 
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.
 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.
 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.
 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.
 UniqueAttributesRecognizer getUniqueAttributesIdentifier()
          Get an unique attributes creator and identifier.
 
Methods inherited from class ro.sync.ecss.extensions.api.ExtensionsBundle
createAttributesValueEditor, createAuthorAWTDndListener, createAuthorBreadCrumbCustomizer, createAuthorOutlineCustomizer, createAuthorReferenceResolver, createAuthorStylesFilter, createAuthorSWTDndListener, createLinkTextResolver, createTextSWTDndListener, getAuthorSchemaAwareEditingHandler, getDocumentTypeName, getProfilingConditionalTextProvider, isContentReference, resolveCustomHref, resolveCustomHref, setDocumentTypeName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XHTMLExtensionsBundle

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

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

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.

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

Oxygen XML Editor 14.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.