|
Portlet API 2 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | 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 (virtual instances), 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 dynamic data (the rest of the configuration
is managed by the portlet container directly).
Portlet| Method Summary | |
boolean |
canBeClosed()
Returns whether the portlet can be closed or not. |
boolean |
canBeDetached()
Returns whether the portlet can be detached or not. |
boolean |
canBeMaximized()
Returns whether the portlet can be maximized or not. |
boolean |
canBeMinimized()
Returns whether the portlet can be minimized or not. |
boolean |
canBeMoved()
Returns whether the portlet can be moved or not. |
boolean |
canBeResized()
Returns whether the portlet can be resized or not. |
PortletContext |
getContext()
Returns the portlet context. |
DynamicData |
getData()
Returns the dynamic data as it is held by the configuration. |
DynamicData |
getData(String name)
Returns the dynamic data as it is held by the configuration in the shared section with the given name. |
String |
getName()
Returns the name of the portlet. |
boolean |
supports(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. |
| Method Detail |
public String getName()
public boolean canBeDetached()
true if the portlet can be detached, false otherwisepublic boolean canBeMoved()
true if the portlet can be moved, false otherwisepublic boolean canBeResized()
true if the portlet can be resized, false otherwisepublic boolean canBeMinimized()
true if the portlet can be minimized, false otherwisepublic boolean canBeMaximized()
true if the portlet can be maximized, false otherwisepublic boolean canBeClosed()
true if the portlet can be closed, false otherwisepublic boolean supports(Locale locale)
locale - the locale to be supportedtrue if the portlet provides support, false otherwise
public boolean supports(Portlet.Mode mode,
Client client)
mode - the portlet mode to be supportedclient - the client to be supportedtrue if the portlet provides support, false otherwisepublic DynamicData getData()
getData(String)
public DynamicData getData(String name)
throws AccessDeniedException
name - the name of the shared sectionAccessDeniedException - if the calling portlet does not have the access
rights for the shared sectiongetData()public PortletContext getContext()
|
Portlet API 2 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||