Oxygen XML Editor 13.2 Author API

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

java.lang.Object
  extended by ro.sync.ecss.extensions.api.component.AuthorComponentFactory
All Implemented Interfaces:
ReferencesCustomizer

@API(type=NOT_EXTENDABLE,
     src=PRIVATE)
public class AuthorComponentFactory
extends java.lang.Object
implements ReferencesCustomizer

Creates author components


Constructor Summary
AuthorComponentFactory()
           
 
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.
 AuthorComponentProvider createAuthorComponentProvider()
          Creates a new author component
 void dispose()
          It is advisable to call this method when the Author Component Factory is no longer in use.
 void disposeAuthorComponentProvider(AuthorComponentProvider provider)
          Remove the handlers the factory has to the component used to notify for changes.
static AuthorComponentFactory getInstance()
          Get the singleton instance.
 SpellCheckOptions getSpellCheckOptions()
          Get the spell check options which are currently used for the components.
 void init(java.net.URL[] frameworksZIPURLs, java.net.URL optionsZipURL, java.net.URL appletCodeBase, java.lang.String appletID, java.lang.String licenseKey)
          This method should get called after registering the license.
 void init(java.net.URL[] frameworksZIPURLs, java.net.URL optionsZipURL, java.net.URL appletCodeBase, java.lang.String appletID, java.lang.String serverHost, int serverPort)
          This method should get called after registering the license.
 void init(java.net.URL[] frameworksZIPURLs, java.net.URL optionsZipURL, java.net.URL appletCodeBase, java.lang.String appletID, java.lang.String licenseKey, java.lang.String licenseHost, int licensePort)
          Deprecated. Use init(URL[], URL, URL, String, String, LicenseServerInformation) or init(URL[], URL, URL, String, String) instead.
 void init(java.net.URL[] frameworksZIPURLs, java.net.URL optionsZipURL, java.net.URL appletCodeBase, java.lang.String appletID, java.lang.String servletURL, java.lang.String userName, java.lang.String password)
          This method should get called after registering the license.
 void setObjectProperty(java.lang.String key, java.lang.Object value)
          Sets a property in the Oxygen preferences.
 void setOpenURLHandler(OpenURLHandler openURLHandler)
          Set a handler which will be notified when an URL should be opened.
 void setSpellCheckOptions(SpellCheckOptions newSpellCheckOptions)
          Set the spell check options which are currently used for the components.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AuthorComponentFactory

public AuthorComponentFactory()
Method Detail

getInstance

public static AuthorComponentFactory getInstance()
Get the singleton instance.

Returns:
The singleton instance.

dispose

public void dispose()
It is advisable to call this method when the Author Component Factory is no longer in use. For example, if the author component is using a floating license, this method should get called in the applet when the destroy() callback is received in order to quickly release the license to the license server.

Since:
13.2

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


init

@Deprecated
public void init(java.net.URL[] frameworksZIPURLs,
                            java.net.URL optionsZipURL,
                            java.net.URL appletCodeBase,
                            java.lang.String appletID,
                            java.lang.String licenseKey,
                            java.lang.String licenseHost,
                            int licensePort)
          throws AuthorComponentException
Deprecated. Use init(URL[], URL, URL, String, String, LicenseServerInformation) or init(URL[], URL, URL, String, String) instead.

This method should get called after registering the license. Initialize the component. Will have effect only once.

Parameters:
frameworksZIPURLs - The set of ZIPs which contain the frameworks
optionsZipURL - URL to the options ZIP.
appletCodeBase - Code base when run from an applet, can be null when using the author component in a standalone application
appletID - ID when run from Applet, can be null, used to store the frameworks associated with the applet.
licenseKey - The license key to use with the Oxygen Author component
licenseHost - If license key is missing, the license can be floating and the license host and port can be specified, else they are ignored
licensePort - If license key is missing, the license can be floating and the license host and port can be specified, else they are ignored
Throws:
AuthorComponentException

init

