public abstract class PluginViewerDef
extends java.lang.Object
| Constructor and Description |
|---|
PluginViewerDef() |
| Modifier and Type | Method and Description |
|---|---|
abstract java.lang.String |
getId()
Returns an identifier that is used to describe this viewer.
|
abstract java.lang.String |
getLaunchUrlPattern()
Provides a URL template that is used to launch this viewer.
|
abstract java.lang.String |
getName(java.util.Locale locale)
Returns a descriptive label for this viewer that is displayed in the IBM Content Navigator administration tool.
|
java.lang.String[] |
getSupportedContentTypes()
Returns an array of MIME content types that are supported by the viewer.
|
java.lang.String[] |
getSupportedServerTypes()
Returns a list of the server types on which this action is valid.
|
java.lang.String |
getViewerClass()
Provide a subclass of ecm.widget.viewer.DocViewer
|
boolean |
isLaunchInSeparateWindow()
Returns a Boolean value that indicates whether the viewer is to be launched in its own web browser window or can
be launched in the common viewer window.
|
boolean |
isMergeSplitViewer()
Specify whether the viewer is suitable for use to support the Document Builder action
|
boolean |
isPreviewViewer()
Specify whether the viewer is suitable for use to support the Preview action
|
public abstract java.lang.String getId()
Important: This identifier is used in URLs so it must contain only alphanumeric characters.
String that is used to identify the viewer.public abstract java.lang.String getName(java.util.Locale locale)
String that contains a short description of the viewer.public java.lang.String[] getSupportedContentTypes()
String array of the MIME content types supported by the viewer, or null for
all types.public java.lang.String[] getSupportedServerTypes()
String array that contains one or more of the following values:
| Server Type | Description |
|---|---|
p8 |
IBM FileNet P8 |
cm |
IBM Content Manager |
od |
IBM Content Manager OnDemand |
null |
For all server types |
public boolean isLaunchInSeparateWindow()
true to launch the viewer in its own web browser window.public abstract java.lang.String getLaunchUrlPattern()
ecm.model.Viewer for details on what variables can be used within this pattern. This method returns
a template that contains the variables. The template is used by the ecm.model.Viewer class at run
time to build a URL for invoking the viewer.String that contains a URL template that is used to launch the viewer.public java.lang.String getViewerClass()
public boolean isPreviewViewer()
true to indicate the viewer can be used for Preview.public boolean isMergeSplitViewer()
true to indicate the viewer can be used for Document Builder.