|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.portal.provider.v2.render.RenderContext
public class RenderContext
A RenderContext
is used to describe to a PortletInstance
the context in which it is to be
renderered. As well as possessing a set of 'bean-like' properties, it has a
table of attributes (returned by getAttributes
) that
can be used to pass environment-specific parameters into the portlet
instance. For example, in a servlet environment, the attribute table might
store the servlet request and response.
Constructor Summary | |
---|---|
RenderContext(int renderMode,
java.lang.String pageURL,
java.lang.String designURL,
java.lang.String backURL,
java.lang.String loginURL,
java.lang.String portletRefreshURL,
boolean hasTitle,
boolean hasBorder,
boolean showDetails,
boolean showEdit,
boolean showHelp,
boolean showAbout,
boolean showRemove,
boolean showCollapse,
boolean showRefresh,
boolean isRefreshEnabled,
boolean isCollapsed,
boolean isRewriteUrls,
java.lang.String portletTemplate,
DeviceInfo deviceInfo,
PortalConfig portalConfig,
java.util.Map attributes,
int WCMaxExpiryTime,
java.lang.String portletPageReference,
java.lang.String eventURL,
PerfMonitor perfMonitor,
int height,
boolean isResourceProxyAvailable,
java.lang.String resourceServletUrl)
|
Method Summary | |
---|---|
java.util.Map |
getAttributes()
Gets a Map of 'environment specific' attributes related to this request. |
java.lang.String |
getBackURL()
Gets the URL of the page that caused this page to display. |
java.lang.String |
getDesignURL()
Gets a URL that returns one to the portal page that invoked this portlet. |
DeviceInfo |
getDeviceInfo()
Gets the device information for this request. |
java.lang.String |
getEventURL()
Gets the URL that can be used to target portlet events. |
int |
getHeight()
Gets the requested height of the portlet contents, in pixels. |
java.lang.String |
getLoginServerURL()
Gets the login URL. |
int |
getMode()
Gets an integer representing the render mode. |
java.lang.String |
getPageURL()
Gets the URL of the page that invoked this portlet. |
PerfMonitor |
getPerfMonitor()
Gets a performance monitor object that will be used to record performance stats. |
PortalConfig |
getPortalConfig()
Gets an object containing information pertinent to the portlet about how the portal is currently configured. |
java.lang.String |
getPortletPageReference()
Gets an opaque identifier which uniquely distinguishes the occurence of this portlet on a page. |
java.lang.String |
getPortletRefreshURL()
Gets the base url which should be used to build links for refreshing a portlet's markup. |
java.lang.String |
getPortletTemplate()
Gets the Portlet Template for the rendering of this portlet. |
java.lang.String |
getResourceServletUrl()
Returns the name of the resource servlet. |
int |
getWCMaxExpiryTime()
Gets the Maximum Expiry time which needs to be used by the portlets which are using invalidation based caching. |
boolean |
hasBorder()
Gets an indicator of whether this portlet should draw its border or not. |
boolean |
hasTitle()
Gets an indicator of whether this portlet should draw a title or not. |
boolean |
isCollapsed()
Gets an indicator of whether this portlet is collapsed or not. |
boolean |
isRefreshEnabled()
Returns whether portlet refresh fucntionality is enabled. |
boolean |
isResourceProxyAvailable()
Returns flag to indicate whether the host portal provides a resource proxy. |
boolean |
isRewriteUrls()
Gets an indicator of whether this portlet should use rewrite Urls or not. |
boolean |
showAbout()
Gets an indicator of whether this portlet should draw its about link or not. |
boolean |
showCollapse()
Gets an indicator of whether this portlet should draw its collapse/restore link or not. |
boolean |
showDetails()
Gets an indicator of whether this portlet should draw its details link or not. |
boolean |
showEdit()
Gets an indicator of whether this portlet should draw its edit link or not. |
boolean |
showHelp()
Gets an indicator of whether this portlet should draw its help link or not. |
boolean |
showRefresh()
Gets an indicator of whether this portlet should draw its refresh link or not. |
boolean |
showRemove()
Gets an indicator of whether this portlet should draw its remove link or not. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RenderContext(int renderMode, java.lang.String pageURL, java.lang.String designURL, java.lang.String backURL, java.lang.String loginURL, java.lang.String portletRefreshURL, boolean hasTitle, boolean hasBorder, boolean showDetails, boolean showEdit, boolean showHelp, boolean showAbout, boolean showRemove, boolean showCollapse, boolean showRefresh, boolean isRefreshEnabled, boolean isCollapsed, boolean isRewriteUrls, java.lang.String portletTemplate, DeviceInfo deviceInfo, PortalConfig portalConfig, java.util.Map attributes, int WCMaxExpiryTime, java.lang.String portletPageReference, java.lang.String eventURL, PerfMonitor perfMonitor, int height, boolean isResourceProxyAvailable, java.lang.String resourceServletUrl)
Method Detail |
---|
public int getMode()
PortletRenderer
class.
public java.lang.String getDesignURL() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public java.lang.String getPageURL() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public java.lang.String getEventURL()
PortletRendererUtil
.
public java.lang.String getBackURL()
public java.lang.String getLoginServerURL() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public boolean isRefreshEnabled()
public java.lang.String getPortletRefreshURL() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public boolean hasTitle()
public boolean hasBorder()
public boolean showDetails()
public boolean showEdit()
public boolean showHelp()
public boolean showAbout()
public boolean showRefresh()
public boolean showRemove()
public boolean showCollapse()
public boolean isCollapsed()
public boolean isRewriteUrls()
public java.lang.String getPortletTemplate()
public DeviceInfo getDeviceInfo()
public PortalConfig getPortalConfig()
public java.util.Map getAttributes()
public int getWCMaxExpiryTime()
public java.lang.String getPortletPageReference()
PortletRendererUtil
This should not be confused with the PortletReference class which is
used to identify an instance of the portlet in the Portal repository
for the purposes of customization.
public PerfMonitor getPerfMonitor()
public int getHeight()
public boolean isResourceProxyAvailable()
public java.lang.String getResourceServletUrl()
|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |