|
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.Object 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
Field Summary | |
---|---|
static String |
CLASS_NAME
|
Method Summary | |
---|---|
void |
fireCustomEvent(String eventName,
Serializable payload)
Fire a custom event. |
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. |
PageBackingContext |
getPageBackingContext()
Return the portlets parent PageBackingContext. |
static PortletBackingContext |
getPortletBackingContext(HttpServletRequest request)
A static helper to pull the current portlet's backing context out of the request. |
PortletPreferences |
getPortletPreferences(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(HttpServletRequest request)
Deprecated Use getPortletPreferences instead |
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. |
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, getTopParentBackingContext, isBackingPhase, isVisible, 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
public static PortletBackingContext getPortletBackingContext(HttpServletRequest request)
request
-
public PortletPreferences getPortletPreferences(HttpServletRequest request)
request
- The current HTTPServletRequest instance
public PortletPreferences getPreferences(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'
attribute of the handleCustomEvent
tag.payload
- The arbitrary payload that the event will carry.public boolean isAsyncContent()
asyncContent
property on the portlet is configured to anything besides "none".public boolean isContentOnly()
public PageBackingContext getPageBackingContext()
public void invalidateCache()
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |