com.ibm.ecm.extension

Class PluginViewerDef

java.lang.Object

com.ibm.ecm.extension.PluginViewerDef

public abstract class PluginViewerDef
extends java.lang.Object

Provides an abstract class that is extended to define a viewer provided by the plug-in. The viewer can be used in viewer mappings to identify the types of documents for which the viewer should be invoked. Viewers are launched within their own iframes or web browser windows, based on a URL that is built by IBM Content Navigator by using a template that is defined in this class.

Constructor Summary

Constructors

Constructor and Description
PluginViewerDef()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginViewerDef

public PluginViewerDef()

Method Detail

getId

public abstract java.lang.String getId()

Returns an identifier that is used to describe this viewer.

Important: This identifier is used in URLs so it must contain only alphanumeric characters.

Returns:

An alphanumeric String that is used to identify the viewer.

getName

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

Returns:

A String that contains a short description of the viewer.

getSupportedContentTypes

public java.lang.String[] getSupportedContentTypes()

Returns an array of MIME content types that are supported by the viewer.

Returns:

A String array of the MIME content types supported by the viewer, or null for all types.

getSupportedServerTypes

public java.lang.String[] getSupportedServerTypes()

Returns a list of the server types on which this action is valid.

Returns:

A 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

isLaunchInSeparateWindow

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

Returns:

A value of true to launch the viewer in its own web browser window.

getLaunchUrlPattern

public abstract java.lang.String getLaunchUrlPattern()

Provides a URL template that is used to launch this viewer. See the documentation on 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.

Returns:

A String that contains a URL template that is used to launch the viewer.

getViewerClass

public java.lang.String getViewerClass()

Provide a subclass of ecm.widget.viewer.DocViewer

Returns:

isPreviewViewer

public boolean isPreviewViewer()

Specify whether the viewer is suitable for use to support the Preview action

Returns:

A value of true to indicate the viewer can be used for Preview.

Since:

2.0.3

isMergeSplitViewer

public boolean isMergeSplitViewer()

Specify whether the viewer is suitable for use to support the Document Builder action

Returns:

A value of true to indicate the viewer can be used for Document Builder.

Since:

3.0.1