com.ibm.ecm.extension
Class PluginLayout
- java.lang.Object
- com.ibm.ecm.extension.PluginLayout
- public abstract class PluginLayout
- extends java.lang.Object
Constructor Summary
Constructor and Description |
---|
PluginLayout()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
areFeaturesConfigurable()
Returns a Boolean value that indicates whether features are configurable for this layout.
|
|
getId()
Returns an identifier that is used to describe this layout.
|
|
getLayoutClass()
Returns the name of the widget class that implements this layout.
|
|
getName(java.util.Locale locale)
Returns a descriptive label for this layout that is displayed in the IBM Content Navigator administration tool.
|
|
getPluginId()
Returns the identifier of the plug-in that contains this layout.
|
|
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
PluginLayout
- public PluginLayout()
Method Detail
getId
- public abstract java.lang.String getId( )
Returns:
An alphanumeric
String
that is used to identify the layout. getName
- public abstract java.lang.String getName( java.util.Locale locale)
Returns a descriptive label for this layout that is displayed in the IBM Content Navigator administration tool.
Returns:
A short description of the layout.
areFeaturesConfigurable
- public boolean areFeaturesConfigurable( )
Returns a Boolean value that indicates whether features are configurable for this layout.
Returns:
A value of
true
if the layout supports configuring features for the desktop.
By default, this method returns true
. getLayoutClass
- public abstract java.lang.String getLayoutClass( )
Returns the name of the widget class that implements this layout.
Returns:
A widget class name.
getPluginId
- public final java.lang.String getPluginId( )
Returns the identifier of the plug-in that contains this layout.
Important: 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 of the plug-in that contains this layout.
Important: This identifier is used in URLs so it must contain only alphanumeric characters.