|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectControlContext
com.bea.netuix.servlets.controls.PresentationContext
com.bea.netuix.servlets.controls.window.WindowPresentationContext
com.bea.netuix.servlets.controls.portlet.PortletPresentationContext
public class PortletPresentationContext
This class represents a portal portlet component. All presentation-related attributes of a portlet component are available from instances of this class. Such instances are typically used during portal rendering via look and feel skeleton files (e.g. window.jsp).
Depending on the context of invocation of this classes methods, some may throwUnsupportedOperationException
. Such contexts include within remote WSRP portlets.
All methods should function normally for locally rendered portlets.
getPortletPresentationContext(HttpServletRequest)
Field Summary |
---|
Fields inherited from class com.bea.netuix.servlets.controls.window.WindowPresentationContext |
---|
CLASS_NAME |
Constructor Summary | |
---|---|
protected |
PortletPresentationContext()
|
Method Summary | |
---|---|
String |
getInstanceLabel()
Return the instance label for the portlet. |
String |
getLabel()
Return the unique label for the portlet. |
PagePresentationContext |
getPagePresentationContext()
Return the portlets parent PagePresentationContext. |
PortletPreferences |
getPortletPreferences(HttpServletRequest request)
Returns a read-only copy of preferences for this portlet. |
static PortletPresentationContext |
getPortletPresentationContext(HttpServletRequest request)
This is a convenience method for returning a reference to the current PortletPresentationContext . |
String |
getPortletUri()
Getter for the portlet's URI. Example: /portlets/myportlet/myportlet.portlet |
PortletPreferences |
getPreferences(HttpServletRequest request)
Deprecated Use getPortletPreferences instead |
boolean |
isAsyncContent()
Is the portlet set up to render asynchronously? |
boolean |
isCapable(Capability capability)
Returns true if this control has the specified capability. |
boolean |
isContentOnly()
This field only applies to async portlets. |
boolean |
isDefaultMinimized()
Returns the value for defaultMinimized |
Methods inherited from class com.bea.netuix.servlets.controls.window.WindowPresentationContext |
---|
getCapability, getContentAttributeRenderer, getContentPresentationClass, getContentPresentationContextChildren, getContentPresentationStyle, getDefinitionId, getDefinitionLabel, getInstanceId, getMetaData, getMetaDatas, getOrientation, getParentPagePresentationContext, getPreviousWindowMode, getThemePresentationContext, getTitle, getTitlebarPresentationContext, getWindowMode, getWindowPresentationContext, getWindowState, isPacked |
Methods inherited from class com.bea.netuix.servlets.controls.PresentationContext |
---|
getAttributeRenderer, getChildren, getChildren, getFirstChild, getParsedProperties, getPresentationClass, getPresentationId, getPresentationStyle, getProperties, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsInt, getRenderFormat, getResolvedLocale, getTagName, isVisible, setVisible |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected PortletPresentationContext()
Method Detail |
---|
public String getInstanceLabel()
public String getLabel()
getInstanceLabel()
.
getLabel
in class WindowPresentationContext
public String getPortletUri()
Example: /portlets/myportlet/myportlet.portlet
public boolean isDefaultMinimized()
defaultMinimized.
public static PortletPresentationContext getPortletPresentationContext(HttpServletRequest request)
PortletPresentationContext
.
Note this method will only work if called from within a portal (typically, from the window.jsp skeleton).
This method may return null if called when no appropriate context exists, but such a context should safely
exist when being fetched from the associated skeleton JSP during normal portal rendering.
request
- The current HTTPServletRequest instance
public PortletPreferences getPortletPreferences(HttpServletRequest request)
request
- The current HTTPServletRequest instance
public PortletPreferences getPreferences(HttpServletRequest request)
request
- The current HTTPServletRequest instance
public boolean isCapable(Capability capability)
true
if this control has the specified capability.
isCapable
in class WindowPresentationContext
capability
- A window mode or stateWindowCapabilities
public boolean isAsyncContent()
asyncContent
property on the portlet is configured to anything besides "none".public boolean isContentOnly()
public PagePresentationContext getPagePresentationContext()
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |