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

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

public class AuthorComponentFactory
extends Object

Creates author components

Constructor Summary

AuthorComponentFactory()

Method Summary

AuthorComponentProvider	createAuthorComponentProvider() Creates a new author component
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.
ro.sync.azcheck.ui.SpellCheckOptions	getSpellCheckOptions() Get the spell check options which are currently used for the components.
void	init(URL[] frameworksZIPURLs, URL optionsZipURL, URL appletCodeBase, String appletID, String licenseKey, String licenseHost, int licensePort) This method should get called after registering the license.
void	setObjectProperty(String key, Object value) Sets a property in the Oxygen preferences.
void	setSpellCheckOptions(ro.sync.azcheck.ui.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.

init

public void init(URL[] frameworksZIPURLs,
                 URL optionsZipURL,
                 URL appletCodeBase,
                 String appletID,
                 String licenseKey,
                 String licenseHost,
                 int licensePort)
          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

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

setObjectProperty

public void setObjectProperty(String key,
                              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 ro.sync.azcheck.ui.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(ro.sync.azcheck.ui.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.