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

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 portlets parent PageBackingContext.
static PortletBackingContext	getPortletBackingContext(HttpServletRequest request) A static helper to pull the current portlet's backing context out of the request.
String	getPortletUri() Get the portlet's URI.
PortletPreferences	getPreferences(HttpServletRequest request) Returns preferences for this portlet.
void	invalidateCache() Invalidate this control's cache.
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, getOrientation, 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

getChildrenBackingContexts, 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

Field Detail

CLASS_NAME

public static final String CLASS_NAME

Method Detail

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.

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

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)

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.

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.

getPageBackingContext

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

public static PortletBackingContext getPortletBackingContext(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.

getPortletUri

public String getPortletUri()

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

Returns:

A String containing the portlet's URI.

getPreferences

public PortletPreferences getPreferences(HttpServletRequest request)

Returns preferences for this portlet.

Parameters:

request - HTTP request

Returns:

preferences

invalidateCache

public void invalidateCache()

Invalidate this control's cache.

isDefaultMinimized

public boolean isDefaultMinimized()

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

Returns:

true if the portlet is defaultMinimized

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