Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.2.0)
E17488-03


oracle.adf.view.rich.component.fragment
Class RegionSite

java.lang.Object
  extended by oracle.adf.view.rich.component.fragment.RegionSite


public abstract class RegionSite
extends java.lang.Object

Provides site context for the RegionModel to communicate with the region component. The RegionSite is implemented by the region component and is passed to the RegionModel through its processBeginRegion() method. The RegionSite is only valid between RegionModel.processBeginRegion() and RegionModel.processEndRegion()

See Also:
RegionModel.processBeginRegion(FacesContext, RegionSite), RegionModel.processEndRegion(FacesContext, RegionSite)

Constructor Summary
RegionSite()
           

 

Method Summary
abstract  void queueParentOutcome(javax.faces.context.FacesContext context, java.lang.String outcome)
          Queues an outcome on the parent region (or the enclosing view).
abstract  void queueRootOutcome(javax.faces.context.FacesContext context, java.lang.String outcome)
          Queues an outcome on the root page of this region For the top-level regions, thsi method does exactly what queueParentOutcome would do.
abstract  void regionComplete(java.util.Map<java.lang.String,java.lang.Object> returnValueMap)
          Used by RegionModel implementations to notify the view layer of its completion.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

RegionSite

public RegionSite()

Method Detail

queueParentOutcome

public abstract void queueParentOutcome(javax.faces.context.FacesContext context,
                                        java.lang.String outcome)
Queues an outcome on the parent region (or the enclosing view).
Parameters:
context - FacesContext instance
outcome - a String outcome that is used to navigate the enclosing view's task flow (for the current region).
Throws:
java.lang.IllegalStateException - if called outside of RegionModel.beginRegion()/endRegion()

queueRootOutcome

public abstract void queueRootOutcome(javax.faces.context.FacesContext context,
                                      java.lang.String outcome)
Queues an outcome on the root page of this region For the top-level regions, thsi method does exactly what queueParentOutcome would do. However, for regions that are contained within other regions, it guarantees that navigation will always happen on a root page.
Parameters:
context - FacesContext instance
outcome - a String outcome that is used to navigate the root page
Throws:
java.lang.IllegalStateException - if called outside of RegionModel.beginRegion()/endRegion()

regionComplete

public abstract void regionComplete(java.util.Map<java.lang.String,java.lang.Object> returnValueMap)
Used by RegionModel implementations to notify the view layer of its completion.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.2.0)
E17488-03


Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.