com.ibm.ecm.extension
Class PluginFeature
- java.lang.Object
- com.ibm.ecm.extension.PluginFeature
- public abstract class PluginFeature
- extends java.lang.Object
Constructor Summary
Constructor and Description |
---|
PluginFeature()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getConfigurationDijitClass()
Returns the name of a Dojo
dijit class that provides a configuration interface widget for this
feature.
|
|
getContentClass()
Returns the name of a widget to implement the pane that provides the primary interface for this feature.
|
|
getDescription(java.util.Locale locale)
Returns descriptive text for this feature that is displayed in the IBM Content Navigator administration tool.
|
|
getFeatureIconTooltipText(java.util.Locale locale)
Returns a
String to use as tooltip text on the icon for this feature.
|
|
getHelpContext()
Returns a
String to use as help context for this feature.
|
|
getIconUrl()
Returns a CSS class representing the image to use as the icon displayed for this feature.
|
|
getId()
Returns an identifier that is used to describe this feature.
|
|
getName(java.util.Locale locale)
Returns a descriptive label for this feature that is displayed in the IBM Content Navigator administration tool.
|
|
getPluginId()
Returns the identifier of the plug-in that contains this feature.
|
|
getPopupWindowClass()
Deprecated. As of 2.0.3.3. Popup windows will be removed in a future release.
|
|
getPopupWindowTooltipText(java.util.Locale locale)
Deprecated. As of 2.0.3.3. Popup windows will be removed in a future release.
|
|
getSvgFilePath()
Returns the path to an SVG file specified as the image to use for the feature icon.
|
|
isPreLoad()
Returns true if the feature should be preloaded by the application layout and false if it should be lazy-loaded.
|
|
isSeparator()
Returns a Boolean value that indicates whether this feature is a separator.
|
|
setPluginId(java.lang.String pluginId)
For Internal Use Only.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail
PluginFeature
- public PluginFeature()
Method Detail
getId
- public abstract java.lang.String getId( )
Returns:
An alphanumeric
String
that is used to identify the feature. getName
- public 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.
Returns:
A short description for the menu.
getDescription
- public 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.
Returns:
A short description for the feature.
getIconUrl
- public abstract java.lang.String getIconUrl( )
Returns a CSS class representing the image to use as the icon displayed for this feature. This icon typically
appears on the left side of the desktop.
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.
Returns:
A CSS style class name for the image.
getSvgFilePath
- public java.lang.String getSvgFilePath( )
Returns the path to an SVG file specified as the image to use for the feature icon. An SVG file is used when you
want to style the feature icon according to custom themes applied to desktops. The SVG file must adhere to rules
outlined in the IBM Content Navigator documentation.
Returns:
The path to the SVG file used to render the image.
getHelpContext
- public java.lang.String getHelpContext( )
Returns a
String
to use as help context for this feature.
Returns:
A
String
to use as the help text for this feature. getFeatureIconTooltipText
- public abstract java.lang.String getFeatureIconTooltipText( java.util.Locale locale)
Returns a
String
to use as tooltip text on the icon for this feature.
Parameters:
locale
- The current locale for the user. Returns:
A
String
to use as tooltip text on the feature icon. getPopupWindowTooltipText
- public 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.
Returns a
String
to use as tooltip text on the popup or flyout window icon that is used for this
feature.
Parameters:
locale
- The current locale for the user. Returns:
A
String
to use as tooltip text. getContentClass
- public abstract java.lang.String getContentClass( )
Returns the name of a widget to implement the pane that provides the primary interface for this feature.
Returns:
A
String
name of the dijit. isSeparator
- public boolean isSeparator()
Returns a Boolean value that indicates whether this feature is a separator. A separator is a special case where
the feature is not a true feature but represents a separator to appear between features in the interface.
Returns:
A value of
true
if this feature is a separator. By default, this method returns
false
. getPopupWindowClass
- public abstract java.lang.String getPopupWindowClass( )
Deprecated. As of 2.0.3.3. Popup windows will be removed in a future release.
Returns the name of the widget that implements a popup window, also known as the flyout, for this feature.
Returns:
A
String
name of the widget that implements the flyout for the feature. getPluginId
- public final java.lang.String getPluginId( )
Returns the identifier of the plug-in that contains this feature. Note: This method is implemented by IBM Content
Navigator and must not be overridden.
Returns:
An instance of the
Plugin
class for the plug-in. setPluginId
- public final void setPluginId(java.lang.String pluginId)
For Internal Use Only. Sets the identifier for the plug-in that contains this feature.
isPreLoad
- public abstract boolean isPreLoad( )
Returns true if the feature should be preloaded by the application layout and false if it should be lazy-loaded.
Returns:
A boolean indicating if the feature should be preloaded.
getConfigurationDijitClass
- public java.lang.String getConfigurationDijitClass( )
Returns the name of a Dojo
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 PluginConfigurationPane
for more
information on what is required for a feature configuration user interface.
Important: This identifier is used in URLs so it must contain only alphanumeric characters.