|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.workplace.wcm.api.plugin.rendering.RenderingPluginParameterAdapter
public abstract class RenderingPluginParameterAdapter
Adapter implementation of RenderingPluginParameter
to create an parameter that allows either
any String
value, or any of a list of String
s as the value.
For many RenderingPluginDefinition
s, this will be the easiest way to define the RenderingPluginParameter
s
This class extends Localized
which is documented in the WebSphere Portal
documentation. The RenderingPluginParameter.getTitle(Locale)
and RenderingPluginParameter.getDescription(Locale)
methods should return a
translated title and description for the plugin.
This interface is designed to be implemented by clients. |
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.ibm.workplace.wcm.api.plugin.rendering.RenderingPluginParameter |
---|
RenderingPluginParameter.Required |
Constructor Summary | |
---|---|
RenderingPluginParameterAdapter(java.lang.String name)
Constructor |
Method Summary | |
---|---|
RenderingPluginParameterAdapter |
allowedValues(java.util.List<ValueOption> values)
Set the possible values of the parameter. |
RenderingPluginParameterAdapter |
allowedValues(ValueOption... allowedValues)
Set the allowed values of the parameter. |
RenderingPluginParameterAdapter |
defaultValue(java.lang.String defaultValue)
Set the default value of the parameter. |
java.lang.String |
getName()
Returns the name for this rendering plugin parameter. |
RenderingPluginParameter.Required |
getRequired()
Get the required setting for the parameter. |
RenderingPluginParameterType |
getType()
Get the 'type' of this RenderingPluginParameter . |
RenderingPluginParameterAdapter |
required(RenderingPluginParameter.Required required)
Set whether the parameter is required. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.workplace.wcm.api.plugin.rendering.RenderingPluginParameter |
---|
getDescription, getTitle |
Methods inherited from interface com.ibm.portal.Localized |
---|
getLocales |
Constructor Detail |
---|
public RenderingPluginParameterAdapter(java.lang.String name)
name
- the name for this rendering plugin parameterMethod Detail |
---|
public RenderingPluginParameterAdapter allowedValues(ValueOption... allowedValues)
allowedValues
- the allowed values of the parameter
public RenderingPluginParameterAdapter allowedValues(java.util.List<ValueOption> values)
values
- the possible values of the parameter
public RenderingPluginParameterAdapter defaultValue(java.lang.String defaultValue)
defaultValue
- the default value of the parameter
public RenderingPluginParameterAdapter required(RenderingPluginParameter.Required required)
required
- required setting for the parameter
RenderingPluginParameter
, returned to allow method chainingpublic java.lang.String getName()
RenderingPluginParameter
String
containing only alphanumeric characters.
It must not contains spaces or special characters. Names must be unique, or else the plugin will not function correctly.
Note: The parameter name must not be 'name' or 'id', because these attributes have special meaning in the plugin implementation.
Note: If the name is changed, this will break the tags where the previous name of the rendering plugin parameter is used.
getName
in interface RenderingPluginParameter
public RenderingPluginParameterType getType()
RenderingPluginParameter
RenderingPluginParameter
.
RenderingPluginParameter
s are be dealt with different, depending on their type.
getType
in interface RenderingPluginParameter
public RenderingPluginParameter.Required getRequired()
RenderingPluginParameter
getRequired
in interface RenderingPluginParameter
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |