public abstract class PluginFeature
extends java.lang.Object
| Constructor and Description |
|---|
PluginFeature() |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getConfigurationDijitClass()
Returns the name of a Dojo
dijit class that provides a configuration interface widget for this
feature. |
abstract java.lang.String |
getContentClass()
Returns the name of a widget to implement the pane that provides the primary interface for this feature.
|
abstract java.lang.String |
getDescription(java.util.Locale locale)
Returns descriptive text for this feature that is displayed in the IBM Content Navigator administration tool.
|
abstract java.lang.String |
getFeatureIconTooltipText(java.util.Locale locale)
Returns a
String to use as tooltip text on the icon for this feature. |
java.lang.String |
getHelpContext()
Returns a
String to use as help context for this feature. |
java.lang.String |
getHelpTaxonomy()
Returns a
String to use the help taxonomy code for this feature. |
java.lang.String |
getHelpWelcomePage()
Returns a
String to use the help welcome page for this feature. |
abstract java.lang.String |
getIconUrl()
Returns a CSS class representing the image to use as the icon displayed for this feature.
|
abstract java.lang.String |
getId()
Returns an identifier that is used to describe this feature.
|
abstract java.lang.String |
getName(java.util.Locale locale)
Returns a descriptive label for this feature that is displayed in the IBM Content Navigator administration tool.
|
java.lang.String |
getPluginId()
Returns the identifier of the plug-in that contains this feature.
|
abstract java.lang.String |
getPopupWindowClass()
Deprecated.
As of 2.0.3.3. Popup windows will be removed in a future release.
|
abstract java.lang.String |
getPopupWindowTooltipText(java.util.Locale locale)
Deprecated.
As of 2.0.3.3. Popup windows will be removed in a future release.
|
java.lang.String |
getSvgFilePath()
Returns the path to an SVG file specified as the image to use for the feature icon.
|
abstract boolean |
isPreLoad()
Returns true if the feature should be preloaded by the application layout and false if it should be lazy-loaded.
|
boolean |
isSeparator()
Returns a Boolean value that indicates whether this feature is a separator.
|
void |
setPluginId(java.lang.String pluginId)
For Internal Use Only.
|
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 feature.public abstract java.lang.String getName(java.util.Locale locale)
public abstract java.lang.String getDescription(java.util.Locale locale)
public abstract java.lang.String getIconUrl()
An icon file is a 32x32 pixel transparent image, for example, a transparent GIF image or PNG image or is defined
as an SVG file. The icon file must be included in the pluginPackage/WebContent subdirectory
of the JAR file for the plug-in that contains this action.
public java.lang.String getSvgFilePath()
public java.lang.String getHelpTaxonomy()
String to use the help taxonomy code for this feature.String to use as the help taxonomy code for this feature.public java.lang.String getHelpContext()
String to use as help context for this feature.String to use as the help text for this feature.public java.lang.String getHelpWelcomePage()
String to use the help welcome page for this feature.String to use as the help welcome page for this feature.public abstract java.lang.String getFeatureIconTooltipText(java.util.Locale locale)
String to use as tooltip text on the icon for this feature.locale - The current locale for the user.String to use as tooltip text on the feature icon.public abstract java.lang.String getPopupWindowTooltipText(java.util.Locale locale)
String to use as tooltip text on the popup or flyout window icon that is used for this
feature.locale - The current locale for the user.String to use as tooltip text.public abstract java.lang.String getContentClass()
String name of the dijit.public boolean isSeparator()
true if this feature is a separator. By default, this method returns
false.public abstract java.lang.String getPopupWindowClass()
String name of the widget that implements the flyout for the feature.public final java.lang.String getPluginId()
Plugin class for the plug-in.public final void setPluginId(java.lang.String pluginId)
public abstract boolean isPreLoad()
public java.lang.String getConfigurationDijitClass()
dijit class that provides a configuration interface widget for this
feature. The widget must extend the ecm.widget.admin.PluginConfigurationPane widget. An instance of
the widget is created and displayed under each desktop's layout tab in the IBM Content Navigator administration
tool for configuration specific to this feature.
Refer to the documentation on ecm.widget.admin.PluginConfigurationPane for more
information on what is required for a feature configuration user interface.