Oracle ADF Model and Business Components API Reference 10.1.2 B14022-01

oracle.jbo.uicli.binding
Class JUCtrlActionBinding

java.lang.Object
  extended byjava.util.AbstractMap
      extended byoracle.jbo.common.JboAbstractMap
          extended byoracle.adf.model.binding.DCControlBinding
              extended byoracle.jbo.uicli.binding.JUControlBinding
                  extended byoracle.jbo.uicli.binding.JUCtrlActionBinding
All Implemented Interfaces:
java.util.Map
Direct Known Subclasses:
JUActionBinding

public class JUCtrlActionBinding
extends JUControlBinding

Implements actions on BC4J RowIterator to which this control is bound. This class supports the following actions:

If a button is bound to this binding class, then, on button press, the action event on the button binding should call invoke() method on this object to perform the desired action.


Nested Class Summary
 
Nested classes inherited from class java.util.Map
java.util.Map.Entry
 
Field Summary
static int ACTION_BINDING_CONTAINER_EXECUTE
           
static int ACTION_BINDING_CONTAINER_FIND
           
static int ACTION_COMMIT_TRANSACTION
           
static int ACTION_CREATE_INSERT_ROW
           
static int ACTION_CREATE_ROW
           
static int ACTION_EXECUTE
           
static int ACTION_FIND
           
static int ACTION_FIRST
           
static int ACTION_INVOKE_METHOD
           
static int ACTION_ITERATOR_BINDING_EXECUTE
           
static int ACTION_ITERATOR_BINDING_FIND
           
static int ACTION_LAST
           
static int ACTION_NEXT
           
static int ACTION_NEXT_SET
           
static int ACTION_PREVIOUS
           
static int ACTION_PREVIOUS_SET
           
static int ACTION_REMOVE_CURRENT_ROW
           
static int ACTION_RESET
           
static int ACTION_RESET_STATE
           
static int ACTION_ROLLBACK_TRANSACTION
           
 
Fields inherited from class oracle.adf.model.binding.DCControlBinding
ATTR_CURRENTROW, ATTR_DEF, ATTR_ERROR, ATTR_ERRORS, ATTR_FULLNAME, ATTR_ITER, ATTR_NAME, mInternalGet_KeyResolved, ROW_KEY_STR
 
Constructor Summary
JUCtrlActionBinding(java.lang.Object control, DCBindingContainer form, DCInvokeMethodDef methodInfo)
           
JUCtrlActionBinding(java.lang.Object control, DCDataControl dc, int action)
          Creates an ActionBinding instance that works with the given control and on control's ActionEvent, call the invoke() method.
JUCtrlActionBinding(java.lang.Object control, DCIteratorBinding iterBinding, int action)
          Creates an ActionBinding instance that works with the given control and on control's ActionEvent, call the invoke() method.
 
Method Summary
static java.lang.String actionIdToName(int id)
          *** For internal framework use only ***
static int actionNameToId(java.lang.String actionName)
          *** For internal framework use only ***
 void addControlToPanel(java.lang.Object panel, java.lang.Object layoutObject, java.lang.Object layoutCons)
          *** For internal framework use only ***
 void doIt()
          Performs the action that this binding is selected to perform.
 int getActionId()
          Returns Action Id for this Action binding.
 DCDataControl getDataControl()
          Returns the datacontrol that this action or it's iteratorBinding is associated with.
 java.lang.String getEnabledString()
           
 JboException getError()
          Primarily for spel support.
 DCInvokeMethodDef getInvokeMethodDef()
          *** For internal framework use only *** Used for testing purposes only.
 java.util.ArrayList getParams()
          Returns an ordered list of parameter expressions that will be passed to the bound method on invocation.
 java.util.Map getParamsMap()
          Returns a map of parameter expressions.
 java.lang.String getPath()
          Returns a / separated name to the setInvoke() that could be used in el-expressions to invoke the method bound in this action binding.
 java.lang.Object getResult()
          Returns the return value (if any) from the method that this binding invokes.
 boolean ignoreUpdates()
           
protected  java.lang.Object internalGet(java.lang.String key)
          Subclasses should override this to handle a specific key.
 void invoke()
          Calls doIt() to perform the method action.
 boolean isActionEnabled()
          Returns true if this action should be enabled for a given iterator or datacontrol.
 boolean isArrayIteratorType()
           
 void refreshControl()
          *** For internal framework use only ***
 void reportException(java.lang.Exception ex)
          Report the given exception via the containing BindingContainer object.
protected  void resetInputState()
          Resets any exceptions and client-side values that this binding may hold.
 void setArrayIteratorType()
           
 void setInvoke(java.lang.Object dummy)
           
 void setParams(java.util.ArrayList al)
          Set the ordered list of parameter expressions that should be passed to the bound method on invocation.
 
Methods inherited from class oracle.jbo.uicli.binding.JUControlBinding
getFormBinding, getIteratorBinding, reportException, setFormBinding
 
Methods inherited from class oracle.adf.model.binding.DCControlBinding
addToDCExceptions, executeQuery, executeQueryIfNeeded, get, getAllRowsInRange, getApplicationModule, getBindingContainer, getControl, getControlModel, getCurrentRow, getDCIteratorBinding, getDef, getDefFullName, getDefName, getErrors, getFullName, getLayoutObject, getName, getRowAtRangeIndex, getRowIterator, getTransaction, getViewObject, hashCode, internalSetName, isControlQueriable, needsEstimatedRowCount, processInputException, release, removeFromDCExceptions, resetAttributeExceptionInRow, setBindingContainer, setControl, setName, toString
 
Methods inherited from class oracle.jbo.common.JboAbstractMap
entrySet, equals
 
Methods inherited from class java.util.AbstractMap
clear, clone, containsKey, containsValue, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ACTION_EXECUTE

public static final int ACTION_EXECUTE
See Also:
Constant Field Values

ACTION_FIND

public static final int ACTION_FIND
See Also:
Constant Field Values

ACTION_BINDING_CONTAINER_EXECUTE

public static final int ACTION_BINDING_CONTAINER_EXECUTE
See Also:
Constant Field Values

ACTION_BINDING_CONTAINER_FIND

public static final int ACTION_BINDING_CONTAINER_FIND
See Also:
Constant Field Values

ACTION_ITERATOR_BINDING_EXECUTE

public static final int ACTION_ITERATOR_BINDING_EXECUTE
See Also:
Constant Field Values

ACTION_ITERATOR_BINDING_FIND

public static final int ACTION_ITERATOR_BINDING_FIND
See Also:
Constant Field Values

ACTION_NEXT

public static final int ACTION_NEXT
See Also:
Constant Field Values

ACTION_PREVIOUS

public static final int ACTION_PREVIOUS
See Also:
Constant Field Values

ACTION_FIRST

public static final int ACTION_FIRST
See Also:
Constant Field Values

ACTION_LAST

public static final int ACTION_LAST
See Also:
Constant Field Values

ACTION_NEXT_SET

public static final int ACTION_NEXT_SET
See Also:
Constant Field Values

ACTION_PREVIOUS_SET

public static final int ACTION_PREVIOUS_SET
See Also:
Constant Field Values

ACTION_RESET

public static final int ACTION_RESET
See Also:
Constant Field Values

ACTION_REMOVE_CURRENT_ROW

public static final int ACTION_REMOVE_CURRENT_ROW
See Also:
Constant Field Values

ACTION_CREATE_INSERT_ROW

public static final int ACTION_CREATE_INSERT_ROW
See Also:
Constant Field Values

ACTION_CREATE_ROW

public static final int ACTION_CREATE_ROW
See Also:
Constant Field Values

ACTION_COMMIT_TRANSACTION

public static final int ACTION_COMMIT_TRANSACTION
See Also:
Constant Field Values

ACTION_ROLLBACK_TRANSACTION

public static final int ACTION_ROLLBACK_TRANSACTION
See Also:
Constant Field Values

ACTION_RESET_STATE

public static final int ACTION_RESET_STATE
See Also:
Constant Field Values

ACTION_INVOKE_METHOD

public static final int ACTION_INVOKE_METHOD
See Also:
Constant Field Values
Constructor Detail

JUCtrlActionBinding

public JUCtrlActionBinding(java.lang.Object control,
                           DCBindingContainer form,
                           DCInvokeMethodDef methodInfo)
Parameters:
control - View-layer object that this action binding works with.

JUCtrlActionBinding

public JUCtrlActionBinding(java.lang.Object control,
                           DCIteratorBinding iterBinding,
                           int action)
Creates an ActionBinding instance that works with the given control and on control's ActionEvent, call the invoke() method.

Parameters:
control - The control that this binding works with.
iterBinding - JUIteratorBinding instance that this binding works with.
action - Indicates the selected action from the list of actions this class implements.

JUCtrlActionBinding

public JUCtrlActionBinding(java.lang.Object control,
                           DCDataControl dc,
                           int action)
Creates an ActionBinding instance that works with the given control and on control's ActionEvent, call the invoke() method.

Parameters:
control - The control that this binding works with.
action - Indicates the selected action from the list of actions this class implements.
Method Detail

getEnabledString

public java.lang.String getEnabledString()

isActionEnabled

public boolean isActionEnabled()
Returns true if this action should be enabled for a given iterator or datacontrol.


getDataControl

public final DCDataControl getDataControl()
Returns the datacontrol that this action or it's iteratorBinding is associated with.


actionNameToId

public static int actionNameToId(java.lang.String actionName)
*** For internal framework use only ***


actionIdToName

public static java.lang.String actionIdToName(int id)
*** For internal framework use only ***


invoke

public final void invoke()
Calls doIt() to perform the method action.

Since:
9.0.5.1

doIt

public void doIt()
Performs the action that this binding is selected to perform. This method gets the RowIterator from the associated Iterator binding and then calls an equivalent method on the RowIterator. BC4J runtime then sends appropriate events to various binding objects based on the action to update their display with the latest currency, data, etc.

Here's a list of actions and corresponding method calls on the BC4J side.


setArrayIteratorType

public void setArrayIteratorType()

isArrayIteratorType

public boolean isArrayIteratorType()

refreshControl

public void refreshControl()
*** For internal framework use only ***

Updates the values in a control that is bound using an Iterator already in use. (a valid row iterator) If you do not call this method, your control won't update unless you refresh the Iterator.

Specified by:
refreshControl in class DCControlBinding

ignoreUpdates

public boolean ignoreUpdates()

getActionId

public int getActionId()
Returns Action Id for this Action binding.


addControlToPanel

public void addControlToPanel(java.lang.Object panel,
                              java.lang.Object layoutObject,
                              java.lang.Object layoutCons)
Description copied from class: JUControlBinding
*** For internal framework use only ***

Specified by:
addControlToPanel in class JUControlBinding

getInvokeMethodDef

public DCInvokeMethodDef getInvokeMethodDef()
*** For internal framework use only *** Used for testing purposes only.


setInvoke

public void setInvoke(java.lang.Object dummy)

resetInputState

protected void resetInputState()
Description copied from class: DCControlBinding
Resets any exceptions and client-side values that this binding may hold. This is used by control-bindings to reset their state before refreshing values from the MT.

Specified by:
resetInputState in class DCControlBinding

getError

public JboException getError()
Primarily for spel support. Returns cached exceptions for some bindings.

Returns exception that occured on last setInputValue

Overrides:
getError in class DCControlBinding

getPath

public final java.lang.String getPath()
Returns a / separated name to the setInvoke() that could be used in el-expressions to invoke the method bound in this action binding.


internalGet

protected java.lang.Object internalGet(java.lang.String key)
Subclasses should override this to handle a specific key. If they do find the key valid, they should also set the mInternalGet_KeyResolved to 'true' so that bean-introspection is not done for valid null-value returns from the internalGet() call.

Properties returned vis getter on this control bindings are:

  • params - returns getParams()
  • paramsMap - returns getParamsMap()
  • result - returns getResult()
  • enabled - returns isActionEnabled()
  • path - returns getPath()
  • text - returns getText()
  • Overrides:
    internalGet in class DCControlBinding

    getParamsMap

    public java.util.Map getParamsMap()
    Returns a map of parameter expressions. The key values in this map should be the argument names as stored in the metadata for a given method.


    getResult

    public java.lang.Object getResult()
    Returns the return value (if any) from the method that this binding invokes.


    getParams

    public java.util.ArrayList getParams()
    Returns an ordered list of parameter expressions that will be passed to the bound method on invocation.


    setParams

    public void setParams(java.util.ArrayList al)
    Set the ordered list of parameter expressions that should be passed to the bound method on invocation. Note that this list should contain el-expressions for values to be looked for in the bindingContext.


    reportException

    public void reportException(java.lang.Exception ex)
    Report the given exception via the containing BindingContainer object.

    Overrides:
    reportException in class DCControlBinding

    Oracle ADF Model and Business Components API Reference 10.1.2 B14022-01

     

    Copyright © 1997, 2004, Oracle. All rights reserved.