Skip navigation links

oracle.adf.view.rich.error.portlet
Class PortletErrorRenderer

java.lang.Object
javax.faces.render.Renderer
org.apache.myfaces.trinidad.render.CoreRenderer
oracle.adfinternal.view.faces.renderkit.rich.portlet.PortletErrorRenderer
oracle.adf.view.rich.error.portlet.PortletErrorRenderer

public abstract class PortletErrorRenderer

extends oracle.adfinternal.view.faces.renderkit.rich.portlet.PortletErrorRenderer

Renderer subclass used for rendering exceptions that occur when rendering portlets. Subclasses of this class can be used to determine what the portlet shows when an error occurs, either on the consumer, because of communication problems with the producer or errors delivered from the producer.

Use the method hideShowDetailFrame(org.apache.myfaces.trinidad.bean.FacesBean) to indicate whether the portlet should be visible at all if there is an error.

Override the usual renderer encodeAll method to render the error content in the portlet.

The default impementation is DefaultErrorRenderer. To create a custom error renderer it is recommended to extend DefaultErrorRenderer.

The custom error renderer is configured using renderkit configuration in faces-config.xml.

 <render-kit>
     <renderer>
       <component-family>oracle.adf.portlet</component-family>
       <renderer-type>oracle.adf.rich.PortletErrorRenderer</renderer-type>
       <renderer-class>oracle.adf.view.rich.portlet.error.DefaultErrorRenderer</renderer-class>
     </renderer>
   </render-kit>
 
 

The config above would cause the DefaultErrorRender to be used, which is the same as if this configuration were ommitted. Replace the renderer-class with your own custom renderer class.

See Also:

DefaultErrorRenderer

Field Summary

static java.lang.String

RENDERER_TYPE

Fields inherited from class oracle.adfinternal.view.faces.renderkit.rich.portlet.PortletErrorRenderer

_portletExceptionKey

Fields inherited from class org.apache.myfaces.trinidad.render.CoreRenderer

CHAR_UNDEFINED, NO_CHILD_INDEX

Constructor Summary

PortletErrorRenderer()
Default constructor.

Method Summary

protected void	findTypeConstants(org.apache.myfaces.trinidad.bean.FacesBean.Type type)
protected java.lang.Throwable	getPortletException(org.apache.myfaces.trinidad.bean.FacesBean bean) Return the Throwable exception that occurred, causing this PortletErrorRenderer to be invoked.
boolean	getRendersChildren()
abstract boolean	hideShowDetailFrame(org.apache.myfaces.trinidad.bean.FacesBean bean) Determines whether the Portlet ShowDetailFrame chrome should be shown when an error occurs.

Methods inherited from class org.apache.myfaces.trinidad.render.CoreRenderer

afterEncode, beforeEncode, delegateRenderer, delegateRendererBegin, delegateRendererEnd, encodeAll, encodeAllChildren, encodeBegin, encodeBegin, encodeChild, encodeChildren, encodeEnd, encodeEnd, getClientId, getFacesBean, getFacet, getNextRenderedChildIndex, getRenderedChildCount, getRenderedFacetsAndChildren, getRenderingProperty, hasRenderedChildren, isDesktop, isGecko, isGenericPDA, isIE, isInaccessibleMode, isIPhone, isKonqueror, isNokiaS60, isPDA, isScreenReaderMode, isWebKit, partialEncodeVisit, renderEncodedActionURI, renderEncodedResourceURI, renderId, renderStyleClass, renderStyleClasses, setRenderingProperty, setupEncodingContext, setupEncodingContext, shouldRenderId, skipDecode, tearDownEncodingContext, tearDownEncodingContext, toActionUri, toChar, toInt, toLong, toResourceUri, toString, toUri

Methods inherited from class javax.faces.render.Renderer

convertClientId, decode, getConvertedValue

Methods inherited from class java.lang.Object

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

Field Detail

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

PortletErrorRenderer

public PortletErrorRenderer()

Default constructor.

Method Detail

hideShowDetailFrame

public abstract boolean hideShowDetailFrame(org.apache.myfaces.trinidad.bean.FacesBean bean)

Determines whether the Portlet ShowDetailFrame chrome should be shown when an error occurs. The exception that occurred can be retrieved using @{link #getPortletException}

Specified by:

hideShowDetailFrame in class oracle.adfinternal.view.faces.renderkit.rich.portlet.PortletErrorRenderer

Parameters:

bean - the FacesBean for this renderer

Returns:

boolean indicated whether the chrome should be shown.

getPortletException

protected java.lang.Throwable getPortletException(org.apache.myfaces.trinidad.bean.FacesBean bean)

Return the Throwable exception that occurred, causing this PortletErrorRenderer to be invoked.

Overrides:

getPortletException in class oracle.adfinternal.view.faces.renderkit.rich.portlet.PortletErrorRenderer

Parameters:

bean - the FacesBean for this renderer

Returns:

the Throwable that caused this error.

findTypeConstants

protected void findTypeConstants(org.apache.myfaces.trinidad.bean.FacesBean.Type type)

Overrides:

findTypeConstants in class oracle.adfinternal.view.faces.renderkit.rich.portlet.PortletErrorRenderer

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class oracle.adfinternal.view.faces.renderkit.rich.portlet.PortletErrorRenderer

Skip navigation links