com.ibm.portal.wcm.plr
Interface ListRenderingProfileProvider
-
public interface ListRenderingProfileProvider
This extension interface allows contributing additional List Rendering Profiles to the Pluggable List Rendering runtime.
This is the generic ListRenderingProfileProvider interface that can be implemented by custom extensions
to the Pluggable List Rendering (PLR) framework. This extension is called by the PLR infrastructure to load additional set of
List Rendering profiles. The List Rendering Profiles provided via this interface are added to the profiles
configured in the ListRenderingProfileService Resource Environment Provider.
Individual extensions can be registered with the Extension Registry using the ID com.ibm.portal.wcm.ddc.ListRenderingProfileProvider.
The name of the class attribute used for instantiating individual extensions is class.
Individual ListRenderingProfileProvider are instantiated once and kept as singletons by the PLR framework.
- Since:
- 8.5.0.0
- Note:
| This interface is designed to be implemented by clients. |
|
Field Summary
|
|
static java.lang.String |
ATTR_CLASS
Name of the class attribute used for instantiation |
|
static java.lang.String |
EXTENSION_POINT_ID
The extension point ID for the Pluggable List Rendering Extension point |
|
Method Summary
|
|
java.util.List<java.util.Properties> |
getListRenderingProfiles()
Return the list of list rendering profiles. |
|
java.util.ResourceBundle |
getResourceBundle(java.util.Locale locale)
Return the resource bundle containing the NLS keys for the attributes defined by the profiles introduced by this
ListRenderingProfileProvider. |
ATTR_CLASS
static final java.lang.String ATTR_CLASS
- Name of the class attribute used for instantiation
- See Also:
- Constant Field Values
EXTENSION_POINT_ID
static final java.lang.String EXTENSION_POINT_ID
- The extension point ID for the Pluggable List Rendering Extension point
- See Also:
- Constant Field Values
getListRenderingProfiles
java.util.List<java.util.Properties> getListRenderingProfiles()
- Returns the list of list rendering profiles. The profiles are returned as Properties objects containing the
List rendering profile entries to be added to the overall set of available List Rendering Profiles.
- Returns:
- the list of list rendering profiles.
getResourceBundle
java.util.ResourceBundle getResourceBundle(java.util.Locale locale)
- Returns the resource bundle containing the NLS keys for the attributes defined by the profiles introduced by this
ListRenderingProfileProvider. It is not required to set the ResourceBundleBaseName profile property
to identify the resource bundle returned by this method. Resource bundles referenced via the ResourceBundleBaseName
profile property take precedence over the resource bundle returned by this method.
This method may be null.
- Parameters:
- The - current locale
- Returns: