Package ro.sync.ecss.extensions.api

Class ExtensionsBundle

java.lang.Object
ro.sync.ecss.extensions.api.ExtensionsBundle
All Implemented Interfaces:
Extension
Direct Known Subclasses:
AntExtensionsBundle, DITAExtensionsBundle, DITAValExtensionsBundle, DocBookExtensionsBundleBase, DOTProjectExtensionsBundle, SchematronExtensionsBundle, TEIExtensionsBundleBase, WSDLExtensionsBundle, XHTMLExtensionsBundle, XSDExtensionsBundle, XSLTExtensionsBundle
@API(type=EXTENDABLE, src=PUBLIC) public abstract class ExtensionsBundle extends Object implements Extension
Abstract class representing a bundle for all extensions handlers. Extensions of this class must be defined for every document type association defined in the Preferences/Document type association section.
The bundle is created each time the document type association where it is defined matches the current document opened in an editor or the properties of the enclosing document type have been modified while the document type is active. At most one instance of an extensions bundle exist at a given time in the editor.
Note: References to objects that need to be persistent throughout the existence of an editor must not be kept here..

  • Constructor Details

    • ExtensionsBundle

      public ExtensionsBundle()

  • Method Details

    • createAuthorReferenceResolver

      public AuthorReferenceResolver createAuthorReferenceResolver()
      Creates a new AuthorReferenceResolver instance used to expand content references. The method is called each time an opened document in an Author editor page matches the document type association where the extensions bundle is defined.
      Returns:
      A new AuthorReferenceResolver instance.

    • createAuthorStylesFilter

      public StylesFilter createAuthorStylesFilter()

      Creates a new StylesFilter instance for the CSS styles filtering.

      Use this to replace the default styles associated to a node form the document object model, or the styles of the pseudo elements :before and :after.

      The method is called each time an opened document in an Author editor page matches the document type association where the extensions bundle is defined.

      Returns:
      A new StylesFilter instance, or null.

    • createAuthorTableCellSpanProvider

      public AuthorTableCellSpanProvider createAuthorTableCellSpanProvider()
      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.
      Returns:
      A new AuthorTableCellSpanProvider instance.

    • createAuthorTableColumnWidthProvider

      public AuthorTableColumnWidthProvider createAuthorTableColumnWidthProvider()
      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.
      Returns:
      A new AuthorTableColumnWidthProvider instance.

    • createAuthorTableCellSepProvider

      public AuthorTableCellSepProvider createAuthorTableCellSepProvider()
      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.
      Returns:
      A new AuthorTableCellSepProvider instance.

    • getAuthorTableOperationsHandler

      public AuthorTableOperationsHandler getAuthorTableOperationsHandler()
      Get the AuthorTableOperationsHandler instance responsible for handling table operations.
      Returns:
      Author table operations handler.
      Since:
      14

    • createAuthorExtensionStateListener

      public 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. 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.
      Returns:
      A new AuthorExtensionStateListener instance.

    • createAuthorPreloadProcessor

      public AuthorPreloadProcessor createAuthorPreloadProcessor()
      Returns the AuthorPreloadProcessor which will be notified before the document is presented in the application.
      Returns:
      A new AuthorPreloadProcessor instance.
      Since:
      23.0

    • createAuthorAWTDndListener

      public AuthorDnDListener createAuthorAWTDndListener()
      Creates a new AuthorDnDListener instance responsible for handling AWT author drag and drop events. This method is called each time the Document Type association where the extensions bundle is defined matches a document opened in an Author page.
      Returns:
      The AWT drag and drop listener implementation.

    • createAuthorSWTDndListener

      public AuthorDnDListener createAuthorSWTDndListener()
      Creates a new AuthorDnDListener instance responsible for handling SWT author drag and drop events. This method is called each time the Document Type association where the extensions bundle is defined matches a document opened in an Author page.
      Returns:
      The SWT drag and drop listener implementation.

    • createTextSWTDndListener

      public TextDnDListener createTextSWTDndListener()
      Creates a new TextDnDListener instance responsible for handling SWT text drag and drop events. This method is called each time the Document Type association where the extensions bundle is defined matches a document opened in a Text page.
      Returns:
      The SWT drag and drop listener implementation.

    • createElementLocatorProvider

      public ElementLocatorProvider createElementLocatorProvider()
      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.
      Returns:
      A new ElementLocatorProvider instance.

    • createIDTypeRecognizer

      public IDTypeRecognizer createIDTypeRecognizer()
      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.
      Returns:
      A new IDTypeRecognizer instance.

    • createSchemaManagerFilter

      public SchemaManagerFilter createSchemaManagerFilter()
      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.
      Returns:
      A new SchemaManagerFilter instance.

    • createAttributesValueEditor

      public AttributesValueEditor createAttributesValueEditor(boolean forEclipsePlugin)
      Creates a new AttributesValueEditor instance used to get values for the current attribute. This is used especially from the "Attributes View" and from attributes editing dialogs available on Author mode and Outliner.
      Parameters:
      forEclipsePlugin - If true the code is called from the Eclipse plugin.
      Returns:
      A new AttributesValueEditor instance.

    • createCustomAttributeValueEditor

      public CustomAttributeValueEditor createCustomAttributeValueEditor(boolean forEclipsePlugin)
      Creates a new CustomAttributeValueEditor instance used to get values for the current attribute. This is used especially from the "Attributes View" and from attributes editing dialogs available on Author mode and Outliner.
      Parameters:
      forEclipsePlugin - If true the code is called from the Eclipse plugin.
      Returns:
      A new CustomAttributeValueEditor instance.
      Since:
      15

    • getUniqueAttributesIdentifier

      public UniqueAttributesRecognizer getUniqueAttributesIdentifier()
      Get an unique attributes creator and identifier.
      Returns:
      The unique attributes identifier

    • getClipboardFragmentProcessor

      public ClipboardFragmentProcessor getClipboardFragmentProcessor()
      Get a processor for Author Document Fragments in the clipboard (which will be pasted, dropped, etc).
      Returns:
      a processor for Author Document Fragments in the clipboard (which will be pasted, dropped, etc).
      Since:
      12.2

    • getDocumentTypeID

      public abstract String getDocumentTypeID()
      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.
      Returns:
      The unique identifier of the Document Type.

    • resolveCustomAttributeValue

      public URL resolveCustomAttributeValue(CustomAttributeValueContext attributeValueEditingContext)
      Resolve a custom attribute value to an URL which will be opened by Oxygen. This method is called when the "Open File at Cursor" action is called in the Text editor page.
      Parameters:
      attributeValueEditingContext - The editing context.
      Returns:
      The URL which should be opened as a result of "Open File at Cursor" being invoked on the attribute value.
      Since:
      22

    • resolveCustomHref

      public URL resolveCustomHref(String linkHref) throws IOException
      When clicking a href the bundle can custom solve the href to an URL.
      Parameters:
      linkHref - The link href as derrived from the CSS
      Returns:
      The resolved absolute URL if null if the default behavior will be performed
      Throws:
      IOException - If the link is recognized by the extensions bundle, but could not be mapped to an URL.

    • resolveCustomHref

      public URL resolveCustomHref(URL currentEditorURL, String linkHref, AuthorAccess authorAccess) throws IOException
      When clicking a href the bundle can custom solve the href to an URL.
      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:
      IOException - If the link is recognized by the extensions bundle, but could not be mapped to an URL.

    • resolveCustomHref

      public URL resolveCustomHref(URL currentEditorURL, AuthorNode contextNode, String linkHref, AuthorAccess authorAccess) throws CustomResolverException, IOException
      When clicking a href the bundle can custom solve the href to an URL.
      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.
      Since:
      15

    • customizeLinkTooltipDescription

      public String customizeLinkTooltipDescription(URL currentEditorURL, AuthorNode contextNode, String linkHref, AuthorAccess authorAccess, String computedDescription)
      Customize the tooltip description when hovering over a link.
      Parameters:
      currentEditorURL - The current document URL
      contextNode - The context node
      linkHref - The link href.
      authorAccess - The Author access
      computedDescription - The already computed description. Usually something like: "Click to open: URL"
      Returns:
      The customized description.
      Since:
      22.1

    • customizeImageTooltipDescription

      public String customizeImageTooltipDescription(AuthorNode contextNode, AuthorAccess authorAccess, String computedDescription)
      Customize the tooltip description when hovering over an image.
      Parameters:
      contextNode - The context node
      authorAccess - The Author access
      computedDescription - The already computed description.
      Returns:
      The customized description.
      Since:
      27

      *********************************
      EXPERIMENTAL - Subject to change
      ********************************

      Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

    • createAuthorOutlineCustomizer

      public AuthorOutlineCustomizer createAuthorOutlineCustomizer()
      Create an Author Outline customizer used for custom filtering and nodes rendering in the Outline.
      Returns:
      The Author Outline customizer.

    • createAuthorBreadCrumbCustomizer

      public AuthorBreadCrumbCustomizer createAuthorBreadCrumbCustomizer()
      Create an Author Bread Crumb customizer used for nodes rendering in the Bread Crumb (components path which appears in the top of the Author editor).
      Returns:
      The Author Bread Crumb customizer.

    • getAuthorSchemaAwareEditingHandler

      public AuthorSchemaAwareEditingHandler getAuthorSchemaAwareEditingHandler()
      If Schema Aware mode is active in Oxygen, all actions that can generate invalid content will be redirected toward this support. The support can either resolve a specific case, let the default implementation take place or reject the edit entirely by throwing an InvalidEditException. It is recommended to extend class AuthorSchemaAwareEditingHandlerAdapter in order to be protected from any API additions that may occur in interface AuthorSchemaAwareEditingHandler.
      Returns:
      A custom editing handler for schema aware actions, or null if there is no handler and the default processing should take place.

    • createExternalObjectInsertionHandler

      public AuthorExternalObjectInsertionHandler createExternalObjectInsertionHandler()
      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.
      Returns:
      The External URLs handler
      Since:
      12

    • createTextPageExternalObjectInsertionHandler

      public TextPageExternalObjectInsertionHandler createTextPageExternalObjectInsertionHandler()
      Create a handler which gets notified when external resources need to be inserted in the Text page. The usual usage for this is to get notified when URLs are dropped from the project or DITA Maps manager in the Text page.
      Returns:
      The External URLs handler
      Since:
      19

    • getDocumentTypeName

      public String getDocumentTypeName()
      Get the name of the document type which created this bundle (as set in the Oxygen -> Preferences -> Document Types. You can use it in your extensions bundle to see the name of the document type which created this bundle.
      Returns:
      the name of the document type.
      Since:
      12

    • setDocumentTypeName

      public void setDocumentTypeName(String documentTypeName)
      Set the name of the document type which created this bundle. This must not get called by the user code, it is set internal.
      Parameters:
      documentTypeName - The name of the document type which created this bundle

    • isContentReference

      public boolean isContentReference(AuthorNode node)
      Check if this node references another node which should replace it entirely. This is used in the tables to replace conreffed table rows entirely
      Parameters:
      node - The node
      Returns:
      true if this node references another node which should replace it entirely.

    • getProfilingConditionalTextProvider

      public ProfilingConditionalTextProvider getProfilingConditionalTextProvider()
      Creates a new ProfilingConditionalTextProvider instance responsible for providing custom support regarding profiling and conditional text.
      Returns:
      A new ProfilingConditionalTextProvider instance.
      Since:
      13.2

    • createXMLNodeCustomizer

      public 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.
      Returns:
      The XML node customizer.
      Since:
      13.2

    • createLinkTextResolver

      public 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. 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.
      Returns:
      A new LinkTextResolver instance.
      Since:
      14.2

    • createEditPropertiesHandler

      public EditPropertiesHandler createEditPropertiesHandler()
      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.
      Returns:
      An implementation that can edit the properties of nodes.
      Since:
      17.1

    • getAuthorActionEventHandler

      public AuthorActionEventHandler getAuthorActionEventHandler()
      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.
      Returns:
      An event handler.
      Since:
      18

    • getAuthorImageDecorator

      public AuthorImageDecorator getAuthorImageDecorator()
      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.
      Returns:
      An AuthorImageDecorator, or null.
      Since:
      18

    • getHelpPageID

      public String getHelpPageID(String currentEditorPage)
      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.
      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.
      Since:
      18.1
      See Also:

    • getWebappExtensionsProvier

      public WebappExtensionsProvider getWebappExtensionsProvier()
      Returns:
      An object that provides Web Author specific extensions, may be null.
      Since:
      21.1

    • getSpellCheckerHelper

      public SpellCheckerHelper getSpellCheckerHelper()
      Get a helper for the spell checker.
      Returns:
      Helper utilities implemented at framework level.
      Since:
      26.1