public abstract class AdfFacesContext extends Object
Modifier and Type | Class and Description |
---|---|
static class |
AdfFacesContext.OutputMode
Enumeration representing OutputModes
|
static class |
AdfFacesContext.PayloadType
Enumeration of the types of postback payloads supported by ADF.
|
Modifier and Type | Field and Description |
---|---|
static String |
MEDIA_FEATURE_COLOR |
static String |
MEDIA_FEATURE_COLOR_INDEX |
static String |
MEDIA_FEATURE_DEVICE_HEIGHT |
static String |
MEDIA_FEATURE_DEVICE_WIDTH |
static String |
MEDIA_FEATURE_GRID |
static String |
MEDIA_FEATURE_HEIGHT |
static String |
MEDIA_FEATURE_MONOCHROME |
static String |
MEDIA_FEATURE_ORIENTATION |
static String |
MEDIA_FEATURE_RESOLUTION |
static String |
MEDIA_FEATURE_SCAN |
static String |
MEDIA_FEATURE_WIDTH |
static String |
MEDIA_FONT_SIZE |
static String |
MEDIA_TYPE |
static String |
VARIABLE_NAME
Name of the EL implicit variable ("adfFacesContext") that is used to expose this context object.
|
Constructor and Description |
---|
AdfFacesContext() |
Modifier and Type | Method and Description |
---|---|
abstract void |
addPartialTarget(javax.faces.component.UIComponent newTarget)
Add a component as a partial target.
|
abstract void |
addPartialTriggerListeners(javax.faces.component.UIComponent listener, String[] trigger)
Adds a listener on a set of particular triggering components.
|
abstract UnassociatedPage |
createPage()
Creates a new instance of the UnassociatedPage object that could be used to pass data to a different URL The UnassociatedPage object returned by this method should only be used during the current request.
|
abstract String |
getAccessibilityMode()
Returns the name of the current accessibility mode.
|
Agent |
getAgent()
Returns the Agent information for the current context
|
abstract ApplicationContextManager |
getApplicationContextManager()
Deprecated.
use
RequestContext.getComponentContextManager() instead of this method. |
abstract BackingBeanScopeProvider |
getBackingBeanScopeProvider()
Returns a BackingBeanScopeProvider instance and is shared across the entire application.
|
ChangeManager |
getChangeManager()
Deprecated.
use Trinidad API getChangeManager() in org.apache.myfaces.trinidad.context.RequestContext instead
|
abstract List<Color> |
getColorPalette(String name)
Returns a List that takes color palette name as key, and returns the color palette as a result.
|
abstract 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 Page |
getCurrentPage()
Retrieves a current instance of the Page object for storing data specific to this page within the current window The Page object returned by this method should only be used during the current request.
|
abstract DataUpdateManager |
getDataUpdateManager()
Returns the DataUpdateManager to use for registering and unregistering components for use with eitehr automatic PPR or active Datata
|
abstract char |
getDecimalSeparator()
Return the separator used as the decimal point.
|
abstract DialogService |
getDialogService()
Returns an DialogService, which exposes a number of APIs needed by component and framework developers.
|
abstract DirtyPageHandler |
getDirtyPageHandler()
Returns DirtyPageHandler service registered under meta-inf/services or a default implementation if none was found
|
abstract EndUserMonitoringService |
getEndUserMonitoringService()
Deprecated.
use
getEndUserMonitoringServices() instead. |
abstract List<EndUserMonitoringService> |
getEndUserMonitoringServices()
Returns a list of EndUserMonitoringService providers.
|
abstract ExecutionContextProvider |
getExecutionContextProvider()
Returns an ExecutionContextDataProvider to use for retrieving context information pertaining to the current request.
|
abstract Map |
getFormatter()
Returns a Map that performs message formatting with a recursive Map structure.
|
abstract HelpProvider |
getHelpProvider()
Gets the HelpProvider that is registered in META-INF/adf-settings.xml.
|
Map |
getHelpSystem()
Deprecated.
on 24-jan-2007, for 11.1.1.0.JI2. Use the new
HelpProvider framework. |
Map |
getHelpTopic()
Deprecated.
on 24-jan-2007, for 11.1.1.0.JI2. Use the new
HelpProvider framework. |
abstract NewSessionURLProvider |
getNewSessionURLProvider()
Returns the NewSessionURLProvider instance
|
abstract char |
getNumberGroupingSeparator()
Return the separator used for groups of numbers.
|
String |
getOracleHelpServletUrl()
Deprecated.
on 24-jan-2007, for 11.1.1.0.JI2. Use the new
HelpProvider framework. |
String |
getOutputMode() |
AdfFacesContext.OutputMode |
getOutputModeEnum()
Returns the OutputMode enumeration
|
abstract Map<String,Object> |
getPageFlowScope()
Returns a Map of objects at "pageFlow" scope.
|
PageFlowScopeProvider |
getPageFlowScopeProvider()
Gets the PageFlowScopeProvider for the current application.
|
PageResolver |
getPageResolver()
Gets the PageResolver for the current application.
|
abstract org.apache.myfaces.trinidad.change.ChangeManager |
getPersistentChangeManager()
Returns the persistent change manager registered through web.xml for the current application
|
AdfFacesContext.PayloadType |
getPostbackPayloadType()
Returns the type of postback payload that has been submitted for this request.
|
Map |
getProcessScope()
Deprecated.
since 11.0; use getPageFlowScope()
|
RegionManager |
getRegionManager()
Gets the RegionManager for the current application.
|
abstract String |
getSkinFamily()
Returns the name of the preferred skin family.
|
abstract TimeZone |
getTimeZone()
Returns the default TimeZone used for interpreting and formatting date values.
|
abstract int |
getTwoDigitYearStart()
Returns the year offset for parsing years with only two digits.
|
abstract UriManager |
getUriManager()
Retrieves an instance of UriManager for manipulation browser URIs
|
abstract String |
getViewDeclarationLanguageId()
Returns the ViewDeclarationLanguage identifier for the current request.
|
abstract Map<String,Object> |
getViewScope()
Returns a Map of objects at "view" scope.
|
abstract WindowIdProvider |
getWindowIdProvider()
Deprecated.
Use
WindowManagerFactory.getWindowManager(javax.faces.context.ExternalContext) . |
abstract WindowIdProvider |
getWindowIdProvider(javax.faces.context.ExternalContext externalContext)
Deprecated.
Use
WindowManagerFactory.getWindowManager(javax.faces.context.ExternalContext) . |
abstract boolean |
isClientValidationDisabled()
Returns true if client-side validation should be disabled.
|
abstract boolean |
isDebugOutput()
Returns true if output should contain debugging information.
|
abstract boolean |
isFurtherValidationNeeded()
Returns true if a framework providing additional validation on top of the faces lifecycle should run that validation.
|
abstract boolean |
isInitialRender()
Returns true if this request is the first request to render the page.
|
abstract boolean |
isPartialRequest(javax.faces.context.FacesContext context)
Method to indicate if this current HTTP request is a partial page rendering request.
|
abstract boolean |
isPostback()
Returns true if JSF is currently processing a postback request.
|
abstract boolean |
isRightToLeft()
Returns true if the user should be shown output in right-to-left.
|
abstract void |
launchDialog(javax.faces.component.UIViewRoot dialogRoot, Map dialogParameters, javax.faces.component.UIComponent source, boolean useWindow, Map windowProperties)
Launch a dialog, optionally raising it in a new dialog window.
|
abstract void |
partialUpdateNotify(javax.faces.component.UIComponent updated)
Called when any component gets updated.
|
abstract void |
queueTaskForAfterPhase(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, Runnable task)
Queue a task that will be run after a phase.
|
abstract void |
queueTaskForBeforePhase(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, Runnable task)
Queue a task that will be run before a phase.
|
abstract javax.faces.component.UIComponent |
restoreComponent(Object state)
Restores the state of a component.
|
abstract void |
returnFromDialog(Object returnValue, Map returnParameters)
Returns from a dialog raised by a
UIXCommand component, or any component implementing DialogSource , or any direct calls to launchDialog() . |
abstract Object |
saveComponent(javax.faces.component.UIComponent component)
Saves the state of a UIComponent tree into an Object.
|
abstract void |
scrollComponentIntoView(javax.faces.component.UIComponent component, boolean focus)
Scrolls the view to the given component.
|
abstract void |
setFurtherValidationNeeded(boolean validationNeeded)
Used by internal ADF Faces code.
|
public static final String VARIABLE_NAME
public static final String MEDIA_FONT_SIZE
public static final String MEDIA_TYPE
public static final String MEDIA_FEATURE_WIDTH
public static final String MEDIA_FEATURE_HEIGHT
public static final String MEDIA_FEATURE_DEVICE_HEIGHT
public static final String MEDIA_FEATURE_DEVICE_WIDTH
public static final String MEDIA_FEATURE_COLOR
public static final String MEDIA_FEATURE_COLOR_INDEX
public static final String MEDIA_FEATURE_MONOCHROME
public static final String MEDIA_FEATURE_RESOLUTION
public static final String MEDIA_FEATURE_GRID
public static final String MEDIA_FEATURE_SCAN
public static final String MEDIA_FEATURE_ORIENTATION
public static AdfFacesContext getCurrentInstance()
public abstract void queueTaskForAfterPhase(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, Runnable task)
context
- the FacesContextphaseId
- the phase after which it must be run; ANY_PHASE is not supportedtask
- a Runnable that implements the taskpublic abstract void queueTaskForBeforePhase(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, Runnable task)
context
- the FacesContextphaseId
- the phase after which it must be run; ANY_PHASE is not supportedtask
- a Runnable that implements the task@Deprecated public abstract WindowIdProvider getWindowIdProvider()
WindowManagerFactory.getWindowManager(javax.faces.context.ExternalContext)
.@Deprecated public abstract WindowIdProvider getWindowIdProvider(javax.faces.context.ExternalContext externalContext)
WindowManagerFactory.getWindowManager(javax.faces.context.ExternalContext)
.public abstract NewSessionURLProvider getNewSessionURLProvider()
public abstract DataUpdateManager getDataUpdateManager()
public abstract DirtyPageHandler getDirtyPageHandler()
public abstract EndUserMonitoringService getEndUserMonitoringService()
getEndUserMonitoringServices()
instead.public abstract List<EndUserMonitoringService> getEndUserMonitoringServices()
public abstract ExecutionContextProvider getExecutionContextProvider()
public abstract BackingBeanScopeProvider getBackingBeanScopeProvider()
public abstract Map<String,Object> getViewScope()
The viewScope will not be available if there is no FacesContext
public abstract Map<String,Object> getPageFlowScope()
@Deprecated public final Map getProcessScope()
public abstract void returnFromDialog(Object returnValue, Map returnParameters)
UIXCommand
component, or any component implementing DialogSource
, or any direct calls to launchDialog()
.returnValue
- the value to be delivered in the the ReturnEventReturnEvent
public abstract DialogService getDialogService()
public abstract void launchDialog(javax.faces.component.UIViewRoot dialogRoot, Map dialogParameters, javax.faces.component.UIComponent source, boolean useWindow, Map windowProperties)
The dialog will receive a new pageFlowScope
map, which includes all the values of the currently available pageFlowScope as well as a set of properties passed to this function in the dialogParameters
map. Changes to this newly created scope will not be visible once the dialog returns.
dialogRoot
- the UIViewRoot for the page being launcheddialogParameters
- a set of parameters to populate the newly created pageFlowScopesource
- the UIComponent that launched the dialog and should receive the ReturnEvent
when the dialog is complete.useWindow
- if true, use a popup window for the dialog if available on the current user agent devicewindowProperties
- the set of UI parameters used to modify the window, if one is used. The set of properties that\ are supported will depend on the RenderKit
, but common examples include "width", "height", "top" and "left".public abstract boolean isPostback()
isPostback()
will return false if this is a request for an initial render of a page (that is, if Apply Request Values never executes), or if during the request the user is navigated to a different page (because of a navigation rule, etc). For example, during a request that results in a navigation to a new page, isPostback()
will return true from Apply Request Values to Invoke Application, then false afterwards; whereas if there was no navigation, it would return true
The value of this method is undefined during (or before) the Restore View phase, but can be used in the afterPhase() method of a PhaseListener for Restore View.
In general, use of this method and its exposed EL variable is discouraged. In practice, callers of this method have attempted to use isPostback
as a proxy for some piece of application state. It is always better to model these cases in terms of the actual application state, as using isPostback
is often neither an exact proxy for the application state, or as the application and view technology change, the validity of the isPostback
proxy can drift from the application state that it is acting as a proxy for.
isInitialRender()
public abstract boolean isInitialRender()
Use of this method (and its exposed EL variable) is discouraged. In practice, callers attempt to use the initial render of a page to represent a state better modeled in the application itself. In other cases, view scoped managed beans with @PostConstruct
annotations might be more appropriate. In general, the only valid use case is as part of a minimal effort (but probably still incorrect) migration from uses of isPostback
in 10.1.3 code to isInitialRender
in version 11 code.
isPostback()
public abstract boolean isPartialRequest(javax.faces.context.FacesContext context)
context
- the FacesContext
object for the request we are processingpublic abstract boolean isFurtherValidationNeeded()
public abstract void setFurtherValidationNeeded(boolean validationNeeded)
public abstract boolean isDebugOutput()
public abstract boolean isClientValidationDisabled()
public String getOutputMode()
public AdfFacesContext.OutputMode getOutputModeEnum()
public abstract String getSkinFamily()
public abstract String getAccessibilityMode()
public abstract boolean isRightToLeft()
public abstract char getNumberGroupingSeparator()
public abstract char getDecimalSeparator()
public abstract String getCurrencyCode()
public abstract int getTwoDigitYearStart()
1950
This is used by @link{oracle.adf.faces.view.converter.DateTimeConverter} while converting strings to Date object.@Deprecated public String getOracleHelpServletUrl()
HelpProvider
framework.public abstract HelpProvider getHelpProvider()
adf-settings.xml example
@Deprecated public Map getHelpTopic()
HelpProvider
framework.@Deprecated public Map getHelpSystem()
HelpProvider
framework.public abstract TimeZone getTimeZone()
@Deprecated public ChangeManager getChangeManager()
public abstract org.apache.myfaces.trinidad.change.ChangeManager getPersistentChangeManager()
@Deprecated public abstract ApplicationContextManager getApplicationContextManager()
RequestContext.getComponentContextManager()
instead of this method.UIComponent.invokeOnComponent(FacesContext,String,ContextCallback)
is called recursively, or in response to in-context event delivery. Any component or application artifact that modifies the application context (by for example setting request attributes or modifying a custom ELResolver) must use the ApplicationContextManager to register their changes to the application context during non-component traversals. For UIComponents, this is modifications that the components make during invokeOnComponent() and during in-context event delivery.ApplicationContextManager
, ComponentContextManager
public PageFlowScopeProvider getPageFlowScopeProvider()
public PageResolver getPageResolver()
public RegionManager getRegionManager()
public abstract void addPartialTarget(javax.faces.component.UIComponent newTarget)
public abstract void addPartialTriggerListeners(javax.faces.component.UIComponent listener, String[] trigger)
public abstract void partialUpdateNotify(javax.faces.component.UIComponent updated)
public abstract void scrollComponentIntoView(javax.faces.component.UIComponent component, boolean focus)
component
- to scroll to in the view. This component must be in a valid context or the scrolling will fail.focus
- true
if the component scrolled to has focus as wellpublic abstract List<Color> getColorPalette(String name)
public abstract Map getFormatter()
public Agent getAgent()
public abstract Object saveComponent(javax.faces.component.UIComponent component)
component
- the componentpublic abstract javax.faces.component.UIComponent restoreComponent(Object state) throws ClassNotFoundException, InstantiationException, IllegalAccessException
state
- an Object created by a prior call to saveComponent().ClassNotFoundException
InstantiationException
IllegalAccessException
public abstract UriManager getUriManager()
public abstract Page getCurrentPage()
public abstract String getViewDeclarationLanguageId()
public abstract UnassociatedPage createPage()
UnassociatedPage.encodeURL(String url)
public AdfFacesContext.PayloadType getPostbackPayloadType()