@API(type=NOT_EXTENDABLE, src=PRIVATE) public class AuthorComponentFactory extends java.lang.Object implements ReferencesCustomizer, MathFlowConfigurator
The recommended way to license the author component is:
// These two zips should be packed in some jar files from the classpath. URL frameworksZipURL = Reviewer.class.getResource("/frameworks.zip"); URL optionsZipURL = Reviewer.class.getResource("/options.zip"); // Getting the component factory AuthorComponentFactory factory = AuthorComponentFactory.getInstance(); factory.init(new URL[] {frameworksZipURL}, optionsZipURL, null, null, // A null license key triggers the display of the license key dialog. // You can use a floating license servlet by invoking other init methods. null); // Create the AuthorComponent provider EditorComponentProvider componentProvider = factory.createEditorComponentProvider( new String[] { EditorPageConstants.PAGE_AUTHOR }, // The initial page EditorPageConstants.PAGE_AUTHOR); // This is the Author API starting point // You can access the document, selection, move caret, perform edits, etc.. WSAuthorComponentEditorPage authorPage = (WSAuthorComponentEditorPage) componentProvider.getWSEditorAccess() .getCurrentPage(); // Load a document. URL url = new File("D:/projects/eXml/samples/personal.xml").toURI().toURL(); Reader reader = new InputStreamReader(url.openStream(), "UTF-8"); componentProvider.load(url, reader); // Show the component in a frame. JFrame frame = new JFrame("Author Component Sample Reviewer Application"); frame.setSize(600, 400); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.getContentPane().add(componentProvider.getEditorComponent()); frame.setVisible(true);
Constructor and Description |
---|
AuthorComponentFactory() |
Modifier and Type | Method and Description |
---|---|
void |
addDITAMapTreeTargetInformationProvider(java.lang.String protocol,
TopicRefTargetInfoProvider targetInformationProvider)
Add a provider which can resolve certain information for each topic ref, without the component needing to parse that topic reference.
|
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()
Deprecated.
Please use ro.sync.ecss.extensions.api.component.AuthorComponentFactory.createEditorComponentProvider(String[], String) instead.
|
DITAMapTreeComponentProvider |
createDITAMapTreeComponentProvider()
Creates a new DITA Map tree component provider.
|
EditorComponentProvider |
createEditorComponentProvider(java.lang.String[] allowedPages,
java.lang.String initialPage)
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)
Deprecated.
Please use ro.sync.ecss.extensions.api.component.AuthorComponentFactory.disposeEditorComponentProvider() instead.
|
void |
disposeDITAMapComponentProvider(DITAMapTreeComponentProvider provider)
Remove the handlers the factory has to the component used to notify for changes.
|
void |
disposeEditorComponentProvider(EditorComponentProvider provider)
Remove the handlers the factory has to the component used to notify for changes.
|
static AuthorComponentFactory |
getInstance()
Get the singleton instance.
|
java.util.List<MenuBarCustomizer> |
getPluginMenubarCustomizers()
Get the menu bar customizers which were added by all the installed plugins.
|
java.util.List<ToolbarComponentsCustomizer> |
getPluginToolbarCustomizers()
Get the toolbar customizers which were added by all installed plugins.
|
java.util.List<ViewComponentCustomizer> |
getPluginViewCustomizers()
Get the view customizers which were added by all the installed plugins.
|
PluginWorkspace |
getPluginWorkspace()
Get access to API used to control the created editor components.
|
ro.sync.azcheck.ui.SpellCheckOptions |
getSpellCheckOptions()
Get the spell check options which are currently used for the components.
|
UtilAccess |
getUtilAccess()
Get access to utility methods.
|
WorkspaceUtilities |
getWorkspaceUtilities()
Get access to various workspace utilities.
|
XMLUtilAccess |
getXMLUtilAccess()
Access to XML utilities.
|
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 as soon as possible before calling any other methods from this class.
|
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 as soon as possible before calling any other methods from this class.
|
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 as soon as possible before calling any other methods from this class.
|
void |
setAutoCorrectState(boolean enabled)
Enable or disable the auto correct feature.
|
void |
setDITAKeyDefinitionManager(KeyDefinitionManager keyDefitionManager)
By default key definitions are gathered from DITA Maps opened in the DITA Maps Manager.
|
void |
setMathFlowFixedLicenseFile(java.io.File licenseFile)
Set the path to a license file.
|
void |
setMathFlowFixedLicenseKeyForComposer(java.lang.String fixedKey)
Set a fixed key for licensing the MathFlow composer used to view embedded MathML equations.
|
void |
setMathFlowFixedLicenseKeyForEditor(java.lang.String fixedKey)
Set a fixed key for licensing the MathFlow editor dialog used to edit embedded MathML equations.
|
void |
setMathFlowInstallationFolder(java.io.File installationFolder)
Set the path to the MathFlow installation folder.
|
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.
|
public static AuthorComponentFactory getInstance()
public void dispose()
@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 ignoredAuthorComponentException
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 componentAuthorComponentException
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 ignoredAuthorComponentException
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 EditorComponentProvider createEditorComponentProvider(java.lang.String[] allowedPages, java.lang.String initialPage) throws AuthorComponentException
allowedPages
- The pages which will be used in the editor. One of the constant fields:
EditorPageConstants.PAGE_TEXT
, EditorPageConstants.PAGE_AUTHOR
, EditorPageConstants.PAGE_GRID
initialPage
- The initial page in which the component will edit.AuthorComponentException
@Deprecated public AuthorComponentProvider createAuthorComponentProvider() throws AuthorComponentException
AuthorComponentException
public DITAMapTreeComponentProvider createDITAMapTreeComponentProvider() throws AuthorComponentException
AuthorComponentException
@Deprecated public void disposeAuthorComponentProvider(AuthorComponentProvider provider)
provider
- The provider to release.public void disposeEditorComponentProvider(EditorComponentProvider provider)
provider
- The provider to release.public void disposeDITAMapComponentProvider(DITAMapTreeComponentProvider 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 setAutoCorrectState(boolean enabled)
enabled
- true
to enable the auto correct feature,
false
to disable it.public void setOpenURLHandler(OpenURLHandler openURLHandler)
openURLHandler
- The open URLs handler.public void addInputURLChooserCustomizer(InputURLChooserCustomizer inputURLChooserCustomizer)
ReferencesCustomizer
addInputURLChooserCustomizer
in interface ReferencesCustomizer
inputURLChooserCustomizer
- The input URL chooser customizer.ReferencesCustomizer.addInputURLChooserCustomizer(ro.sync.exml.workspace.api.standalone.InputURLChooserCustomizer)
public void addRelativeReferencesResolver(java.lang.String protocol, RelativeReferenceResolver resolver)
ReferencesCustomizer
addRelativeReferencesResolver
in interface ReferencesCustomizer
protocol
- The URL protocol for which you want to take control over the relativization.resolver
- The custom resolver.ReferencesCustomizer.addRelativeReferencesResolver(java.lang.String, ro.sync.exml.workspace.api.util.RelativeReferenceResolver)
public void addDITAMapTreeTargetInformationProvider(java.lang.String protocol, TopicRefTargetInfoProvider targetInformationProvider)
protocol
- The protocol for which the provider is registeredtargetInformationProvider
- The topic reference target information provider provider.public void setMathFlowFixedLicenseKeyForEditor(java.lang.String fixedKey)
setMathFlowFixedLicenseKeyForEditor
in interface MathFlowConfigurator
fixedKey
- The fixed key. The key needs to be obtained from MathFlow:
http://dessci.com/
and has the following format:
MFSCKKK-KKKKKK-KKKKK
If no editor key will be given then MathFlow will be used neither for editing nor for rendering.public void setMathFlowFixedLicenseKeyForComposer(java.lang.String fixedKey)
setMathFlowFixedLicenseKeyForComposer
in interface MathFlowConfigurator
fixedKey
- The fixed key. The key needs to be obtained from MathFlow:
http://dessci.com/
and has the following format:
MFSEKKK-KKKKKK-KKKKK
If no composer key will be given then the fallback for rendering will be the Apache JEuclid library.public void setMathFlowFixedLicenseFile(java.io.File licenseFile)
setMathFlowFixedLicenseFile
in interface MathFlowConfigurator
licenseFile
- The path to the MathFlow license file.
If the file contains both a license for the composer and for the editor, then both rendering and editing is supported.
If the file contains a license only for the editor, rendering will be done using the open source JEuclid library.public void setMathFlowInstallationFolder(java.io.File installationFolder)
setMathFlowInstallationFolder
in interface MathFlowConfigurator
installationFolder
- The MathFlow installation folderpublic XMLUtilAccess getXMLUtilAccess()
public UtilAccess getUtilAccess()
public java.util.List<ToolbarComponentsCustomizer> getPluginToolbarCustomizers()
public java.util.List<ViewComponentCustomizer> getPluginViewCustomizers()
public java.util.List<MenuBarCustomizer> getPluginMenubarCustomizers()
public void setDITAKeyDefinitionManager(KeyDefinitionManager keyDefitionManager)
keyDefitionManager
- The key definition managerpublic WorkspaceUtilities getWorkspaceUtilities()
public PluginWorkspace getPluginWorkspace()
© Copyright SyncRO Soft SRL 2002 - 2015. All rights reserved.