|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TextProvider
Interface for providing localized title and description values for use
in the Web Content Manager Authoring UI. This class extends
com.ibm.portal.Localized
which is documented in the WebSphere Portal
Infocenter.
Contribute your rendering plugin to WCM by using an Eclipse extension point "com.ibm.workplace.wcm.api.TextProvider". Refer
to the product documentation for more information.
Extend TextProviderAdapter
to create a TextProvider
backed by a ResourceBundle
.
This interface is designed to be implemented by clients. |
Method Summary | |
---|---|
java.util.Collection<java.lang.String> |
getProviderKeys()
Get the list of keys that are defined for this text provider |
java.lang.String |
getProviderName()
Get the name for this text provider. |
java.lang.String |
getString(java.lang.String key,
java.util.Locale locale)
Retrieves a text string using the given key, in the given locale. |
boolean |
isShownInAuthoringUI()
This property should return true if the plugin will be selectable through
the Web Content Manager Authoring UI for use in item and element titles, descriptions and help text etc. |
Methods inherited from interface com.ibm.portal.Localized |
---|
getDescription, getLocales, getTitle |
Method Detail |
---|
java.lang.String getProviderName()
java.lang.String getString(java.lang.String key, java.util.Locale locale)
key
- the key for retrieving the text stringlocale
- locale to display
java.util.Collection<java.lang.String> getProviderKeys()
boolean isShownInAuthoringUI()
true
if the plugin will be selectable through
the Web Content Manager Authoring UI for use in item and element titles, descriptions and help text etc.
It should be false
if the plugin is to be hidden in these selectors. If this property is false
,
the user can still manually enter the name of the plugin in order to use it.
Hidden plugins can also be used in the TextProvider Rendering plugin, eg:
[Plugin:TextProvider provider="myHiddenProviderName" key=..."]
so, they are a convenient way to reference a resource bundle from with the design.
isShownInAuthoringUI
in interface AuthoringPlugin
true
to make the plugin selectable, false
to hide it in the selectors
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |