public interface PortalContext
PortalContext
interface gives the portlet
the ability to retrieve information about the portal calling this portlet.
The portlet can only read the PortalContext
data.
Modifier and Type | Field and Description |
---|---|
static String |
MARKUP_HEAD_ELEMENT_SUPPORT
Property indicating if the portal application supports the
MimeResponse property MARKUP_HEAD_ELEMENT . |
Modifier and Type | Method and Description |
---|---|
String |
getPortalInfo()
Returns information about the portal like vendor, version, etc.
|
String |
getProperty(String name)
Returns the portal property with the given name,
or a
null if there is
no property by that name. |
Enumeration<String> |
getPropertyNames()
Returns all portal property names, or an empty
Enumeration if there are no property names. |
Enumeration<PortletMode> |
getSupportedPortletModes()
Returns all supported portlet modes by the portal
as an enumeration of
PortletMode objects. |
Enumeration<WindowState> |
getSupportedWindowStates()
Returns all supported window states by the portal
as an enumeration of
WindowState objects. |
static final String MARKUP_HEAD_ELEMENT_SUPPORT
MimeResponse
property MARKUP_HEAD_ELEMENT
.
A non-null value indicates that the portal application supports
the MARKUP_HEAD_ELEMENT
property.
The value is "javax.portlet.markup.head.element.support"
.
String getProperty(String name)
null
if there is
no property by that name.name
- property namename
IllegalArgumentException
- if name is null
.Enumeration<String> getPropertyNames()
Enumeration
if there are no property names.Enumeration
of String
objectsEnumeration<PortletMode> getSupportedPortletModes()
PortletMode
objects.
The portlet modes must at least include the
standard portlet modes EDIT, HELP, VIEW
.
PortletMode
objects.Enumeration<WindowState> getSupportedWindowStates()
WindowState
objects.
The window states must at least include the
standard window states MINIMIZED, NORMAL, MAXIMIZED
.
WindowState
objects.String getPortalInfo()
The form of the returned string is servername/versionnumber. For
example, the reference implementation Pluto may return the string
Pluto/1.0
.
The portlet container may return other optional information after the
primary string in parentheses, for example, Pluto/1.0
(JDK 1.3.1; Windows NT 4.0 x86)
.
String
containing at least the portal name and version numberJava Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.