oracle.cabo.ui.partial
Class PartialPageRendererUtils

java.lang.Object
  |
  +--oracle.cabo.ui.partial.PartialPageRendererUtils

public class PartialPageRendererUtils

extends java.lang.Object

Utility methods for Renderers which support partial page rendering.

Method Summary

static java.lang.String	encodePartialTargets(java.lang.String[] partialTargets) Encodes the specified partial target IDs into a single value which is suitable for use as the "partialTargets" event parameter value.
static boolean	isFullRenderingPass(RenderingContext context) Returns true if we are performing a full page render in response to a partial page request.
static boolean	isPartialRenderingPass(RenderingContext context) Returns true if we are performing a partial page render.
static boolean	supportsPartialRendering(RenderingContext context) Tests whether partial page rendering is supported for the current render.

Methods inherited from class java.lang.Object

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

Method Detail

encodePartialTargets

public static java.lang.String encodePartialTargets(java.lang.String[] partialTargets)

Encodes the specified partial target IDs into a single value which is suitable for use as the "partialTargets" event parameter value.

Renderers should call this method to encode the set of partial target IDs when generating URLs or forms which contain the partialTargets event parameter.

Parameters:

partialTargets - The set of partial targets to encode

Returns:

Returns a String that can be used as the "partialTargets" event parameter value.

isPartialRenderingPass

public static boolean isPartialRenderingPass(RenderingContext context)

Returns true if we are performing a partial page render.

isFullRenderingPass

public static boolean isFullRenderingPass(RenderingContext context)

Returns true if we are performing a full page render in response to a partial page request.

supportsPartialRendering

public static boolean supportsPartialRendering(RenderingContext context)

Tests whether partial page rendering is supported for the current render.

Partial page rendering is not supported on all user agents. This method returns true if partial page rendering is supported by the agent associated with the provided RenderingContext.

At the moment, partial page rendering is treated as "inaccessible" and is only enabled when the AccessibilityMode is explicitly set to INACCESSIBLE_MODE. So, this method also checks the AccessibilityMode and only returns true if the INACCESSIBLE_MODE is specified. Note, however, that in the future we expect that some (if not all) uses of partial page rendering may be considered "accessible". In that case, it may be necessary to shift the responsibility of checking the AccessibleMode to the callers of this method.