ro.sync.ecss.extensions.api.component
Class AuthorComponentFactoryCustomizers

java.lang.Object
  ro.sync.ecss.extensions.api.component.AuthorComponentFactoryCustomizers

All Implemented Interfaces:

ReferencesCustomizer, ro.sync.exml.workspace.impl.standalone.RelativeReferenceResolversProvider, ro.sync.exml.workspace.impl.standalone.URLChooserCustomizersProvider

@API(type=INTERNAL,
     src=PRIVATE)
public class AuthorComponentFactoryCustomizers
extends java.lang.Object
implements ReferencesCustomizer, ro.sync.exml.workspace.impl.standalone.RelativeReferenceResolversProvider, ro.sync.exml.workspace.impl.standalone.URLChooserCustomizersProvider

Customizers for the author component factory.

Constructor Summary

AuthorComponentFactoryCustomizers()

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.
java.util.List<RelativeReferenceResolver>	getRelativeReferenceResolvers(java.lang.String protocol)
java.util.List<InputURLChooserCustomizer>	getUrlChooserCustomizers()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthorComponentFactoryCustomizers

public AuthorComponentFactoryCustomizers()

Method Detail

addRelativeReferencesResolver

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

Description copied from interface: ReferencesCustomizer

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.

Specified by:

addRelativeReferencesResolver in interface ReferencesCustomizer

Parameters:

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

resolver - The custom resolver.

See Also:

ReferencesCustomizer.addRelativeReferencesResolver(java.lang.String, ro.sync.exml.workspace.api.util.RelativeReferenceResolver)

getRelativeReferenceResolvers

public java.util.List<RelativeReferenceResolver> getRelativeReferenceResolvers(java.lang.String protocol)

Specified by:

getRelativeReferenceResolvers in interface ro.sync.exml.workspace.impl.standalone.RelativeReferenceResolversProvider

See Also:

RelativeReferenceResolversProvider.getRelativeReferenceResolvers(java.lang.String)

addInputURLChooserCustomizer

public void addInputURLChooserCustomizer(InputURLChooserCustomizer inputURLChooserCustomizer)

Description copied from interface: ReferencesCustomizer

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.

Specified by:

addInputURLChooserCustomizer in interface ReferencesCustomizer

Parameters:

inputURLChooserCustomizer - The input URL chooser customizer.

See Also:

ReferencesCustomizer.addInputURLChooserCustomizer(ro.sync.exml.workspace.api.standalone.InputURLChooserCustomizer)

getUrlChooserCustomizers

public java.util.List<InputURLChooserCustomizer> getUrlChooserCustomizers()

Specified by:

getUrlChooserCustomizers in interface ro.sync.exml.workspace.impl.standalone.URLChooserCustomizersProvider

Returns:

Returns the urlChooserCustomizers.