|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.netuix.servlets.controls.ControlContext 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(javax.servlet.http.HttpServletRequest)
,
Serialized FormField Summary |
---|
Fields inherited from class com.bea.netuix.servlets.controls.window.WindowPresentationContext |
---|
CLASS_NAME |
Constructor Summary | |
---|---|
protected |
PortletPresentationContext()
|
Method Summary | |
---|---|
String |
getAsyncContent()
Get the value of the portlet's asyncContent property. |
ControlContextConstants.HeaderMode |
getHeaderMode()
Returns a HeaderMode representing the header mode currently set for the response object. |
javax.servlet.http.HttpServletRequest |
getHttpRequest()
Returns a HttpServletRequest |
String |
getInstanceLabel()
Return the instance label for the portlet. |
String |
getLabel()
Return the instanceLabel for the portlet, if it exists. |
PagePresentationContext |
getPagePresentationContext()
Return the portlets parent PagePresentationContext. |
PortletPreferences |
getPortletPreferences(javax.servlet.http.HttpServletRequest request)
Returns a read-only copy of preferences for this portlet. |
static PortletPresentationContext |
getPortletPresentationContext(javax.servlet.http.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(javax.servlet.http.HttpServletRequest request)
Deprecated Use getPortletPreferences instead |
String |
getSharedParameterValue(String name)
Gets the value of the specified shared parameter. |
String[] |
getSharedParameterValues(String name)
Gets all values for the specified shared parameter. |
boolean |
isAsyncContent()
Is the portlet set up to render asynchronously? |
boolean |
isCapable(Capability capability)
Returns true if this control has the specified capability. |
boolean |
isClientRequest()
Returns true if this is a Portal-Aware XMLHttpRequest from the client. |
boolean |
isContentOnly()
This field only applies to async portlets. |
boolean |
isDefaultMinimized()
Returns the value for defaultMinimized |
boolean |
isPortletRenderedByClient()
Returns true if this is a PortletSource-based request from the client. |
boolean |
isRemote()
This method returns true when the portlet is being invoked remotely via WSRP on a producer. |
boolean |
isReturnContentToCaller()
Returns true if Portal-Aware-XHR has been invoked within this portlet. |
void |
setHeaderMode(ControlContextConstants.HeaderMode mode)
Accepts HeaderMode desired for this portlet running over WSRP. |
Methods inherited from class com.bea.netuix.servlets.controls.window.WindowPresentationContext |
---|
getCapability, getContentAttributeRenderer, getContentPresentationClass, getContentPresentationContextChildren, getContentPresentationStyle, getDefinitionId, getDefinitionLabel, getInstanceId, getLocalInstanceId, getMetaData, getMetaDatas, getOrientation, getParentPagePresentationContext, getPreviousWindowMode, getThemePresentationContext, getTitle, getTitlebarPresentationContext, getWindowMode, getWindowPresentationContext, getWindowState, isPacked |
Methods inherited from class com.bea.netuix.servlets.controls.PresentationContext |
---|
addCookie, addDateHeader, addHeader, addIntHeader, getAttributeRenderer, getChildren, getChildren, getFirstChild, getOrderedChildren, getParsedProperties, getPresentationClass, getPresentationId, getPresentationStyle, getProperties, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsInt, getRenderFormat, getResolvedLocale, getTagName, isVisible, setCharacterEncoding, setContentType, 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()
getLabel
in class WindowPresentationContext
public String getPortletUri()
Example: /portlets/myportlet/myportlet.portlet
public boolean isDefaultMinimized()
defaultMinimized.
public static PortletPresentationContext getPortletPresentationContext(javax.servlet.http.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(javax.servlet.http.HttpServletRequest request)
request
- The current HTTPServletRequest instance
@Deprecated public PortletPreferences getPreferences(javax.servlet.http.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 String getAsyncContent()
asyncContent
property on the portlet.public boolean isContentOnly()
public PagePresentationContext getPagePresentationContext()
public boolean isPortletRenderedByClient()
public boolean isReturnContentToCaller()
public boolean isClientRequest()
isPortletSourceRequest()
method,
which only applies to portlet publishing requests from the PortletSource client-side API.
This isClientRequest() method is for any request made by the framework using the portal XMLHttpRequest
client-side API which includes portlet publishing and several other use cases.
public boolean isRemote()
public String getSharedParameterValue(String name)
name
- the parameterID of the parameter to get. If the name is not a
registered shared parameter, null
will be returned.
null
if the parameter has no values or is not a registered shared parameter
for this portlet.public String[] getSharedParameterValues(String name)
name
- the parameterID of the parameter to get. If the name is not a
registered shared parameter, null
will be returned.
null
if the parameter has no values or is not a registered shared parameter
for this portlet.public void setHeaderMode(ControlContextConstants.HeaderMode mode)
HeaderMode
- desired mode for headers on the response objectpublic ControlContextConstants.HeaderMode getHeaderMode()
public javax.servlet.http.HttpServletRequest getHttpRequest()
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |