Package ro.sync.ecss.extensions.dita

Class DITAValExtensionsBundle

java.lang.Object

ro.sync.ecss.extensions.api.ExtensionsBundle

ro.sync.ecss.extensions.dita.DITAValExtensionsBundle

All Implemented Interfaces:

Extension

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

The DITAVal extensions bundle

Constructor Summary

Constructors

Constructor	Description
DITAValExtensionsBundle()

Method Summary

Modifier and Type	Method	Description
SchemaManagerFilter	createSchemaManagerFilter()	Creates a new SchemaManagerFilter instance used to filter the content completion proposals from the schema manager.
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.

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

createAttributesValueEditor, createAuthorAWTDndListener, createAuthorBreadCrumbCustomizer, createAuthorExtensionStateListener, createAuthorOutlineCustomizer, createAuthorPreloadProcessor, createAuthorReferenceResolver, createAuthorStylesFilter, createAuthorSWTDndListener, createAuthorTableCellSepProvider, createAuthorTableCellSpanProvider, createAuthorTableColumnWidthProvider, createCustomAttributeValueEditor, createEditPropertiesHandler, createElementLocatorProvider, createExternalObjectInsertionHandler, createIDTypeRecognizer, createLinkTextResolver, createTextPageExternalObjectInsertionHandler, createTextSWTDndListener, createXMLNodeCustomizer, customizeImageTooltipDescription, customizeLinkTooltipDescription, getAuthorActionEventHandler, getAuthorImageDecorator, getAuthorSchemaAwareEditingHandler, getAuthorTableOperationsHandler, getClipboardFragmentProcessor, getDocumentTypeName, getProfilingConditionalTextProvider, getSpellCheckerHelper, 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

Constructor Details

DITAValExtensionsBundle

public DITAValExtensionsBundle()

Method Details

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

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

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)