|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
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.BackingContext com.bea.netuix.servlets.controls.window.backing.WindowBackingContext com.bea.netuix.servlets.controls.portlet.backing.PortletBackingContext
public class PortletBackingContext
This is the BackingContext for a portlet.
This PortletBackingContext
can only be referenced from a backing file. If you think you need to reference
this from a JSP you should look at PortletPresentationContext
.
To get a handle to the BackingContext just call the following:
PortletBackingContext.getPortletBackingContext(request);
JspBacking
,
Serialized FormField Summary | |
---|---|
static String |
CLASS_NAME
|
Method Summary | |
---|---|
void |
fireCustomEvent(QName name,
Serializable payload)
Fire a custom event with the specified QName. |
void |
fireCustomEvent(String eventName,
Serializable payload)
Fire a custom event with the default custom event namespace. |
String |
getAsyncContent()
Get the value of the portlet's asyncContent property. |
String |
getDisabledClassifications()
Returns classifications for which the underlying portlet is disabled. |
String |
getEnabledClassifications()
Returns classifications for which the underlying portlet is enabled. |
String |
getInstanceId()
Return the instance id of this portlet. |
String |
getInstanceLabel()
Return the unique instance label for the portlet. |
String |
getLabel()
Return the unique label for the portlet. |
String |
getLocalInstanceId()
Return the local instance id of this portlet. |
PageBackingContext |
getPageBackingContext()
Return the portlet's parent PageBackingContext. |
static PortletBackingContext |
getPortletBackingContext(javax.servlet.http.HttpServletRequest request)
A static helper to pull the current portlet's backing context out of the request. |
PortletPreferences |
getPortletPreferences(javax.servlet.http.HttpServletRequest request)
Returns a copy of the preferences for this portlet. |
String |
getPortletUri()
Get 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. |
void |
invalidateCache()
Invalidate this control's cache. |
boolean |
isAsyncContent()
Is the portlet set up to render asynchronously? |
boolean |
isContentOnly()
This field only applies to async portlets. |
boolean |
isDefaultMinimized()
Returns true if the underlying portlet has defaultMinimized set to true . |
boolean |
isDeleted()
Returns true if the portlet file is deleted. |
boolean |
isPortletRenderedByClient()
Returns true if this portlet is being rendered via client-side frameworks (such as the PortletSource Disc API) |
boolean |
isRemote()
This method returns true when the portlet is being invoked remotely via WSRP on a producer. |
void |
setRenderOnAjaxRequest(boolean render)
Force the portlet to render/not render when the Desktop asyncMode="enabled". |
void |
setSharedParameterValue(String name,
String value)
Sets the value of the specified shared parameter to the specified value. |
void |
setSharedParameterValues(String name,
String[] values)
Sets the value of the specified shared parameter to the specified values. |
Methods inherited from class com.bea.netuix.servlets.controls.window.backing.WindowBackingContext |
---|
getCapability, getCapabilityVisible, getDefinitionId, getDefinitionLabel, getDescription, getMetaData, getMetaDatas, getOrientation, getParentPageBackingContext, getParentWindowBackingContext, getPlacementId, getPreviousWindowMode, getPreviousWindowState, getRenderedChildrenWindowBackingContexts, getTitle, getWindowMode, getWindowState, isCapable, isPacked, setCapabilityVisible, setDescription, setTitle, setupModeChangeEvent, setupModeChangeEvent, setupPageChangeEvent, setupStateChangeEvent, setupStateChangeEventFromParent |
Methods inherited from class com.bea.netuix.servlets.controls.BackingContext |
---|
ensureCurrentLifecycleStageLegalForOperation, getChildrenBackingContexts, getParentBackingContext, getParsedProperties, getProperties, getProperty, getProperty, getSendRedirectPath, getTopParentBackingContext, isBackingPhase, isVisible, sendRedirect, setBackingPhase, setVisible |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CLASS_NAME
Method Detail |
---|
public String getLabel()
instanceLabel
.
getLabel
in class WindowBackingContext
public String getInstanceLabel()
instance Label.
- Returns
- the instance label.
public String getPortletUri()
example: /portlets/myportlet/myportlet.portlet
public String getInstanceId()
getInstanceId
in class WindowBackingContext
getLocalInstanceId()
public String getLocalInstanceId()
getInstanceId()
public static PortletBackingContext getPortletBackingContext(javax.servlet.http.HttpServletRequest request)
request
- the current HttpServletRequest
public PortletPreferences getPortletPreferences(javax.servlet.http.HttpServletRequest request)
request
- The current HTTPServletRequest instance
@Deprecated public PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)
Returns preferences for this portlet.
request
- HTTP request
public boolean isDefaultMinimized()
true
if the underlying portlet has defaultMinimized
set to true
.
true
if the portlet is defaultMinimized
public String getDisabledClassifications()
public String getEnabledClassifications()
public boolean isDeleted()
Returns true
if the portlet file is deleted. Portlets are marked deleted
when they are removed from the files system but still in use. The .portlet file must either
be restored or the portlet should be removed via the admin tools.
true
if the portlet file is deletedpublic void fireCustomEvent(String eventName, Serializable payload)
eventName
- The name of the event. This will be matched against the
'name'
or 'qname'
attribute of the
handleCustomEvent
tag.payload
- The arbitrary payload that the event will carry.public void fireCustomEvent(QName name, Serializable payload)
name
- The QName of the event. This will be matched against the
'name'
or 'qname'
attribute of the
handleCustomEvent
tag.payload
- The arbitrary payload that the event will carry.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 setSharedParameterValue(String name, String value)
name
- the parameterID of the parameter to set. If the name is not
a registered shared parameter, an error is logged and nothing else is done.value
- the new value for the parameter. If null
,
the shared parameter will be removed.public void setSharedParameterValues(String name, String[] values)
name
- the parameterID of the parameter to set. If the name is not
a registered shared parameter, an error is logged and nothing else is done.values
- the new values for the parameter. If null
,
the shared parameter will be removed.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 PageBackingContext getPageBackingContext()
public void invalidateCache()
public void setRenderOnAjaxRequest(boolean render)
Force the portlet to render/not render when the Desktop asyncMode="enabled". Note: This method must be called before preRender(), therfore, call in init() or handlePostbackData().
render
- this portlet whether changed or not.public boolean isPortletRenderedByClient()
public boolean isRemote()
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |