WindowBackingContext
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);
Related Topics
Object
ControlContext
BackingContext
WindowBackingContext
PortletBackingContext
Serializable
Field Summary |
public static final |
|
Fields from com.bea.netuix.servlets.controls.window.backing. |
|
Fields from com.bea.netuix.servlets.controls. |
debug |
Constructor Summary |
Method Summary |
public void |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public static |
|
public |
|
public |
|
public boolean |
|
public boolean |
|
Methods from com.bea.netuix.servlets.controls.window.backing. |
|
Methods from com.bea.netuix.servlets.controls. |
|
Methods from com.bea.netuix.servlets.controls. |
getContextFromRequest, getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest |
Methods from class java.lang. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String
CLASS_NAME
Constructor Detail |
Method Detail |
public void fireCustomEvent(Fire a custom event. Should only be called in handlePostback or in an event handler.String
eventName,Serializable
payload)
'name'
attribute of the handleCustomEvent
tag.
public String
getDisabledClassifications()
Returns classifications for which the underlying portlet is disabled.
public String
getEnabledClassifications()
Returns classifications for which the underlying portlet is enabled.
public String
getInstanceId()
Return the instance id of this portlet. Note: the instance id is only populated
when in streaming mode, not single file mode. This can be used with the persistence API.
WindowBackingContext.getInstanceId()
public String
getInstanceLabel()
Return the unique instance label for the portlet. This is the property defined in the IDE as instance Label.
Returns
- the instance label.
getLabel() Method
public String
getLabel()
Return the unique label for the portlet. For portlets this is the same as instanceLabel
.
-
Overrides
-
WindowBackingContext.getLabel()
Returns
- the instance label.
getPageBackingContext() Method
public PageBackingContext
getPageBackingContext()
Return the portlets parent PageBackingContext.
Returns
- If this portlet is placed on a page then a reference to the pages backing context otherwise null.
getPortletBackingContext(HttpServletRequest) Method
public static PortletBackingContext
getPortletBackingContext(HttpServletRequest
request)
A static helper to pull the current portlet's backing context out of the request.
Returns
- A reference to the currents windows backing context.
getPortletUri() Method
public String
getPortletUri()
Get the portlet's URI.
example: /portlets/myportlet/myportlet.portlet
Returns
- A String containing the portlet's URI.
getPreferences(HttpServletRequest) Method
public PortletPreferences
getPreferences(HttpServletRequest
request)
Returns preferences for this portlet.
Parameters
-
request
- HTTP request
Returns
- preferences
isDefaultMinimized() Method
public boolean isDefaultMinimized()
Returns true
if the underlying portlet has defaultMinimized
set to true
.
Returns
true
if the portlet is defaultMinimized
isDeleted() Method
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.
Returns
true
if the portlet file is deleted