public void init(java.net.URL[] frameworksZIPURLs,
                 java.net.URL optionsZipURL,
                 java.net.URL appletCodeBase,
                 java.lang.String appletID,
                 java.lang.String licenseKey)
          throws AuthorComponentException
This method should get called after registering the license. Initialize the component. Will have effect only once.

Parameters:
frameworksZIPURLs - The set of ZIPs which contain the frameworks
optionsZipURL - URL to the options ZIP.
appletCodeBase - Code base when run from an applet, can be null when using the author component in a standalone application
appletID - ID when run from Applet, can be null, used to store the frameworks associated with the applet.
licenseKey - The license key to use with the Oxygen Author component
Throws:
AuthorComponentException

init

public void init(java.net.URL[] frameworksZIPURLs,
                 java.net.URL optionsZipURL,
                 java.net.URL appletCodeBase,
                 java.lang.String appletID,
                 java.lang.String serverHost,
                 int serverPort)
          throws AuthorComponentException
This method should get called after registering the license. Initialize the component. Will have effect only once.

Parameters:
frameworksZIPURLs - The set of ZIPs which contain the frameworks
optionsZipURL - URL to the options ZIP.
appletCodeBase - Code base when run from an applet, can be null when using the author component in a standalone application
appletID - ID when run from Applet, can be null, used to store the frameworks associated with the applet.
serverHost - The license key to use with the Oxygen Author component
serverPort - If license key is missing, the license can be floating and the license server information can be specified, else they are ignored
Throws:
AuthorComponentException
Since:
12.1

init

public void init(java.net.URL[] frameworksZIPURLs,
                 java.net.URL optionsZipURL,
                 java.net.URL appletCodeBase,
                 java.lang.String appletID,
                 java.lang.String servletURL,
                 java.lang.String userName,
                 java.lang.String password)
          throws AuthorComponentException
This method should get called after registering the license. Initialize the component. Will have effect only once.

Parameters:
frameworksZIPURLs - The set of ZIPs which contain the frameworks
optionsZipURL - URL to the options ZIP.
appletCodeBase - Code base when run from an applet, can be null when using the author component in a standalone application
appletID - ID when run from Applet, can be null, used to store the frameworks associated with the applet.
servletURL - The URL to connect to a HTTP license server
userName - User name to connect to the license server.
password - Password to connect to the license server.
Throws:
AuthorComponentException
Since:
12.1

setObjectProperty

public void setObjectProperty(java.lang.String key,
                              java.lang.Object value)
Sets a property in the Oxygen preferences.

Parameters:
key - The key from the Oxygen options
value - Value for the key.

createAuthorComponentProvider

public AuthorComponentProvider createAuthorComponentProvider()
                                                      throws AuthorComponentException
Creates a new author component

Returns:
the new author component
Throws:
AuthorComponentException

disposeAuthorComponentProvider

public void disposeAuthorComponentProvider(AuthorComponentProvider provider)
Remove the handlers the factory has to the component used to notify for changes. It is important to call this method when creating multiple author components in a multiple editor component where editors are sometimes closed. When an editor is closed, this method should get called in order to avoid memory leaks.

Parameters:
provider - The provider to release.

getSpellCheckOptions

public SpellCheckOptions getSpellCheckOptions()
Get the spell check options which are currently used for the components.

Returns:
the spell check options which are currently used for the components.

setSpellCheckOptions

public void setSpellCheckOptions(SpellCheckOptions newSpellCheckOptions)
Set the spell check options which are currently used for the components. All options can be changed except the spell checker which is fixed to Hunspell.

Parameters:
newSpellCheckOptions - The new spell check options to set.

setOpenURLHandler

public void setOpenURLHandler(OpenURLHandler openURLHandler)
Set a handler which will be notified when an URL should be opened. For example the user clicked a link in the Author page.

Parameters:
openURLHandler - The open URLs handler.
Since:
12.2

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

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

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

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

Oxygen XML Editor 13.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2012.