ro.sync.exml.workspace.api.standalone
Interface ReferencesCustomizer

All Known Subinterfaces:

StandalonePluginWorkspace

All Known Implementing Classes:

AuthorComponentFactory, AuthorComponentFactoryCustomizers

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface ReferencesCustomizer

Contains methods for customizing the Input URL Choosers and for computing relative paths from URLs in an implementation specific manner.

Since:

13

*********************************
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.

Method Summary

void	addInputURLChooserCustomizer(InputURLChooserCustomizer inputURLChooserCustomizer) Adds a customizer which can modify the list of "Browse" actions.
void	addRelativeReferencesResolver(java.lang.String protocol, RelativeReferenceResolver resolver) Add a relative reference resolver for a certain URL protocol.

Method Detail

addInputURLChooserCustomizer

void addInputURLChooserCustomizer(InputURLChooserCustomizer inputURLChooserCustomizer)

Adds a customizer which can modify the list of "Browse" actions. These actions are available in Oxygen, in any control or dialog that contains an URL input box.
IMPORTANT This customizer must be set early, when the plugin extension's applicationStarted method gets called or after the AuthorComponentFactory was initialized (if running the Author component).
Example: If a CMS developer wants the user to choose the URL from their custom CMS chooser then it will add a new action (possibly removing the others). When the new action gets called the custom code shows the custom chooser and at the end it can call the ro.sync.exml.workspace.api.standalone.InputURLChooser interface to set the new URL in the combo box.

Parameters:

inputURLChooserCustomizer - The input URL chooser customizer.

Since:

12.1

addRelativeReferencesResolver

void addRelativeReferencesResolver(java.lang.String protocol,
                                   RelativeReferenceResolver resolver)

Add a relative reference resolver for a certain URL protocol. This method can be used by a CMS implementor to take control over the way Oxygen is computing relative references for a certain URL protocol. For example when inserting in a DITA Topic a reference to an image Oxygen will try to make the reference relative to the current XML document. If the DITA Topic is opened using your custom URL protocol you can take control over they way in which the relative path is computed.

Parameters:

protocol - The URL protocol for which you want to take control over the relativization.

resolver - The custom resolver.

Since:

12.2