|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
PortletDefinitionComposite
Field Summary | |
static String |
PORTLETS_PREFS_ROOT
|
Method Summary | |
void |
addContentType(org.apache.pluto.om.portlet.ContentType cType)
|
void |
addContentType(String contentType,
Collection modes)
|
void |
addDescription(Locale locale,
String description)
|
void |
addDisplayName(org.apache.pluto.om.common.DisplayName displayName)
addDisplayName |
void |
addDisplayName(Locale locale,
String displayName)
|
ParameterComposite |
addInitParameter(String name,
String value)
Convenience method for directly adding init parameters to this PortletDefinition. . |
ParameterComposite |
addInitParameter(String name,
String value,
org.apache.pluto.om.common.DescriptionSet description)
Same as setInitParameter(name, title) plus allows a
description to inlcuded. |
ParameterComposite |
addInitParameter(String name,
String value,
String description,
Locale locale)
Same as setInitParameter(name, title) plus allows you
to define one initial localized desription. |
void |
addLanguage(org.apache.pluto.om.common.Language lang)
|
void |
addLanguage(String title,
String shortTitle,
String keywords,
Locale locale)
|
void |
addPreference(org.apache.pluto.om.common.Preference preference)
|
PreferenceComposite |
addPreference(String name,
String[] values)
|
void |
addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef)
addSecurityRoleRef |
org.apache.pluto.om.common.SecurityRoleRef |
addSecurityRoleRef(String roleName,
String roleLink)
|
org.apache.pluto.om.common.DescriptionSet |
getDescriptionSet()
|
String |
getDescriptionText(Locale locale)
Returns localized text of this PortletDefinitions description. |
org.apache.pluto.om.common.DisplayNameSet |
getDisplayNameSet()
|
String |
getDisplayNameText(Locale locale)
Returns localized text of this PortletDefinitions display name. |
GenericMetadata |
getMetadata()
|
String |
getPortletIdentifier()
|
String |
getPreferenceValidatorClassname()
|
String |
getResourceBundle()
|
Collection |
getSupportedLocales()
|
String |
getUniqueName()
A portlet's unique name is a string formed by the combination of a portlet's unique within it's parent application plus the parent application's unique name within the portlet container using ":" as a delimiter. |
void |
setContentTypeSet(org.apache.pluto.om.portlet.ContentTypeSet contentTypes)
|
void |
setExpirationCache(String cache)
Setter for setting expiration cache time for this portlet |
void |
setInitParameterSet(org.apache.pluto.om.common.ParameterSet parameters)
|
void |
setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet securityRefs)
|
void |
setLanguageSet(org.apache.pluto.om.common.LanguageSet languages)
|
void |
setMetadata(GenericMetadata metadata)
|
void |
setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)
|
void |
setPortletIdentifier(String portletIndentifier)
|
void |
setPreferenceSet(org.apache.pluto.om.common.PreferenceSet preferences)
The PreferenceSet is a collection user-defineable preferences that this portlet can use to process its logic. |
void |
setPreferenceValidatorClassname(String classname)
|
Methods inherited from interface org.apache.pluto.om.portlet.PortletDefinition |
getClassName, getContentTypeSet, getDescription, getDisplayName, getExpirationCache, getId, getInitParameterSet, getInitSecurityRoleRefSet, getLanguageSet, getName, getPortletApplicationDefinition, getPortletClassLoader, getPreferenceSet, getServletDefinition |
Methods inherited from interface org.apache.pluto.om.portlet.PortletDefinitionCtrl |
setClassName, setDescriptions, setDisplayNames, setId, setName, setPortletClassLoader, store |
Field Detail |
public static final String PORTLETS_PREFS_ROOT
Method Detail |
public GenericMetadata getMetadata()
public void setMetadata(GenericMetadata metadata)
public void addLanguage(org.apache.pluto.om.common.Language lang)
public void addLanguage(String title, String shortTitle, String keywords, Locale locale)
public void addContentType(org.apache.pluto.om.portlet.ContentType cType)
public void addContentType(String contentType, Collection modes)
public void setLanguageSet(org.apache.pluto.om.common.LanguageSet languages)
public String getResourceBundle()
public Collection getSupportedLocales()
public void setPreferenceSet(org.apache.pluto.om.common.PreferenceSet preferences)
preferences
- public void setInitParameterSet(org.apache.pluto.om.common.ParameterSet parameters)
public void setContentTypeSet(org.apache.pluto.om.portlet.ContentTypeSet contentTypes)
public void setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet securityRefs)
public ParameterComposite addInitParameter(String name, String value)
PortletDefinition.
. This has the
same affect as
((ParameterSetCtrl)PortletDefinition.getInitParamaterSet()).add()
name
- Name of parameter to setvalue
- new value of said parameter
public ParameterComposite addInitParameter(String name, String value, org.apache.pluto.om.common.DescriptionSet description)
setInitParameter(name, title) plus allows a
description to inlcuded.
- Parameters:
name
- Name of parameter to setvalue
- new value of the parameter
- Returns:
- ParameterComposite newly created parameter
- See Also:
org.apache.jetspeed.om.common.portlet.PortletApplicationComposite#addInitParameter(java.lang.String, java.lang.String)
public ParameterComposite addInitParameter(String name, String value, String description, Locale locale)
setInitParameter(name, title) plus allows you
to define one initial localized desription.
- Parameters:
name
- Name of parameter to setvalue
- new value of the parameterdescription
- A description for this parameterlocale
- The locale the description
- Returns:
- ParameterComposite newly created parameter
- See Also:
org.apache.jetspeed.om.common.portlet.PortletApplicationComposite#addInitParameter(java.lang.String, java.lang.String)
public void setExpirationCache(String cache)
public void setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)
public PreferenceComposite addPreference(String name, String[] values)
public void addPreference(org.apache.pluto.om.common.Preference preference)
public void setPortletIdentifier(String portletIndentifier)
public String getPortletIdentifier()
public String getUniqueName()
null
or this portlet has not
yet been assigned to an portlet application, null
is returned.public String getDisplayNameText(Locale locale)
locale
- Locale to get the display name for
null
if no DisplayName exists for this localepublic String getDescriptionText(Locale locale)
locale
- Locale to get the description for
null
if no Description exists for this localepublic void addDescription(Locale locale, String description)
public org.apache.pluto.om.common.DescriptionSet getDescriptionSet()
public void addDisplayName(Locale locale, String displayName)
public void addDisplayName(org.apache.pluto.om.common.DisplayName displayName)
addDisplayName
displayName
- public org.apache.pluto.om.common.DisplayNameSet getDisplayNameSet()
public String getPreferenceValidatorClassname()
public void setPreferenceValidatorClassname(String classname)
public void addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef)
addSecurityRoleRef
Adds thesecurityRef
to the existing
set of SecurityRoleRefs of this PortletDefinition
securityRef
- SecurityRoleRef to add.public org.apache.pluto.om.common.SecurityRoleRef addSecurityRoleRef(String roleName, String roleLink)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |