com.ibm.ecm.extension

Class PluginLayout

  1. java.lang.Object
  2. extended bycom.ibm.ecm.extension.PluginLayout
  1. public abstract class PluginLayout
  2. extends java.lang.Object
Provides an abstract class that is extended to define a layout that is provided by a plug-in. The layout is the main widget for the desktop and defines the overall arrangement of widgets in the desktop. The particular layout that is used for a desktop is selected in the IBM Content Navigator administration tool.

Constructor Summary

Constructor and Description
PluginLayout()

Method Summary

Modifier and Type Method and Description
  1. boolean
 areFeaturesConfigurable()
Returns a Boolean value that indicates whether features are configurable for this layout.
  1. abstract
  2. java.lang.String
 getId()
Returns an identifier that is used to describe this layout.
  1. abstract
  2. java.lang.String
 getLayoutClass()
Returns the name of the widget class that implements this layout.
  1. abstract
  2. 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.
  1. java.lang.String
 getPluginId()
Returns the identifier of the plug-in that contains this layout.
  1. void
 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

  1. public PluginLayout()

Method Detail

getId

  1. public abstract java.lang.String getId( )
Returns an identifier that is used to describe this layout.

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

Returns:
An alphanumeric String that is used to identify the layout.

getName

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

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

  1. public abstract java.lang.String getLayoutClass( )
Returns the name of the widget class that implements this layout.
Returns:
A widget class name.

getPluginId

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

  1. public final void setPluginId(java.lang.String pluginId)
For Internal Use Only. Sets the identifier of the plug-in that contains this layout.