|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.3.0) E17488-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.adf.view.rich.model.RegionModel
public abstract class RegionModel
Model for the Region component.
Nested Class Summary | |
---|---|
static class |
RegionModel.RegionAction Metadata constants for available actions |
Constructor Summary | |
---|---|
RegionModel() |
Method Summary | |
---|---|
java.util.List<? extends RegionModel.RegionAction> |
getActions() Returns the unmodifiable List of valid RegionActions for the current state of the Region, in display order. |
java.util.Set<java.lang.String> |
getCapabilities() Returns the unmodifiable Set of outcomes for the current state of the RegionModel The list of available capabilities is implementation specific. |
java.util.Set<java.lang.String> |
getRegionComponentClientIds() Retrieves the Set of component client IDs of region components that are associated with this RegionModel. |
abstract java.lang.String |
getViewId(javax.faces.context.FacesContext context) Gets the viewId of the region's content. |
boolean |
isDataDirty() Called during the RenderResponse phase to determine whether the region model contains uncommitted data. |
protected void |
markRegionDirty() If a region component client ID gets associated with this RegionModel instance then this method will mark that component as needing to be redrawn. |
void |
processBeginRegion(javax.faces.context.FacesContext context) Deprecated. |
void |
processBeginRegion(javax.faces.context.FacesContext context, RegionSite regionSite) Called just before rendering the region's content. |
void |
processEndRegion(javax.faces.context.FacesContext context) Deprecated. |
void |
processEndRegion(javax.faces.context.FacesContext context, RegionSite regionSite) Called just after rendering the region's content. |
void |
refresh(javax.faces.context.FacesContext context) Clears out any cached content held by this model. |
void |
release(javax.faces.context.FacesContext context) Called to notify the RegionModel that it will no longer be used and that it may release any resources it is holding. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RegionModel()
Method Detail |
---|
public boolean isDataDirty()
true
if the current RegionModel contains uncommitted data.
@Deprecated
public void processBeginRegion(javax.faces.context.FacesContext context)
context
- the FacesContextjava.lang.IllegalStateException
- if the RegionModel currently has processBeginRegion called on it.processBeginRegion(FacesContext, RegionSite)
public void processBeginRegion(javax.faces.context.FacesContext context, RegionSite regionSite)
context
- the FacesContextregionSite
- the RegionSite, providing access to site-specific information and services. The RegionSite is only valid between processBeginRegion and processEndRegion.java.lang.IllegalStateException
- if the RegionModel currently has processBeginRegion called on it.
@Deprecated
public void processEndRegion(javax.faces.context.FacesContext context)
context
- the FacesContextjava.lang.IllegalStateException
- if the RegionModel does not currently has processBeginRegion called on it.processEndRegion(FacesContext, RegionSite)
public void processEndRegion(javax.faces.context.FacesContext context, RegionSite regionSite)
context
- the FacesContextregionSite
- the RegionSite, providing access to site-specific information and services. The RegionSite is only valid between processBeginRegion and processEndRegion. This instance is identical to the instance passed to RegionModel.processBeginRegion
and is passed here as a convenience to the RegionModel.java.lang.IllegalStateException
- if the RegionModel does not currently have processBeginRegion called on it.processBeginRegion(FacesContext, RegionSite)
public void refresh(javax.faces.context.FacesContext context)
This method should not be called directly. Instead UIXRegion.refresh(javax.faces.context.FacesContext)
may be called.
public void release(javax.faces.context.FacesContext context)
context
- the FacesContext.public java.util.Set<java.lang.String> getCapabilities()
Capabilities are typically used by a region's container component, which paints the chrome around the region; depending on the region's capabilities, the container may show different icons.
This implementation returns an empty Set.
getActions()
public java.util.List<? extends RegionModel.RegionAction> getActions()
getCapabilities
.getCapabilities()
public abstract java.lang.String getViewId(javax.faces.context.FacesContext context)
processBeginRegion(javax.faces.context.FacesContext)
must be called before this method is called.context
- the FacesContextprotected void markRegionDirty()
If a region component client ID gets associated with this RegionModel instance then this method will mark that component as needing to be redrawn.
If the the client ID does not match with any component reachable from the view root of the FacesContext, then it will not be markd for redraw and may be disassociated with this model.
public java.util.Set<java.lang.String> getRegionComponentClientIds()
Retrieves the Set of component client IDs of region components that are associated with this RegionModel.
These client IDs will be used to help mark components as needing to be redrawn if this RegionModel instance is marked as dirty.
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.3.0) E17488-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |