oracle.adf.view.faces.context
Class AdfFacesContext

java.lang.Object
  |
  +--oracle.adf.view.faces.context.AdfFacesContext

public abstract class AdfFacesContext

extends java.lang.Object

Context class for all per-request and per-webapp information required by UIX. A AdfFacesContext object can be retrieved with the static getCurrentInstance() method. There is one and only one AdfFacesContext object active in any one thread.

This class does not extend FacesContext; this is intentional, as extending FacesContext requires taking over the FacesContextFactory.

Field Summary

static java.lang.String

VARIABLE_NAME Name of the EL implicit variable ("adfFacesContext") that is used to expose this context object.

Constructor Summary

AdfFacesContext()

Method Summary

abstract void	addPartialTarget(javax.faces.component.UIComponent newTarget)
protected void	attach() Attaches a AdfFacesContext to the current thread.
abstract java.lang.String	getAccessibilityMode() Returns the name of the current accessibility mode.
abstract java.util.Map	getColorPalette() Returns a Map that takes color palette names as keys, and returns the color palette as a result.
abstract java.lang.String	getCurrencyCode() Return the ISO 4217 currency code used by default for formatting currency fields when those fields do not specify an explicit currency field via their converter.
static AdfFacesContext	getCurrentInstance() Retrieves the AdfFacesContext active for the current thread.
abstract char	getDecimalSeparator() Return the separator used as the decimal point.
abstract java.util.Map	getFormatter() Returns a Map that performs message formatting with a recursive Map structure.
abstract java.util.Map	getHelpSystem() Returns a Map that will accept help system properties as keys, and return an URL as a result.
abstract java.util.Map	getHelpTopic() Returns a Map that will accept topic names as keys, and return an URL as a result.
abstract java.lang.String	getLookAndFeel() Returns the name of the preferred look-and-feel.
abstract char	getNumberGroupingSeparator() Return the separator used for groups of numbers.
abstract java.lang.String	getOracleHelpServletUrl() Return the URL to an Oracle Help for the Web servlet.
abstract java.lang.String	getOutputMode() Returns the "output mode" - printable, etc.
abstract java.util.Map	getPageFlowScope() Returns a Map of objects at "page flow" scope.
abstract java.util.TimeZone	getTimeZone() Returns the default TimeZone used for interpreting and formatting date values.
abstract boolean	isDebugOutput() Returns true if output should contain debugging information.
abstract boolean	isRightToLeft() Returns true if the user should be shown output in right-to-left.
void	release() Releases the AdfFacesContext object.

Methods inherited from class java.lang.Object

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

Field Detail

VARIABLE_NAME

public static final java.lang.String VARIABLE_NAME

Name of the EL implicit variable ("adfFacesContext") that is used to expose this context object.

See Also:

Constant Field Values

Constructor Detail

AdfFacesContext

public AdfFacesContext()

Method Detail

getCurrentInstance

public static AdfFacesContext getCurrentInstance()

Retrieves the AdfFacesContext active for the current thread.

getPageFlowScope

public abstract java.util.Map getPageFlowScope()

Returns a Map of objects at "page flow" scope.

isDebugOutput

public abstract boolean isDebugOutput()

Returns true if output should contain debugging information.

getOutputMode

public abstract java.lang.String getOutputMode()

Returns the "output mode" - printable, etc.

getLookAndFeel

public abstract java.lang.String getLookAndFeel()

Returns the name of the preferred look-and-feel.

getAccessibilityMode

public abstract java.lang.String getAccessibilityMode()

Returns the name of the current accessibility mode.

isRightToLeft

public abstract boolean isRightToLeft()

Returns true if the user should be shown output in right-to-left.

getNumberGroupingSeparator

public abstract char getNumberGroupingSeparator()

Return the separator used for groups of numbers. If NUL (zero), use the default separator for the current language.

getDecimalSeparator

public abstract char getDecimalSeparator()

Return the separator used as the decimal point. If NUL (zero), use the default separator for the current language.

getCurrencyCode

public abstract java.lang.String getCurrencyCode()

Return the ISO 4217 currency code used by default for formatting currency fields when those fields do not specify an explicit currency field via their converter. If this returns null, the default code for the current locale will be used.

getOracleHelpServletUrl

public abstract java.lang.String getOracleHelpServletUrl()

Return the URL to an Oracle Help for the Web servlet.

getHelpTopic

public abstract java.util.Map getHelpTopic()

Returns a Map that will accept topic names as keys, and return an URL as a result.

getHelpSystem

public abstract java.util.Map getHelpSystem()

Returns a Map that will accept help system properties as keys, and return an URL as a result.

getTimeZone

public abstract java.util.TimeZone getTimeZone()

Returns the default TimeZone used for interpreting and formatting date values.

addPartialTarget

public abstract void addPartialTarget(javax.faces.component.UIComponent newTarget)

getColorPalette

public abstract java.util.Map getColorPalette()

Returns a Map that takes color palette names as keys, and returns the color palette as a result.

getFormatter

public abstract java.util.Map getFormatter()

Returns a Map that performs message formatting with a recursive Map structure. The first key must be the message formatting mask, and the second the first parameter into the message. (The formatter Map supports only a single parameter at this time.)

release

public void release()

Releases the AdfFacesContext object. This method must only be called by the code that created the AdfFacesContext.

attach

protected void attach()

Attaches a AdfFacesContext to the current thread. This method is protected, and therefore can only be called by a AdfFacesContext object itself.