|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RenderingPluginParameter
Represents the definition of a RenderingPlugin
parameter.
This class extends Localized
which is documented in the WebSphere Portal
documentation. The getTitle(Locale)
and getDescription(Locale)
methods should
return a translated title and description for the parameter.
RenderingPluginParameterAdapter
This interface is designed to be implemented by clients. |
Nested Class Summary | |
---|---|
static class |
RenderingPluginParameter.Required
Possible setting for parameter requirement. |
Method Summary | |
---|---|
java.lang.String |
getDescription(java.util.Locale locale)
Get the translated description 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. |
java.lang.String |
getTitle(java.util.Locale locale)
Get the translated title of the parameter. |
RenderingPluginParameterType |
getType()
Get the 'type' of this RenderingPluginParameter . |
Methods inherited from interface com.ibm.portal.Localized |
---|
getLocales |
Method Detail |
---|
java.lang.String getName()
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.
java.lang.String getTitle(java.util.Locale locale)
getTitle
in interface Localized
locale
- the locale for which to retrieve the title, must not
be null
.
null
.
It is up to the invoker of the method to implement an appropriate
fallback mechanism.Localized.getTitle(java.util.Locale)
java.lang.String getDescription(java.util.Locale locale)
getDescription
in interface Localized
locale
- the locale for which to retrieve the description, must not
be null
.
null
.
It is up to the invoker of the method to implement an appropriate
fallback mechanismLocalized.getDescription(java.util.Locale)
RenderingPluginParameterType getType()
RenderingPluginParameter
.
RenderingPluginParameter
s are be dealt with different, depending on their type.
RenderingPluginParameter.Required getRequired()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |