org.apache.myfaces.trinidadinternal.renderkit.core
Class CoreRenderKit

java.lang.Object
  javax.faces.render.RenderKit
      org.apache.myfaces.trinidadinternal.renderkit.RenderKitBase
          org.apache.myfaces.trinidadinternal.renderkit.RenderKitDecorator
              org.apache.myfaces.trinidadinternal.renderkit.core.CoreRenderKit

All Implemented Interfaces:

org.apache.myfaces.trinidad.render.DialogRenderKitService, org.apache.myfaces.trinidad.render.ExtendedRenderKitService, org.apache.myfaces.trinidad.util.Service.Provider

public class CoreRenderKit
extends RenderKitDecorator
implements org.apache.myfaces.trinidad.render.DialogRenderKitService, org.apache.myfaces.trinidad.render.ExtendedRenderKitService

RenderKit based on UIX.

Version:

$Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/renderkit/core/CoreRenderKit.java#0 $) $Date: 10-nov-2005.19:01:18 $

Field Summary

static java.lang.String	BASE_RENDER_KIT_ID RenderKit ID for an internal and not-fully-functional kit that contains a base set of renderers.
static java.lang.String	OUTPUT_MODE_DEFAULT The default output mode; if no output mode is set, or the requested output mode is not available, this output mode will be used.
static java.lang.String	OUTPUT_MODE_EMAIL An e-mail output mode; when supported, this output mode should result in a version of page content optimized for use in e-mail.
static java.lang.String	OUTPUT_MODE_PORTLET A portlet output mode; when supported, this output mode should result in a version of page content optimized for use in portlets.
static java.lang.String	OUTPUT_MODE_PRINTABLE A printable output mode; when supported, this output mode should result in a version of a page designed for printouts.
static java.lang.String	RETURN_PARAM

Constructor Summary

CoreRenderKit()

Method Summary

void	addScript(javax.faces.context.FacesContext context, java.lang.String script) Adds a script for execution during rendering.
static java.lang.String	chooseRenderKit(javax.faces.context.FacesContext context) Choose a RenderKit for the current request.
javax.faces.context.ResponseStream	createResponseStream(java.io.OutputStream output)
javax.faces.context.ResponseWriter	createResponseWriter(java.io.Writer writer, java.lang.String contentTypeList, java.lang.String characterEncoding)
void	encodeBegin(javax.faces.context.FacesContext context) Called when the encoding of a page begins.
void	encodeEnd(javax.faces.context.FacesContext context) Called when the encoding of a page ends, if there were no exceptions.
void	encodeFinally(javax.faces.context.FacesContext context) Called when the encoding of a page completes, whether or not there were exceptions.
void	encodeScripts(javax.faces.context.FacesContext context)
protected java.lang.String	getDecoratedRenderKitId()
static java.lang.String	getId()
protected java.lang.String	getRenderKitMap()
javax.faces.render.ResponseStateManager	getResponseStateManager()
static boolean	isLegacyAjaxRequest(javax.faces.context.ExternalContext ec) Returns true if this is a Trinidad PPR Ajax request sent over with the legacy (non-JSF2 Ajax) mechanism
static boolean	isLegacyPartialRequest(javax.faces.context.ExternalContext ec) Returns true is this a PPR request sent by Trinidad (as opposed to a request sent with )
static boolean	isLegacyPartialRequest(java.util.Map<java.lang.String,java.lang.String[]> parameters) Returns true is this a PPR request sent by Trinidad (as opposed to a request sent with )
static boolean	isPartialRequest(javax.faces.context.ExternalContext ec) Returns true if this is a Trinidad PPR request or request
static boolean	isPartialRequest(java.util.Map<java.lang.String,java.lang.String[]> parameters) Returns true if this is a Trinidad PPR request or request
boolean	isReturning(javax.faces.context.FacesContext context, javax.faces.component.UIComponent source)
boolean	isStateless(javax.faces.context.FacesContext context)
boolean	launchDialog(javax.faces.context.FacesContext context, javax.faces.component.UIViewRoot targetRoot, javax.faces.component.UIComponent source, java.util.Map<java.lang.String,java.lang.Object> processParameters, boolean useWindow, java.util.Map<java.lang.String,java.lang.Object> windowProperties)
boolean	returnFromDialog(javax.faces.context.FacesContext context, java.lang.Object returnValue)
static void	saveDialogPostbackValues(java.lang.String returnId) Save the form name of the source page for use in subsequent postback.
boolean	shortCircuitRenderView(javax.faces.context.FacesContext context)
static boolean	usePopupForDialog(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RequestContext rc)

Methods inherited from class org.apache.myfaces.trinidadinternal.renderkit.RenderKitDecorator

addClientBehaviorRenderer, createDecoratedResponseWriter, findRenderer, getClientBehaviorRenderer, getClientBehaviorRendererTypes, getRenderKit, getService

Methods inherited from class org.apache.myfaces.trinidadinternal.renderkit.RenderKitBase

addRenderer, addRenderer, attachAggregatedRenderKit, getRenderer

Methods inherited from class javax.faces.render.RenderKit

getComponentFamilies, getRendererTypes

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_MODE_DEFAULT

public static final java.lang.String OUTPUT_MODE_DEFAULT

The default output mode; if no output mode is set, or the requested output mode is not available, this output mode will be used.

See Also:

Constant Field Values

OUTPUT_MODE_PORTLET

public static final java.lang.String OUTPUT_MODE_PORTLET

A portlet output mode; when supported, this output mode should result in a version of page content optimized for use in portlets.

See Also:

Constant Field Values

OUTPUT_MODE_PRINTABLE

public static final java.lang.String OUTPUT_MODE_PRINTABLE

A printable output mode; when supported, this output mode should result in a version of a page designed for printouts.

See Also:

Constant Field Values

OUTPUT_MODE_EMAIL

public static final java.lang.String OUTPUT_MODE_EMAIL

An e-mail output mode; when supported, this output mode should result in a version of page content optimized for use in e-mail.

See Also:

Constant Field Values

RETURN_PARAM

public static final java.lang.String RETURN_PARAM

See Also:

Constant Field Values

BASE_RENDER_KIT_ID

public static final java.lang.String BASE_RENDER_KIT_ID

RenderKit ID for an internal and not-fully-functional kit that contains a base set of renderers.

See Also:

Constant Field Values

Constructor Detail

CoreRenderKit

public CoreRenderKit()

Method Detail

getId

public static java.lang.String getId()

chooseRenderKit

public static java.lang.String chooseRenderKit(javax.faces.context.FacesContext context)

Choose a RenderKit for the current request.

isLegacyAjaxRequest

public static boolean isLegacyAjaxRequest(javax.faces.context.ExternalContext ec)

Returns true if this is a Trinidad PPR Ajax request sent over with the legacy (non-JSF2 Ajax) mechanism

isLegacyPartialRequest

public static boolean isLegacyPartialRequest(java.util.Map<java.lang.String,java.lang.String[]> parameters)

Returns true is this a PPR request sent by Trinidad (as opposed to a request sent with )

isLegacyPartialRequest

public static boolean isLegacyPartialRequest(javax.faces.context.ExternalContext ec)

Returns true is this a PPR request sent by Trinidad (as opposed to a request sent with )

isPartialRequest

public static boolean isPartialRequest(java.util.Map<java.lang.String,java.lang.String[]> parameters)

Returns true if this is a Trinidad PPR request or request

isPartialRequest

public static boolean isPartialRequest(javax.faces.context.ExternalContext ec)

Returns true if this is a Trinidad PPR request or request

getDecoratedRenderKitId

protected java.lang.String getDecoratedRenderKitId()

Specified by:

getDecoratedRenderKitId in class RenderKitDecorator

getRenderKitMap

protected java.lang.String getRenderKitMap()

Overrides:

getRenderKitMap in class RenderKitBase

saveDialogPostbackValues

public static void saveDialogPostbackValues(java.lang.String returnId)

Save the form name of the source page for use in subsequent postback. We save it at pageFlow scope, which means that it won't be seen by the original page - as long as this only gets called from the popup dialog, and not the originating page!

launchDialog

public boolean launchDialog(javax.faces.context.FacesContext context,
                            javax.faces.component.UIViewRoot targetRoot,
                            javax.faces.component.UIComponent source,
                            java.util.Map<java.lang.String,java.lang.Object> processParameters,
                            boolean useWindow,
                            java.util.Map<java.lang.String,java.lang.Object> windowProperties)

Specified by:

launchDialog in interface org.apache.myfaces.trinidad.render.DialogRenderKitService

usePopupForDialog

public static boolean usePopupForDialog(javax.faces.context.FacesContext context,
                                        org.apache.myfaces.trinidad.context.RequestContext rc)

returnFromDialog

public boolean returnFromDialog(javax.faces.context.FacesContext context,
                                java.lang.Object returnValue)

Specified by:

returnFromDialog in interface org.apache.myfaces.trinidad.render.DialogRenderKitService

isReturning

public boolean isReturning(javax.faces.context.FacesContext context,
                           javax.faces.component.UIComponent source)

Specified by:

isReturning in interface org.apache.myfaces.trinidad.render.DialogRenderKitService

shortCircuitRenderView

public boolean shortCircuitRenderView(javax.faces.context.FacesContext context)
                               throws java.io.IOException

Specified by:

shortCircuitRenderView in interface org.apache.myfaces.trinidad.render.ExtendedRenderKitService

Throws:

java.io.IOException

isStateless

public boolean isStateless(javax.faces.context.FacesContext context)

Specified by:

isStateless in interface org.apache.myfaces.trinidad.render.ExtendedRenderKitService

addScript

public void addScript(javax.faces.context.FacesContext context,
                      java.lang.String script)

Adds a script for execution during rendering.

Specified by:

addScript in interface org.apache.myfaces.trinidad.render.ExtendedRenderKitService

encodeScripts

public void encodeScripts(javax.faces.context.FacesContext context)
                   throws java.io.IOException

Specified by:

encodeScripts in interface org.apache.myfaces.trinidad.render.ExtendedRenderKitService

Throws:

java.io.IOException

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)

Called when the encoding of a page begins.

Specified by:

encodeBegin in interface org.apache.myfaces.trinidad.render.ExtendedRenderKitService

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context)

Called when the encoding of a page ends, if there were no exceptions.

Specified by:

encodeEnd in interface org.apache.myfaces.trinidad.render.ExtendedRenderKitService

encodeFinally

public void encodeFinally(javax.faces.context.FacesContext context)

Called when the encoding of a page completes, whether or not there were exceptions.

Specified by:

encodeFinally in interface org.apache.myfaces.trinidad.render.ExtendedRenderKitService

getResponseStateManager

public javax.faces.render.ResponseStateManager getResponseStateManager()

Overrides:

getResponseStateManager in class RenderKitDecorator

createResponseStream

public javax.faces.context.ResponseStream createResponseStream(java.io.OutputStream output)

Overrides:

createResponseStream in class RenderKitDecorator

createResponseWriter

public javax.faces.context.ResponseWriter createResponseWriter(java.io.Writer writer,
                                                               java.lang.String contentTypeList,
                                                               java.lang.String characterEncoding)

Overrides:

createResponseWriter in class RenderKitDecorator