|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ValueOption
Represents the definition of a RenderingPluginParameter
's allowed value.
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 allowed value.
ValueOptionAdapter
This interface is designed to be implemented by clients. |
Method Summary | |
---|---|
java.lang.String |
getDescription(java.util.Locale locale)
Get the translated description of the value option. |
java.lang.String |
getName()
Returns the name for this value option. |
java.lang.String |
getTitle(java.util.Locale locale)
Get the translated title of the value option. |
Methods inherited from interface com.ibm.portal.Localized |
---|
getLocales |
Method Detail |
---|
java.lang.String getName()
String
that should be used as the value itself.
Therefore, this should be a short String
containing only alphanumeric characters.
It must not contains spaces or special characters.
Note: If the name is changed, this will break the tags where the previous name of the value option 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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |