|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The PortletConfig
interface provides the portlet with
its configuration. The configuration holds information about
the portlet that is valid for all users, and is
maintained by the administrator. The portlet can therefore only
read the configuration. Only when the portlet is in CONFIGURE mode,
it has write access to the configuartion data (the rest of the configuration
is managed by the portlet container directly).
Portlet
Method Summary | |
java.lang.String |
getAttribute(java.lang.String name)
Returns the value of the attribute with the given name, or null if no such attribute exists. |
java.util.Enumeration |
getAttributeNames()
Returns an enumeration of all available attributes names. |
PortletContext |
getContext()
Returns the portlet context. |
java.lang.String |
getName()
Returns the name of the portlet. |
java.lang.String |
getTitle(java.util.Locale locale,
Client client)
Returns the title of this window. |
void |
removeAttribute(java.lang.String name)
Removes the attribute with the given name. |
void |
setAttribute(java.lang.String name,
java.lang.String value)
Sets the attribute with the given name and value. |
boolean |
supports(java.util.Locale locale)
Returns whether the portlet supports the given locale. |
boolean |
supports(Portlet.Mode mode,
Client client)
Returns whether the portlet supports the given mode for the given client. |
boolean |
supports(PortletWindow.State state)
Returns whether the portlet window supports the given state |
Method Detail |
public java.lang.String getName()
public void setAttribute(java.lang.String name, java.lang.String value) throws AccessDeniedException
name
- the attribute namevalue
- the attribute value
AccessDeniedException
- if the caller isn't authorized to access
this data objectpublic java.lang.String getAttribute(java.lang.String name) throws AccessDeniedException
null
if no such attribute exists.
name
- the attribute name
AccessDeniedException
- if the caller isn't authorized to access
this data objectpublic java.util.Enumeration getAttributeNames() throws AccessDeniedException
AccessDeniedException
- if the caller isn't authorized to access
this data objectgetAttribute(String)
public void removeAttribute(java.lang.String name) throws AccessDeniedException
name
- the attribute name
AccessDeniedException
- if the caller isn't authorized to access
this data objectpublic java.lang.String getTitle(java.util.Locale locale, Client client)
locale
- the localeclient
- the client
public boolean supports(PortletWindow.State state)
state
- the portlet window state to be supported
true
if the portlet window provides support, false
otherwisePortletWindow.State
public boolean supports(java.util.Locale locale)
locale
- the locale to be supported
true
if the portlet provides support, false
otherwisepublic boolean supports(Portlet.Mode mode, Client client)
mode
- the portlet mode to be supportedclient
- the client to be supported
true
if the portlet provides support, false
otherwisePortlet.Mode
public PortletContext getContext()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |