|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1) E10653-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractMap
oracle.jbo.common.JboAbstractMap
oracle.adf.model.binding.DCExecutableBinding
oracle.adf.model.binding.DCBindingContainer
public class DCBindingContainer
Corresponds to a Swing JFrame or a JSP Page instance and manages bindings used in a frame. The DCBindingContainer class provides:
The binding container properties are accessed via SPEL. Any of the getter methods can be invoked via expressions. The expression language can also traverse any of the collection exposed by this object.
The binding container provides access to all the contained bindings. It implements the map interface which makes it convenient for using SPEL to locate the children of the binding container. A common usage in JSP pages is to access the binding container within the page's context via the bindings variable. Somce sample expressions using JSTL are as follows:
//output the binding container's name
<c:out value="${bindings.name" />
// print out the editing mode string
<c:out value="${bindings.editingMode" />
// print out the input value of a control binding called 'deptno'
<c:out value="${bindings.deptno.inputValue" />
JUPanelBinding
Nested Class Summary | |
---|---|
protected static class |
DCBindingContainer.CalculatedViewable
*** For internal framework use only *** |
static class |
DCBindingContainer.EnumRefreshType
Advanced for internal framework use only |
static class |
DCBindingContainer.ValidationLevel
|
Nested classes/interfaces inherited from class java.util.AbstractMap |
---|
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V> |
Nested classes/interfaces inherited from interface java.util.Map |
---|
java.util.Map.Entry<K,V> |
Field Summary | |
---|---|
static java.lang.String |
DC_BINDINGCONTAINER_ERROR
|
static java.lang.String |
DC_IGNORE_ERROR
|
protected java.util.ArrayList |
mControlList
|
protected DCDataControl |
mDataControl
|
protected ApplicationModule |
mDataProvider
|
protected boolean |
mIsBeingPersonalized
|
protected java.util.ArrayList |
mIterBindingList
|
protected java.util.ArrayList |
mParamsList
|
Fields inherited from class oracle.adf.model.binding.DCExecutableBinding |
---|
mInternalGet_KeyResolved |
Fields inherited from class oracle.jbo.common.JboAbstractMap |
---|
MAP_NULL_VALUE |
Fields inherited from interface oracle.adf.model.RegionBinding |
---|
EXECUTE_MODEL, PREPARE_MODEL, REFRESH_UNKNOWN, RENDER_MODEL, TYPE_EXECUTABLE_REGION |
Fields inherited from interface oracle.adf.model.binding.DCIExecutable |
---|
EXECUTABLE_ACTION, EXECUTABLE_ITERATORBINDING, EXECUTABLE_REGION |
Constructor Summary | |
---|---|
|
DCBindingContainer()
Default constructor. |
protected |
DCBindingContainer(java.lang.Object panel)
Constructor used by DCPanelBinding, which passes in a reference to the JPanel object. |
Method Summary | |
---|---|
protected java.util.List |
_internal_dbg_debug_data()
framework use only |
void |
addBindingContainerChangeListenerForCtxEvent(DCBindingContainerChangeListener modList)
Adds the given listener to this binding container's change listeners list id modListenerForEvents is null. |
void |
addChangeListener(DCBindingContainerChangeListener l)
Adds the given listener to this binding container's change listeners list. |
void |
addControlBinding(DCControlBinding control)
*** For internal framework use only *** Adds a controlbinding object to this container. |
void |
addControlBinding(java.lang.String name,
DCControlBinding control)
*** For internal framework use only *** |
void |
addExecutableBinding(java.lang.Object ctr)
Adds the given Nested BindingContainer usage into this bindingContainer. |
void |
addExecutableBinding(java.lang.String name,
java.lang.Object execObj)
Adds this ExecutableBinding into this container with the given name. |
void |
addIteratorBinding(DCIteratorBinding iterBinding)
Adds the given iterator binding name with a framework generated name. |
void |
addIteratorBinding(java.lang.String name,
DCIteratorBinding iterBinding)
Adds this iterator binding with this form with the given name. |
void |
addNestedBindingContainer(DCBindingContainer ctr)
|
void |
addRegionListener(RegionListener l)
Adds the given listener to this binding container's validation listeners list. |
void |
addStatusBarInterface(DCStatusBarInterface statusBar)
Helper method to add the given object to the JUApplication's StatusBars. |
void |
addValidationListener(DCBindingContainerValidationListener l)
Adds the given listener to this binding container's validation listeners list. |
void |
afterSetAttribute(DCBindingContainerValueChangeEvent ev)
|
boolean |
aliasExists(java.lang.String key)
*** For internal framework use only *** Returns true if this nested bindingContainer usage has an alias defined for paramter with the given key as it's id/name. |
void |
beforeCurrencyChange(DCBindingContainerValidationEvent ev)
Notifies all JUPanelValidationListeners with the beforeCurrencyChange event. |
void |
beforeSaveTransaction(DCBindingContainerValidationEvent ev)
Notifies all JUPanelValidationListeners with the beforeSaveTransaction event. |
void |
beforeSetAttribute(DCBindingContainerValidationEvent ev)
Notifies all DCBindingContainerValidationListeners with the beforeSetAttribute event. |
BindingContext |
bindingContext()
|
void |
cacheException(JboException ex)
|
void |
callAfterRowNavigated(DCControlBinding ctrl,
DCIteratorBinding iter)
|
void |
callAfterSetAttribute(DCControlBinding ctrl,
Row row,
AttributeDef attrDef,
java.lang.Object value)
|
void |
callBeforeRowNavigated(DCIteratorBinding iter)
Forces the current control to stop its editing mode (if used, like in JTable). |
void |
callBeforeSaveTransaction(DCDataControl dc)
Forces the current control to stop its editing mode (if used, like in JTable). |
java.lang.Object |
callBeforeSetAttribute(DCControlBinding ctrl,
Row row,
AttributeDef ad,
java.lang.Object value)
Invoked before any control binding performs a setAttribute call on a BC4J row. |
protected void |
clearExecutableBindings()
*** For internal framework use only *** Clean all nested ExecutableBindings registered with this container. |
protected void |
clearIteratorBindings()
*** For internal framework use only *** Clean all iterator bindings registered with this form. |
protected EventDispatcher |
createEventDispatcherInstance()
createEventDispatcherInstance Returns a new EventDispatcher instance if it doesnt exixts |
protected DCIteratorBinding |
createIteratorBinding(java.lang.String voInstanceName,
java.lang.String voIterName,
java.lang.String voIterBindingName,
int rangeSize)
|
void |
displayStatus(DCIteratorBinding iterBinding,
java.lang.String msgId,
java.lang.Object[] params)
Helper method to display the given message and params via the JUApplication's displayStatus method. |
void |
displayStatus(java.lang.String msg)
Helper method to display the given message string via the JUApplication's displayStatus method. |
void |
endRequest()
Advanced for internal framework use only public for test purposes only. |
VariableValueManager |
ensureVariableManager()
Returns this object's Variable Value Manager. |
java.lang.Object |
evaluateParameter(java.lang.String expr,
boolean bCtx)
*** For internal framework use only *** Return the Expression String that will be used to evaluate the value of a parameter. |
void |
execute()
Execute the query behind each iterator binding that is contained in this form binding. |
void |
executeIfNeeded()
Excecute the query for each iterator binding, if not already executed. |
DCControlBinding |
findCtrlBinding(java.lang.String name)
Returns a control binding with the given name. |
DCDataControl |
findDataControl(java.lang.String alias)
|
java.lang.Object |
findExecutableBinding(java.lang.String name)
Returns the nested BindingContainer usage/instance of the given name. |
DCIteratorBinding |
findIteratorBinding(java.lang.String name)
Returns the iterator binding object of the given name. |
java.lang.Object |
findNamedObject(java.lang.String expr)
*** For internal framework use only *** |
DCParameter |
findParameter(java.lang.String name)
Given the name, find a parameter (DCParameter) type object in this binding container of the same name. |
RegionBinding |
findRegionBinding(java.lang.String name)
|
void |
finishedProcessingPiggyback(java.lang.Exception[] exArr)
|
protected void |
focusGained(DCIteratorBinding iterBinding,
DCControlBinding binding,
int attrIndex)
Invoked by the framework to notify various status bars of which control has gained the focus. |
java.lang.Object |
getActionProcessor()
Returns an instance of java bean that may implement event-handling for actions defined on this RegionBinding. |
java.util.ArrayList |
getAllIterBindingList()
|
java.lang.String |
getAppDefName()
*** For internal framework use only *** |
ApplicationModule |
getApplicationModule()
Deprecated. since 10.1.2. Use IteratorBinding.getDataControl() to get to the ApplicationModule in case of BC4J datacontrols. |
java.util.List |
getAttributeBindings()
Return a list of all Attribute bindings in this RegionBinding. |
BindingContext |
getBindingContext()
Returns the bindingContext to which this bindingContainer belongs. |
java.util.List<DCBindingContainerChangeListener> |
getChangeListeners()
Returns a list of ChangeListeners (returns an empty list if no such listener was registered). |
ControlBinding |
getControlBinding(java.lang.String name)
Returns a control binding with the given name. |
java.util.List |
getControlBindings()
Returns a list containing all control-bindings in this container |
DCControlBinding |
getCtrlBinding(int index)
*** For internal framework use only *** |
DCControlBinding |
getCtrlBinding(java.lang.Object control)
Matches the control with the View-component(getControl) for each of the control bindings in this container. |
java.util.ArrayList |
getCtrlBindingList()
Returns an array containing all control-bindings in this container. |
DCDataControl |
getDataControl()
*** For internal framework use only *** Returns the DCApplciation object to which this form binding belongs. |
DCBindingContainerDef |
getDef()
*** For internal framework use only *** |
java.lang.String |
getEditingMode()
Deprecated. since 10.1.3 use isFindMode to determine the find or data modes for this bindingContainer. |
EventDispatcher |
getEventDispatcher()
getEventDispatcher Returns the EventDispatcher which this bindingContainer has |
EventMapDef |
getEventMapDef()
Internal: Used to get the EventMapDef associated with the pageDef file. |
java.lang.String |
getExceptionDisplayMessage(JboException ex)
Return the display message of a JboException usign the current DCErrorMessageHandler to format the error. |
java.util.ArrayList |
getExceptionsList()
Returns a list of exceptions that has been cached on this bindingContainer. |
protected java.util.ArrayList |
getExceptionsListInternal()
|
java.util.List |
getExecutableBindings()
Return an ordered set of executableBindings. |
oracle.adf.model.binding.DCIExecutableDef |
getExecutableDef()
*** For internal framework use only *** |
int |
getExecutableType()
Returns one of an enumeration of Executable binding types in the framework. |
java.lang.String |
getFullName()
|
DCIteratorBinding |
getIteratorBinding(java.lang.String voInstanceName,
java.lang.String voIterName,
java.lang.String voIterBindingName)
Return an Iterator Binding of the given "voIterBindingName" if one already exists by that name. |
DCIteratorBinding |
getIteratorBinding(java.lang.String voInstanceName,
java.lang.String voIterName,
java.lang.String voIterBindingName,
int rangeSize)
Return an Iterator Binding of the given "voIterBindingName", if one already exists by that name, after setting up the iterator binding's range Size to the greater of existing range size and the given range size. |
java.util.ArrayList |
getIterBindingList()
Return an ordered set of iterator bindings. |
java.util.HashMap |
getIterBindings()
Return the hashmap containing iterator bindings |
LocaleContext |
getLocaleContext()
Returns the locale context set into the BC4J application module if this binding-container's datacontrol is a Bc4J data control. |
java.lang.Class |
getMessageBundleClass()
Advanced for internal framework use only |
OperationBinding |
getOperationBinding(java.lang.String name)
Returns an operation binding with the given name. |
java.util.List |
getOperationBindings()
Return a list of all Action bindings in this RegionBinding. |
protected ViewObject[] |
getOrderedVOUsageList(DCDataControl dc)
Returns an ordered list of ViewObject usages in this panel so that a JboException parameters can be transformed from Entity-layer names and exception parameters to ViewObject names and parameters. |
java.lang.String |
getParameterAlias(java.lang.String key)
*** For internal framework use only *** Return any alias String value if set for a given bindingContainer parameter. |
java.util.List |
getParametersList()
Return a list of parameter (DCParameter type) objects that make up the parameters for this bindingContainer. |
java.util.Map |
getParametersMap()
Return Parameters map. |
DCPermission |
getPermission()
|
PermissionInfo |
getPermissionInfo()
*** For internal framework use only *** |
java.util.List<RegionBinding> |
getRegionBindings()
Return an ordered set of executableBindings. |
DCBindingContainer |
getRegionContainer()
Returns the parent BindingContainer that includes this instance of BindingContainer as a nested BindingContainer. |
RegionController |
getRegionController()
Returns an instance of RegionController that should handle the lifecycle for this RegionBinding. |
java.util.List |
getRegionListeners()
Returns a list of RegionListeners (returns an empty list if no such listener was registered). |
ResourceBundleDef |
getResourceBundleDef()
|
DCBindingContainer |
getRootBindingContainer()
*** For internal framework use only *** |
java.lang.Object |
getState()
In the process of re-creating a binding container. |
java.lang.String |
getStateToken()
Returns the container state. |
java.lang.String |
getStateTokenId()
Returns the container state token. |
int |
getTransientRefreshFlag()
Advanced for internal framework use only |
DCBindingContainer.EnumRefreshType |
getTransientRefreshType()
Advanced for internal framework use only |
DCBindingContainer.ValidationLevel |
getValidationLevel()
|
java.util.ArrayList |
getValidationListeners()
Returns a list of ValidationListeners (returns an empty list if no such listener was registered). |
VariableValueManager |
getVariableManager()
Returns this object's current Variable Value Manager. |
protected VariableManagerOwner |
getVariableManagerOwner()
|
protected DCBindingContainer.CalculatedViewable |
getViewableFlagInternal()
*** For internal framework use only *** |
java.lang.Object |
getViewComponent()
*** For internal framework use only *** Returns the associated JPanel object. |
void |
handleException(java.lang.Exception ex,
boolean lastEntryInPiggyback)
Catches an exception thrown by the middle tier. |
void |
handleWarning(JboWarning warn)
Catches a warning thrown by the middle tier. |
boolean |
hasDefinitionBeenUpdated()
Returns true if the region's definition has been updated |
boolean |
hasExceptions()
|
int |
hashCode()
*** For internal framework use only *** |
boolean |
hasRefreshParametersChanged()
*** For internal framework use only *** |
boolean |
hasVariables()
Returns a flag indicating whether this object has Variables or not. |
boolean |
hasVetoWarning()
Internal: Applications should not use this class. |
void |
ignoreExceptionForDisplay(JboException ex)
The method is used to indicate that error message for the JboException should not be displayed. |
protected void |
initializeApplicationModule()
*** For internal framework use only *** Used to setup reference to DCDataControl and oracle.jbo.Application objects. |
void |
initializeFromDef(BindingContext ctx,
ApplicationModule am)
*** For internal framework use only *** |
protected void |
initializeViewComponent(java.util.ArrayList controls)
*** For internal framework use only *** |
protected java.lang.Object |
internalGet(java.lang.String key)
This method may be overridden by subclasses to implement public spel lookup strings. |
protected DCDataControl |
internalGetDataControl()
*** For internal framework use only *** |
protected void |
internalRefreshControl(int refreshFlag,
boolean executeIfNeeded)
*** For internal framework use only *** |
void |
invokeCustomValidation()
|
boolean |
isAppInPollingDCEMode()
Deprecated. since 11.1.1.2.0 Polling mode information is moved into ADS. |
boolean |
isBeingPersonalized()
|
boolean |
isDCEventsNotStarted()
Advanced for internal framework use only public for test purposes only. |
protected boolean |
isEditingStopped()
Jclient uses this to indicate if stopEdit completed before datacontrol can proceed with update cycle (commit etc). |
boolean |
isErrorHandlerActive()
*** For internal framework use only *** |
boolean |
isExecuteOnRollback()
Returns true if this form binding executes all the ViewObjects it's associated with after rollback is called on the application via DCCtrlActionBinding's rollback action. |
boolean |
isFindMode()
Returns true if this form is in find mode. |
static boolean |
isInRefreshRegion()
|
boolean |
isReleased()
Returns true if this BindingContainer instance has been released. |
boolean |
isReleaseOnEndRequest()
|
boolean |
isSkipValidation()
Returns true if this bindingContainer is marked to skip datacontrol validation. |
boolean |
isTokenValidationEnabled()
Returns true if token validation is enabled for this binding container. |
boolean |
isViewable()
*** For internal framework use only *** |
void |
maybePrintAppDefNameDiagnostic()
|
protected void |
navigated(DCIteratorBinding iter,
NavigationEvent event)
Invoked when a DCIteratorBinding receives a navigated Event from BC4J RowSetIterator |
protected void |
notifyIteratorChanged(DCIteratorBinding iterBnd,
boolean refresh)
Notify each listener of the iteratorChanged event when an iterator changes its data due to execute, re-execute, or change in display mode (find mode or data mode). |
protected void |
prepareRegionForHierNodeIterator(DCIteratorBinding iter)
|
void |
processContextualEvents()
processContextualEvents used to process queued events |
void |
processException(JboException ex)
Matches a control-binding with the exception or one of it's detail exceptions if the exception or one of it's detail excpetions is an AttrValException and the control-binding is bound to that attribute. |
protected java.lang.String |
processFormToken(java.lang.String state)
|
void |
processInputValues(java.util.Map inputValues)
*** For internal framework use only *** |
protected void |
processRegionBindingException(JboException ex)
In Swing, suppress multiple error dialogs. |
void |
putVetoWarning(JboWarning warn)
Internal: Applications should not use this class. |
protected void |
rangeRefreshed(DCIteratorBinding iter,
RangeRefreshEvent event)
Invoked when a DCIteratorBinding receives a rangeRefreshed Event from BC4J RowSetIterator |
protected void |
rangeScrolled(DCIteratorBinding iter,
ScrollEvent event)
Invoked when a DCIteratorBinding receives a rangeScrolled Event from BC4J RowSetIterator |
RegionBinding |
recreateRegionBinding(java.lang.String name)
|
void |
refresh()
Invokes refreshControl. |
void |
refresh(int refreshFlag)
This method synhronizes the rangeSizes from iteratorBindings onto the collection that they are bound to and then executes (if not already executed) the collection sources to get the collection data by calling iterator binding's refreshControl method. |
void |
refreshControl()
Refresh the binding container with control data. |
boolean |
refreshIfNeeded()
*** For internal framework use only *** |
void |
release()
release all view and datacontrol references from this binding-container and all it's containee iterator bindings and control bindings. |
void |
release(int flags)
Applications should release the DataControl which will end up calling this method for all binding containers in the datacontrol. |
void |
removeChangeListener(DCBindingContainerChangeListener l)
Removes the given listener from this binding container's modification listeners list. |
boolean |
removeControlBinding(DCControlBinding control)
*** For internal framework use only *** |
boolean |
removeControlBinding(java.lang.String name)
*** For internal framework use only *** |
boolean |
removeExecutableBinding(java.lang.String name)
If a BindingContainer usage exists with the given name, remove it from the internal members. |
boolean |
removeIteratorBinding(java.lang.String name)
If an iterator binding exists with the given name, remove it from the internal members. |
boolean |
removeParameter(DCParameter control)
*** For internal framework use only *** Remove the parameter object from a binding container |
boolean |
removeParameter(java.lang.String name)
*** For internal framework use only *** |
void |
removeRegionListener(RegionListener l)
Removes the given listener from this binding container's validation listeners list. |
void |
removeStatusBarInterface(DCStatusBarInterface statusBar)
Helper method to remove the given object to the JUApplication's StatusBars. |
void |
removeValidationListener(DCBindingContainerValidationListener l)
Removes the given listener from this binding container's validation listeners list. |
protected void |
removeViewScopeErrorState()
|
void |
reportException(java.lang.Throwable th)
If DCDataControl is setup, then invoke DCDataControl.reportException to report any exceptions. |
protected void |
resetExceptionState()
Advanced for internal framework use only |
void |
resetInputState()
Resets the error state for all control bindings. |
void |
restoreFromState(java.lang.Object stateObject)
Initialize binding instance with value from state object |
protected void |
rowDeleted(DCIteratorBinding iter,
DeleteEvent event)
Invoked when a DCIteratorBinding receives a rowDeleted Event from BC4J RowSetIterator |
protected void |
rowInserted(DCIteratorBinding iter,
InsertEvent event)
Invoked when a DCIteratorBinding receives a rowInserted Event from BC4J RowSetIterator |
protected void |
rowUpdated(DCIteratorBinding iter,
UpdateEvent event)
Invoked when a DCIteratorBinding receives a rowUpdated Event from BC4J RowSetIterator |
protected void |
setAppDefName(java.lang.String appDefName)
*** For internal framework use only *** |
void |
setApplicationModule(ApplicationModule am)
*** For internal framework use only *** Sets the ApplicationModule reference |
protected void |
setBindingContext(BindingContext ctx)
*** For internal framework use only *** |
void |
setDataControl(DCDataControl app)
Sets the DCDataControl instance in this form binding. |
protected void |
setDef(DCBindingContainerDef formDef)
*** For internal framework use only *** |
void |
setEnableTokenValidation(boolean bSet)
Enables or disables token validation. |
void |
setErrorHandlerActive(boolean flag)
Sets the registered handler for exceptions into active/inactive mode. |
void |
setEventDispatcher(EventDispatcher eventDispatcher)
setEventDispatcher sets the EventDispatcher to this bindingContainer |
void |
setEventMapDef(EventMapDef eventMap)
|
void |
setExecuteOnRollback(boolean flag)
Set false if this form binding should not execute all the ViewObjects it's associated with after rollback is called on the application via DCCtrlActionBinding's rollback action. |
void |
setFindMode(boolean mode)
Calls setFindMode(boolean mode, boolean applyCriteria) with applyCriteria = true; |
void |
setFindMode(boolean mode,
boolean applyCriteria)
Sets this form into findMode. |
void |
setIsBeingPersonalized(boolean isBeingPersonalized)
|
void |
setParameterExpression(java.lang.String name,
java.lang.String elExpr)
*** For internal framework use only *** Set the expression string for a given parameter name. |
void |
setParameterValues(java.util.Map paramValueMap)
*** For internal framework use only *** Allows setting values for this page's parameters. |
void |
setRegionController(RegionController controller)
|
void |
setReleaseOnEndRequest(boolean release)
Advanced for internal framework use only Used by ADS to inform the BindingCOntainer to stay around on release so that events can be channeled through the bindings. |
void |
setSkipValidation(boolean flag)
Advanced for internal framework use only Turns off BindingContainer's validation. |
void |
setValidationLevel(DCBindingContainer.ValidationLevel level)
|
void |
setViewable(boolean flag)
Internal...used by components/subclasses that want to make this bindingContainer not viewable based on their conditions. |
protected void |
setViewableFlagInternal(DCBindingContainer.CalculatedViewable viewable)
*** For internal framework use only *** |
protected void |
setViewComponentInternal(java.lang.Object panel)
*** For internal framework use only *** Sets internal member variable with the given panel instance. |
int |
startDCEvents(DCIteratorBinding iter,
int from)
Advanced for internal framework use only public for test purposes only. |
void |
stopDCEvents(DCIteratorBinding iter)
Advanced for internal framework use only public for test purposes only. |
java.lang.String |
toString()
|
protected void |
updateName(java.lang.String oldName,
java.lang.String newName)
*** For internal framework use only *** |
boolean |
usesDef(DCBindingContainerDef def)
Internal: Applications should not use this class. |
void |
validate()
Calls DataControl validate() for each data control that has a collection to which an iterator binding in this container or it's containeeds are bound to. |
void |
validateInputValues()
Calls DataControl.validate() for each data control that has a collection to which an iterator binding in this container is bound to. |
void |
validateReferredDataControls()
|
void |
validateToken(java.lang.String sState)
validates that this container is in the same state as represented by the given string token |
Methods inherited from class oracle.adf.model.binding.DCExecutableBinding |
---|
addDependentExecutable, get, getBindingContainer, getDependents, getName, getPermissionTargetName, getRefreshExpression, getRefreshOption, isRefreshable, isRefreshed, removeDependentExecutable, resetDependentsRefresh, setBindingContainer, setExecutableDef, setName, setRefreshed, setRefreshExpression, setRefreshOption |
Methods inherited from class oracle.jbo.common.JboAbstractMap |
---|
entrySet, equals, internalPut, put, setThrowIfPropertyNotFoundOnGet |
Methods inherited from class java.util.AbstractMap |
---|
clear, clone, containsKey, containsValue, isEmpty, keySet, putAll, remove, size, values |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.binding.BindingContainer |
---|
getName |
Methods inherited from interface java.util.Map |
---|
clear, containsKey, containsValue, entrySet, equals, get, isEmpty, keySet, put, putAll, remove, size, values |
Methods inherited from interface oracle.jbo.VariableManagerOwner |
---|
getName |
Field Detail |
---|
public static final java.lang.String DC_BINDINGCONTAINER_ERROR
public static final java.lang.String DC_IGNORE_ERROR
protected DCDataControl mDataControl
protected java.util.ArrayList mParamsList
protected java.util.ArrayList mIterBindingList
protected java.util.ArrayList mControlList
protected ApplicationModule mDataProvider
protected boolean mIsBeingPersonalized
Constructor Detail |
---|
public DCBindingContainer()
protected DCBindingContainer(java.lang.Object panel)
Method Detail |
---|
protected void updateName(java.lang.String oldName, java.lang.String newName)
DCExecutableBinding
updateName
in class DCExecutableBinding
public static boolean isInRefreshRegion()
public boolean isTokenValidationEnabled()
isTokenValidationEnabled
in interface BindingContainer
public void setEnableTokenValidation(boolean bSet)
public EventMapDef getEventMapDef()
public void setEventMapDef(EventMapDef eventMap)
public void reportException(java.lang.Throwable th)
This method converts all exceptions to a JboException.
protected void setBindingContext(BindingContext ctx)
public java.lang.String getAppDefName()
protected void setAppDefName(java.lang.String appDefName)
appDefName
- the full name of the application definition that created this containerpublic final BindingContext bindingContext()
public BindingContext getBindingContext()
public void setDataControl(DCDataControl app)
InvalidOperException
public final DCBindingContainerDef getDef()
protected void setDef(DCBindingContainerDef formDef)
public void addBindingContainerChangeListenerForCtxEvent(DCBindingContainerChangeListener modList)
public void initializeFromDef(BindingContext ctx, ApplicationModule am)
public final java.lang.Object getViewComponent()
protected void setViewComponentInternal(java.lang.Object panel)
public final ApplicationModule getApplicationModule()
To get a BC4J AM in all cases use the IteratorBinding that iterates over a Bc4J collection and get it's DataControl to get to the corresonding ApplicationModule.
public void setApplicationModule(ApplicationModule am)
public final DCBindingContainer getRegionContainer()
public final java.util.List<RegionBinding> getRegionBindings()
getRegionBindings
in interface RegionBinding
public final java.util.List getExecutableBindings()
public final RegionBinding findRegionBinding(java.lang.String name)
public final RegionBinding recreateRegionBinding(java.lang.String name)
name
-
public final boolean usesDef(DCBindingContainerDef def)
public final java.lang.Object findExecutableBinding(java.lang.String name)
public void addNestedBindingContainer(DCBindingContainer ctr)
ctr
- public final void addExecutableBinding(java.lang.Object ctr)
public final void addExecutableBinding(java.lang.String name, java.lang.Object execObj)
InvalidObjNameException
- if an invalid name is passed in.
NameClashException
- if given a duplicate name.protected void prepareRegionForHierNodeIterator(DCIteratorBinding iter)
public final boolean removeExecutableBinding(java.lang.String name)
protected final void clearExecutableBindings()
public final java.util.HashMap getIterBindings()
public final java.util.ArrayList getIterBindingList()
public final java.util.ArrayList getAllIterBindingList()
public final DCIteratorBinding findIteratorBinding(java.lang.String name)
public final void addIteratorBinding(DCIteratorBinding iterBinding)
public final void addIteratorBinding(java.lang.String name, DCIteratorBinding iterBinding)
InvalidObjNameException
- if an invalid name is passed in.
NameClashException
- if given a duplicate name.public final boolean removeIteratorBinding(java.lang.String name)
protected final void clearIteratorBindings()
public final void addControlBinding(DCControlBinding control)
InvalidObjNameException
- if control's name is of unsupported format
NameClashException
- if an object exists with this control-binding's name.public final void addControlBinding(java.lang.String name, DCControlBinding control)
public final java.util.List getControlBindings()
getControlBindings
in interface BindingContainer
public final java.util.ArrayList getCtrlBindingList()
public java.util.List getAttributeBindings()
getAttributeBindings
in interface BindingContainer
public java.util.List getOperationBindings()
getOperationBindings
in interface BindingContainer
public final java.util.List getParametersList()
public final java.util.Map getParametersMap()
public final DCParameter findParameter(java.lang.String name)
public final DCControlBinding getCtrlBinding(int index)
public final DCControlBinding findCtrlBinding(java.lang.String name)
public final ControlBinding getControlBinding(java.lang.String name)
BindingContainer
getControlBinding
in interface BindingContainer
public final OperationBinding getOperationBinding(java.lang.String name)
BindingContainer
getOperationBinding
in interface BindingContainer
public final java.lang.Object evaluateParameter(java.lang.String expr, boolean bCtx)
public final void setParameterExpression(java.lang.String name, java.lang.String elExpr)
public final void setParameterValues(java.util.Map paramValueMap)
This method is primarily called on top-level BindingContainers to pass in the page/bindingContainer level parameters.
public final DCDataControl findDataControl(java.lang.String alias)
public java.lang.String getParameterAlias(java.lang.String key)
public boolean aliasExists(java.lang.String key)
public DCBindingContainer getRootBindingContainer()
public final DCControlBinding getCtrlBinding(java.lang.Object control)
public final boolean removeParameter(DCParameter control)
public final boolean removeControlBinding(DCControlBinding control)
public final boolean removeControlBinding(java.lang.String name)
public final boolean removeParameter(java.lang.String name)
public final boolean isAppInPollingDCEMode()
public void execute()
public void executeIfNeeded()
public DCIteratorBinding getIteratorBinding(java.lang.String voInstanceName, java.lang.String voIterName, java.lang.String voIterBindingName)
Various control bindings that display just one row's attribute invoke this method to find or create the iterator binding for which they display an attribute data.
public DCIteratorBinding getIteratorBinding(java.lang.String voInstanceName, java.lang.String voIterName, java.lang.String voIterBindingName, int rangeSize)
If not, create an IteratorBinding object that references a default iterator of the ViewObject instance named voInstanceName (and optionally the iterator named voIterName). Return this created iterator binding after adding it to internal lists.
Various control bindings that are capable of displaying more than one row of data invoke this method to create their iterator binding with a preferred range size.
protected DCIteratorBinding createIteratorBinding(java.lang.String voInstanceName, java.lang.String voIterName, java.lang.String voIterBindingName, int rangeSize)
public void setFindMode(boolean mode)
public void setFindMode(boolean mode, boolean applyCriteria)
Also, notify each iteratorChanged listener registered with this form of the change in the iterator (due to change in mode so that they update the displays with the find or data mode's data).
public boolean isFindMode()
public java.lang.String getEditingMode()
public void addStatusBarInterface(DCStatusBarInterface statusBar)
public void removeStatusBarInterface(DCStatusBarInterface statusBar)
public void displayStatus(DCIteratorBinding iterBinding, java.lang.String msgId, java.lang.Object[] params)
public void displayStatus(java.lang.String msg)
public LocaleContext getLocaleContext()
public boolean isExecuteOnRollback()
public void setExecuteOnRollback(boolean flag)
public void release()
release
in interface BindingContainer
protected void removeViewScopeErrorState()
public void release(int flags)
release
in interface DCIExecutable
release
in interface RegionBinding
release
in class DCExecutableBinding
flags
- could be one of the enumerations in DCDataControl. See DCDataControl.release()public boolean isReleased()
protected void initializeViewComponent(java.util.ArrayList controls)
protected void initializeApplicationModule()
protected void focusGained(DCIteratorBinding iterBinding, DCControlBinding binding, int attrIndex)
protected void notifyIteratorChanged(DCIteratorBinding iterBnd, boolean refresh)
protected void rangeRefreshed(DCIteratorBinding iter, RangeRefreshEvent event)
iter
- that received the rangeRefreshed event.event
- a description of the new ranges.protected void rangeScrolled(DCIteratorBinding iter, ScrollEvent event)
iter
- that received the rangeScrolled event.event
- a description of the new range.protected void rowInserted(DCIteratorBinding iter, InsertEvent event)
iter
- that received the rowInserted event.event
- a description of the new Row object.protected void rowDeleted(DCIteratorBinding iter, DeleteEvent event)
iter
- that received the rowDeleted event.event
- a description of the deleted Row object.protected void rowUpdated(DCIteratorBinding iter, UpdateEvent event)
iter
- that received the rowUpdated event.event
- a description of the modified Row object.protected void navigated(DCIteratorBinding iter, NavigationEvent event)
iter
- that received the navigated event.event
- a description of the new and previous current rows.public void callAfterSetAttribute(DCControlBinding ctrl, Row row, AttributeDef attrDef, java.lang.Object value)
public void callAfterRowNavigated(DCControlBinding ctrl, DCIteratorBinding iter)
public java.lang.Object callBeforeSetAttribute(DCControlBinding ctrl, Row row, AttributeDef ad, java.lang.Object value)
protected boolean isEditingStopped()
public void callBeforeRowNavigated(DCIteratorBinding iter)
public void callBeforeSaveTransaction(DCDataControl dc)
public void afterSetAttribute(DCBindingContainerValueChangeEvent ev)
public void beforeSetAttribute(DCBindingContainerValidationEvent ev)
public void beforeCurrencyChange(DCBindingContainerValidationEvent ev)
public void beforeSaveTransaction(DCBindingContainerValidationEvent ev)
protected java.lang.Object internalGet(java.lang.String key)
This method first checks for control binding with the given name and returns a control-binding with the matching name. /EmpEdit.do If not, then iterator binding with a matching key/name is returned. If not, then if the following keys are checked:
Properties returned vis getter on this control bindings are:
def
- returns getDef()name
- returns getName()
internalGet
in class DCExecutableBinding
public int hashCode()
hashCode
in interface java.util.Map
hashCode
in class JboAbstractMap
public final void refresh(int refreshFlag)
Method bound iterator bindings expect the methods be already executed or atleast their parameters(if any) be accessible to the Method Action associated with the iterator binding so that the method can be executed successfully to bind to a returned collection.
All consumer layers that have defined page-lifecycle and request/response phase, it is expected that this method gets the right refresh parameter value :
RefreshFlag = EXECUTE_MODEL, implies that this bindingContainer is being executed and all it's executable contents will be 'executed' via a nested refresh(EXECUTE_MODEL) call or for iterator Bindings via an executeQuery call.
RefreshFlag = PREPARE_MODEL, implies that this bindingContainer is being prepared for either render or update at the beginning of a page lifecycle. Only those executables that are marked to be prepared in this phase will be refreshed, if not already refreshed.
RefreshFlag = RENDER_MODEL, implies that this bindingContainer is being asked to refresh any executable that are marked to be prepared in this phase and are not already refreshed. This phase is called just before the lifecycle moves on to render a request.
RefreshFlag is REFRESH_UNKNOWN, implies that the caller does not know which phase of the lifecycle it is in (This phase is primarily for ADFSwing clients and for clients that were developed before ADF PageLifeCycle was established.)
refresh
in interface DCIExecutable
refresh
in interface RegionBinding
public final void refresh()
For controllers/platforms that have established page lifecycle, this method is not expected to be called at all. The consumers should be using refresh(int) passing in the appropriate lifecycle phase into the refresh call.
refresh
in interface BindingContainer
public void refreshControl()
For controllers/platforms that have established page lifecycle, this method is not expected to be called at all. The consumers should be using refresh(int) passing in the appropriate lifecycle phase into the refresh call.
protected void internalRefreshControl(int refreshFlag, boolean executeIfNeeded)
Subclasses may need to override this as a choke point to ready their component bindings before executing/refreshing the bindingContainer.
public boolean refreshIfNeeded()
refreshIfNeeded
in interface DCIExecutable
refreshIfNeeded
in class DCExecutableBinding
protected void resetExceptionState()
public void resetInputState()
public final java.util.List getRegionListeners()
public final void addRegionListener(RegionListener l)
public final void removeRegionListener(RegionListener l)
public void setViewable(boolean flag)
public boolean isViewable()
isViewable
in interface RegionBinding
public final java.util.ArrayList getValidationListeners()
public final java.util.List<DCBindingContainerChangeListener> getChangeListeners()
public final void addValidationListener(DCBindingContainerValidationListener l)
public final void addChangeListener(DCBindingContainerChangeListener l)
public final void removeValidationListener(DCBindingContainerValidationListener l)
public final void removeChangeListener(DCBindingContainerChangeListener l)
public final boolean isSkipValidation()
public final void setSkipValidation(boolean flag)
public int startDCEvents(DCIteratorBinding iter, int from)
public final boolean isDCEventsNotStarted()
public void stopDCEvents(DCIteratorBinding iter)
public void endRequest()
public final void setReleaseOnEndRequest(boolean release)
public final boolean isReleaseOnEndRequest()
public void invokeCustomValidation()
public final void validate()
BindingContainer
validate
in interface BindingContainer
public void validateInputValues()
public void validateReferredDataControls()
public PermissionInfo getPermissionInfo()
getPermissionInfo
in class DCExecutableBinding
public void setValidationLevel(DCBindingContainer.ValidationLevel level)
public DCBindingContainer.ValidationLevel getValidationLevel()
public void processInputValues(java.util.Map inputValues)
public java.lang.String toString()
toString
in class java.util.AbstractMap
protected void processRegionBindingException(JboException ex)
public void processException(JboException ex)
If the bindingContext is in JClient mode, then this exception is thrown, otherwise the exception is cached at the panelBinding level for the controller to get/access during the page-rendering phase or before invoking the next action.
public boolean hasExceptions()
public java.util.ArrayList getExceptionsList()
protected java.util.ArrayList getExceptionsListInternal()
public void cacheException(JboException ex)
public void handleException(java.lang.Exception ex, boolean lastEntryInPiggyback)
JboExceptionHandler
handleException
in interface JboExceptionHandler
ex
- an exception.lastEntryInPiggyback
- true
if ex
is the
last of a batch of exceptions and warnings generated by a transaction.public void handleWarning(JboWarning warn)
JboExceptionHandler
handleWarning
in interface JboExceptionHandler
warn
- a warning message.public void finishedProcessingPiggyback(java.lang.Exception[] exArr)
finishedProcessingPiggyback
in interface JboExceptionHandler
public boolean isErrorHandlerActive()
public void setErrorHandlerActive(boolean flag)
public void ignoreExceptionForDisplay(JboException ex)
ex
- the JboException that should not be displayed.public java.lang.String getExceptionDisplayMessage(JboException ex)
ex
- The JboException from which the message will be built.
protected ViewObject[] getOrderedVOUsageList(DCDataControl dc)
public java.lang.String getStateTokenId()
public java.lang.String getStateToken()
getStateToken
in interface BindingContainer
public void validateToken(java.lang.String sState)
validateToken
in interface BindingContainer
sState
- State that this RegionBinding should be in.public DCDataControl getDataControl()
protected DCDataControl internalGetDataControl()
public java.lang.Object findNamedObject(java.lang.String expr)
public final int getExecutableType()
RegionBinding
int value of 0 is reserved for RegionBinding or BindingContainer type.
getExecutableType
in interface DCIExecutable
getExecutableType
in interface RegionBinding
getExecutableType
in class DCExecutableBinding
public final java.lang.String getFullName()
public RegionController getRegionController()
RegionBinding
By default this will return null. For Regions that have an overridden RegionController defined in the Region definition this will return an instance of the RegionController implementation.
This RegionBinding controller is invoked when this RegionBinding needs to refresh or validate it's contained RegionBindings.
getRegionController
in interface RegionBinding
public void setRegionController(RegionController controller)
public java.lang.Object getActionProcessor()
RegionBinding
A controller should delegate to this event processor for handling action events for those actions that have a corresponding method. Otherwise controller should invoke the ActionBinding directly.
getActionProcessor
in interface RegionBinding
public final boolean hasRefreshParametersChanged()
DCExecutableBinding
hasRefreshParametersChanged
in interface DCIExecutable
hasRefreshParametersChanged
in class DCExecutableBinding
public oracle.adf.model.binding.DCIExecutableDef getExecutableDef()
DCExecutableBinding
getExecutableDef
in interface DCIExecutable
getExecutableDef
in class DCExecutableBinding
public final boolean hasVariables()
VariableManagerOwnerBase
hasVariables
in interface VariableManagerOwnerBase
public final VariableValueManager getVariableManager()
VariableManagerOwnerBase
null
if Variable Value Manager has
been initialized.
When a framework object is first created, its Variable Value Manager may be null. This method does not initialize (create) the Variable Value Manager.
in contrast, ensures
that the Variable Value Manager is initialized (created).
VariableManagerOwnerBase.ensureVariableManager()
getVariableManager
in interface VariableManagerOwnerBase
null
if one was not yet initialized.protected VariableManagerOwner getVariableManagerOwner()
public VariableValueManager ensureVariableManager()
VariableManagerOwnerBase
ensureVariableManager
in interface VariableManagerOwnerBase
public final java.lang.Class getMessageBundleClass()
getMessageBundleClass
in interface VariableManagerOwnerBase
public final ResourceBundleDef getResourceBundleDef()
getResourceBundleDef
in interface VariableManagerOwnerBase
public final DCBindingContainer.EnumRefreshType getTransientRefreshType()
public final int getTransientRefreshFlag()
protected java.lang.String processFormToken(java.lang.String state)
protected EventDispatcher createEventDispatcherInstance()
public EventDispatcher getEventDispatcher()
public void setEventDispatcher(EventDispatcher eventDispatcher)
eventDispatcher
- EventDispatcherpublic DCPermission getPermission()
protected void setViewableFlagInternal(DCBindingContainer.CalculatedViewable viewable)
protected DCBindingContainer.CalculatedViewable getViewableFlagInternal()
public final void setIsBeingPersonalized(boolean isBeingPersonalized)
public final boolean isBeingPersonalized()
public boolean hasDefinitionBeenUpdated()
MutableRegionBinding
hasDefinitionBeenUpdated
in interface MutableRegionBinding
public void putVetoWarning(JboWarning warn)
public boolean hasVetoWarning()
public void maybePrintAppDefNameDiagnostic()
public void processContextualEvents()
protected java.util.List _internal_dbg_debug_data()
public java.lang.Object getState()
public void restoreFromState(java.lang.Object stateObject)
stateObject
-
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1) E10653-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |