com.bea.netuix.servlets.controls.portlet.backing
Class PortletBackingContext

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

All Implemented Interfaces

Serializable

Direct Known Subclasses:

ProxyPortletBackingContext

public class PortletBackingContext
extends 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);

See Also

JspBacking, Serialized Form

Field Summary

static String

CLASS_NAME

Fields inherited from class com.bea.netuix.servlets.controls.ControlContext

debug

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 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
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.
void	setRenderOnAjaxRequest(boolean render) Force the portlet to render/not render when the Desktop asyncMode="enabled".

Methods inherited from class com.bea.netuix.servlets.controls.window.backing.WindowBackingContext

ensureControlNotPruned, 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 com.bea.netuix.servlets.controls.ControlContext

getContextFromRequest, getControl, getControlContextStack, getPrimaryControlContextStack, getRequestKey, getUniqueId, removeContextFromRequest, setCloneContexts, setContextInRequest, unsetCloneContexts

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_NAME

public static final String CLASS_NAME

Method Detail

getLabel

public String getLabel()

Return the unique label for the portlet. For portlets this is the same as instanceLabel.

Specified by:

getLabel in class WindowBackingContext

Returns

the instance label.

getInstanceLabel

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.

getPortletUri

public String getPortletUri()

Get the portlet's URI.
example: /portlets/myportlet/myportlet.portlet

Returns

A String containing the portlet's URI.

getInstanceId

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.

Overrides:

getInstanceId in class WindowBackingContext

Returns

A string representation of the portlet's instance id (this is always a number)

getPortletBackingContext

public static PortletBackingContext getPortletBackingContext(javax.servlet.http.HttpServletRequest request)

A static helper to pull the current portlet's backing context out of the request.

Parameters

request -

Returns

A reference to the currents windows backing context.

getPortletPreferences

public PortletPreferences getPortletPreferences(javax.servlet.http.HttpServletRequest request)

Returns a copy of the preferences for this portlet.

Parameters

request - The current HTTPServletRequest instance

Returns

The preferences instance

getPreferences

public PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)

Deprecated Use getPortletPreferences instead

Returns preferences for this portlet.

Parameters

request - HTTP request

Returns

preferences

isDefaultMinimized

public boolean isDefaultMinimized()

Returns true if the underlying portlet has defaultMinimized set to true.

Returns

true if the portlet is defaultMinimized

getDisabledClassifications

public String getDisabledClassifications()

Returns classifications for which the underlying portlet is disabled.

Returns

disabled classifications

getEnabledClassifications

public String getEnabledClassifications()

Returns classifications for which the underlying portlet is enabled.

Returns

enabled classifications

isDeleted

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

fireCustomEvent

public void fireCustomEvent(String eventName,
                            Serializable payload)

Fire a custom event. Should only be called in handlePostback or in an event handler.

Parameters

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.

isAsyncContent

public boolean isAsyncContent()

Is the portlet set up to render asynchronously?

Returns

true if the asyncContent property on the portlet is configured to anything besides "none".

isContentOnly

public boolean isContentOnly()

This field only applies to async portlets. This method returns true for the async request that actually renders the portlet content, and false for the "original" portal request that renders the main portal and portlet outline.

getPageBackingContext

public PageBackingContext getPageBackingContext()

Return the portlet's parent PageBackingContext.

Returns

If this portlet is placed on a page then a reference to the pages backing context, otherwise null.

invalidateCache

public void invalidateCache()

Invalidate this control's cache.

setRenderOnAjaxRequest

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().

Parameters

render - this portlet whether changed or not.