|
Oxygen XML Editor, Version 13.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectro.sync.ecss.extensions.api.component.AuthorComponentFactory
@API(type=NOT_EXTENDABLE, src=PRIVATE) public class AuthorComponentFactory
Creates author components
Constructor Summary | |
---|---|
AuthorComponentFactory()
|
Method Summary | |
---|---|
void |
addInputURLChooserCustomizer(ro.sync.exml.workspace.api.standalone.InputURLChooserCustomizer inputURLChooserCustomizer)
|
void |
addRelativeReferencesResolver(java.lang.String protocol,
ro.sync.exml.workspace.api.util.RelativeReferenceResolver resolver)
|
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. |
ro.sync.azcheck.ui.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 or
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(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 |
---|
public AuthorComponentFactory()
Method Detail |
---|
public static AuthorComponentFactory getInstance()
public void dispose()
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.
@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
init(URL[], URL, URL, String, String, LicenseServerInformation)
or
init(URL[], URL, URL, String, String)
instead.
frameworksZIPURLs
- The set of ZIPs which contain the frameworksoptionsZipURL
- URL to the options ZIP.appletCodeBase
- Code base when run from an applet, can be null when using the author component in a standalone applicationappletID
- 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 componentlicenseHost
- If license key is missing, the license can be floating and the license host and port can be specified, else they are ignoredlicensePort
- If license key is missing, the license can be floating and the license host and port can be specified, else they are ignored
AuthorComponentException
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
frameworksZIPURLs
- The set of ZIPs which contain the frameworksoptionsZipURL
- URL to the options ZIP.appletCodeBase
- Code base when run from an applet, can be null when using the author component in a standalone applicationappletID
- 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
AuthorComponentException
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
frameworksZIPURLs
- The set of ZIPs which contain the frameworksoptionsZipURL
- URL to the options ZIP.appletCodeBase
- Code base when run from an applet, can be null when using the author component in a standalone applicationappletID
- 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 componentserverPort
- If license key is missing, the license can be floating and the license server information can be specified, else they are ignored
AuthorComponentException
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
frameworksZIPURLs
- The set of ZIPs which contain the frameworksoptionsZipURL
- URL to the options ZIP.appletCodeBase
- Code base when run from an applet, can be null when using the author component in a standalone applicationappletID
- 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 serveruserName
- User name to connect to the license server.password
- Password to connect to the license server.
AuthorComponentException
public void setObjectProperty(java.lang.String key, java.lang.Object value)
key
- The key from the Oxygen optionsvalue
- Value for the key.public AuthorComponentProvider createAuthorComponentProvider() throws AuthorComponentException
AuthorComponentException
public void disposeAuthorComponentProvider(AuthorComponentProvider provider)
provider
- The provider to release.public ro.sync.azcheck.ui.SpellCheckOptions getSpellCheckOptions()
public void setSpellCheckOptions(ro.sync.azcheck.ui.SpellCheckOptions newSpellCheckOptions)
newSpellCheckOptions
- The new spell check options to set.public void setOpenURLHandler(OpenURLHandler openURLHandler)
openURLHandler
- The open URLs handler.public void addInputURLChooserCustomizer(ro.sync.exml.workspace.api.standalone.InputURLChooserCustomizer inputURLChooserCustomizer)
addInputURLChooserCustomizer
in interface ro.sync.exml.workspace.api.standalone.ReferencesCustomizer
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.
ReferencesCustomizer.addInputURLChooserCustomizer(ro.sync.exml.workspace.api.standalone.InputURLChooserCustomizer)
public void addRelativeReferencesResolver(java.lang.String protocol, ro.sync.exml.workspace.api.util.RelativeReferenceResolver resolver)
addRelativeReferencesResolver
in interface ro.sync.exml.workspace.api.standalone.ReferencesCustomizer
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.
ReferencesCustomizer.addRelativeReferencesResolver(java.lang.String, ro.sync.exml.workspace.api.util.RelativeReferenceResolver)
|
Oxygen XML Editor, Version 13.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |