WebflowPresentationContext Class

com.bea.netuix.servlets.controls.window
WebflowPresentationContext Class

public class WebflowPresentationContext

    extends PortletPresentationContext

Used to provide access to presentation-related attributes specific to the WebflowPortlet in use. Typically used during portal rendering via look and feel skeleton files (e.g. webflowportlet.jsp).

Related Topics

WebflowPresentationContext.getWebflowPresentationContext(HttpServletRequest)

Hierarchy
Object
  ControlContext
    PresentationContext
      WindowPresentationContext
        PortletPresentationContext
          WebflowPresentationContext
All Implemented Interfaces

Serializable

Field Summary
   
Fields from  com.bea.netuix.servlets.controls.window.WindowPresentationContext
CLASS_NAME
 
Fields from  com.bea.netuix.servlets.controls.ControlContext
debug
 

Constructor Summary
 

Method Summary
public String
getAltFooterUri()
Returns the alternate footer URI pertaining to the webflow contained within this WebflowPortlet.
public String
getAltHeaderUri()
Returns the alternate header URI pertaining to the webflow contained within this WebflowPortlet.
public String
getContentUri()
Returns the content URI to the webflow contained within this WebflowPortlet.
public String
getCurrentContentUri()
Returns the current content URI to the webflow contained within this WebflowPortlet.
public Exception
getException()
If the webflow inside the WebflowPortlet threw an exception, it can be retrieved with this method.
public String
getFooterUri()
Returns the footer URI pertaining to the webflow contained within this WebflowPortlet.
public String
getHeaderUri()
Returns the header URI pertaining to the webflow contained within this WebflowPortlet.
public String
getLabel()
Returns the instance label for the given WebflowPortlet.
public String
getWebflowName()
Returns the name of the webflow.
public static WebflowPresentationContext
getWebflowPresentationContext(HttpServletRequest request)
This is a convenience method for returning a reference to the one and only WebflowPresentationContext for a given WebflowPortlet.
 
Methods from  com.bea.netuix.servlets.controls.portlet.PortletPresentationContext
getInstanceLabel, getPagePresentationContext, getPortletPresentationContext, getPortletUri, getPreferences, isCapable, isDefaultMinimized
 
Methods from  com.bea.netuix.servlets.controls.window.WindowPresentationContext
getCapability, getContentPresentationClass, getContentPresentationContextChildren, getContentPresentationStyle, getDefinitionId, getDefinitionLabel, getInstanceId, getLabel, getOrientation, getParentPagePresentationContext, getPreviousWindowMode, getThemePresentationContext, getTitle, getTitlebarPresentationContext, getWindowMode, getWindowPresentationContext, getWindowState, isCapable, isPacked
 
Methods from  com.bea.netuix.servlets.controls.PresentationContext
getChildren, getChildren, getFirstChild, getParsedProperties, getPresentationClass, getPresentationId, getPresentationStyle, getProperties, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsInt, getResolvedLocale, getTagName, isVisible, setVisible
 
Methods from  com.bea.netuix.servlets.controls.ControlContext
getContextFromRequest, getContextKey, getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Constructor Detail
 

Method Detail

getAltFooterUri() Method

public String getAltFooterUri()
Returns the alternate footer URI pertaining to the webflow contained within this WebflowPortlet.

Returns

the altFooterUri, if any

getAltHeaderUri() Method

public String getAltHeaderUri()
Returns the alternate header URI pertaining to the webflow contained within this WebflowPortlet.

Returns

the altHeaderUri, if any

getContentUri() Method

public String getContentUri()
Returns the content URI to the webflow contained within this WebflowPortlet.

Returns

the contentUri

getCurrentContentUri() Method

public String getCurrentContentUri()
Returns the current content URI to the webflow contained within this WebflowPortlet.

Returns

the currentContentUri

getException() Method

public Exception getException()
If the webflow inside the WebflowPortlet threw an exception, it can be retrieved with this method.

Returns

a thrown webflow exception, if any

getFooterUri() Method

public String getFooterUri()
Returns the footer URI pertaining to the webflow contained within this WebflowPortlet.

Returns

the footerUri, if any

getHeaderUri() Method

public String getHeaderUri()
Returns the header URI pertaining to the webflow contained within this WebflowPortlet.

Returns

the headerUri, if any

getLabel() Method

public String getLabel()
Returns the instance label for the given WebflowPortlet. This can be used to uniquely identify a WebflowPortlet.

Overrides
PortletPresentationContext.getLabel()

Returns

the instance label of the WebflowPortlet

getWebflowName() Method

public String getWebflowName()
Returns the name of the webflow.

Returns

name of the webflow, if any

getWebflowPresentationContext(HttpServletRequest) Method

public static WebflowPresentationContext getWebflowPresentationContext(HttpServletRequest request)
This is a convenience method for returning a reference to the one and only WebflowPresentationContext for a given WebflowPortlet. Note this method will only work if called from within a portal (e.g. webflowportlet.jsp skeleton). This method may return null if called when no appropriate context exists, but such a context should safely exist when being fetched from the associated skeleton JSP during normal portal rendering.

Parameters

request
The current HTTPServletRequest instance

Returns

A reference to the current WebflowPresentationContext, if any