PortletBackingContext Class

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

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);

Related Topics

JspBacking

Hierarchy
Object
  ControlContext
    BackingContext
      WindowBackingContext
        PortletBackingContext
All Implemented Interfaces

Serializable

Field Summary
public static final String
CLASS_NAME
String
   
Fields from  com.bea.netuix.servlets.controls.window.backing.WindowBackingContext
CLASS_NAME
 
Fields from  com.bea.netuix.servlets.controls.ControlContext
debug
 

Constructor Summary
 

Method Summary
public void
fireCustomEvent(String eventName, Serializable payload)
Fire a custom event.
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.
public String
getInstanceLabel()
Return the unique instance label for the portlet.
public String
getLabel()
Return the unique label for the portlet.
public PageBackingContext
getPageBackingContext()
Return the portlets parent PageBackingContext.
public static PortletBackingContext
getPortletBackingContext(HttpServletRequest request)
A static helper to pull the current portlet's backing context out of the request.
public String
getPortletUri()
Get the portlet's URI.
public PortletPreferences
getPreferences(HttpServletRequest request)

Returns preferences for this portlet.
public boolean
isDefaultMinimized()
Returns true if the underlying portlet has defaultMinimized set to true.
public boolean
isDeleted()

Returns true if the portlet file is deleted.

 
Methods from  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
 
Methods from  com.bea.netuix.servlets.controls.BackingContext
getChildrenBackingContexts, getParentBackingContext, getTopParentBackingContext, isBackingPhase, isVisible, setBackingPhase, setVisible
 
Methods from  com.bea.netuix.servlets.controls.ControlContext
getContextFromRequest, getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest
 
Methods 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

 

Constructor Detail
 

Method Detail

fireCustomEvent(String, Serializable) Method

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

public String getDisabledClassifications()
Returns classifications for which the underlying portlet is disabled.

Returns

disabled classifications

getEnabledClassifications() Method

public String getEnabledClassifications()
Returns classifications for which the underlying portlet is enabled.

Returns

enabled classifications

getInstanceId() Method

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

Returns

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

getInstanceLabel() Method

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