|
© 2003 BEA Systems, Inc. | |||||||||
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
The PortletBackingContext
is used to effect the underlying portlet. 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);
Field Summary |
Fields inherited from class com.bea.netuix.servlets.controls.ControlContext |
debug |
Method Summary | |
String |
getDisabledClassifications()
Returns disabled classifications for underlying portlet. |
String |
getEnabledClassifications()
Returns enabled classifications for underlying portlet. |
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. |
static PortletBackingContext |
getPortletBackingContext(HttpServletRequest request)
A static helper to pull the current portlet's backing context out of the request. |
String |
getPortletUri()
Getter for the portlet's URI. |
PortletPreferences |
getPreferences(HttpServletRequest request)
Returns preferences for this portlet. |
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 |
getCapabilityVisible, getDefinitionId, getDefinitionLabel, getDescription, getOrientation, getParentWindowBackingContext, getPlacementId, getPreviousWindowMode, getPreviousWindowState, getRenderedChildrenWindowBackingContexts, getTitle, getWindowMode, getWindowState, isCapable, isPacked, setCapabilityVisible, setDescription, setTitle, setupModeChangeEvent, setupModeChangeEvent, setupPageChangeEvent, setupStateChangeEvent |
Methods inherited from class com.bea.netuix.servlets.controls.BackingContext |
getChildrenBackingContexts, getContextFromRequest, getParentBackingContext, getTopParentBackingContext, isBackingPhase, isVisible, setBackingPhase, setVisible |
Methods inherited from class com.bea.netuix.servlets.controls.ControlContext |
getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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 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 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 areremoved 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 deleted
|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |