B Oracle ADF Binding Properties

This appendix describes the properties of the ADF bindings that you use can access at runtime in an Oracle ADF application.

Table B-1 shows the properties that you can use in EL expressions to access values of the ADF binding objects at runtime. The properties appear in alphabetical order.

Table B-1 EL Properties of Oracle ADF Bindings

Runtime Property Description Iterator Action Attribute Button List Table Tree

actionEnabled

Use operationEnabled instead.

n/a

yes

n/a

n/a

n/a

n/a

n/a

allRowsInRange

Returns an array of the current set of rows from the associated collection. Calls getAllRowsInRange() on the RowSetIterator object.

yes

n/a

n/a

n/a

n/a

n/a

n/a

attributeDef

Returns the attribute definition for the first attribute with which the binding is associated.

n/a

n/a

yes

yes

yes

n/a

n/a

attributeDefs

Returns the attribute definitions for all the attributes to which the binding is associated.

n/a

n/a

yes

yes

yes

n/a

n/a

attributeValue

Returns an unformatted and typed (appropriate Java type) value in the current row, for the attribute to which the control binding is bound.

n/a

n/a

yes

yes

yes

n/a

n/a

attributeValues

Returns the value of all the attributes to which the binding is associated in an ordered array. Returns an array of unformatted and typed (appropriate Java type) values in the current row for all the attributes to which the control binding is bound.

n/a

n/a

yes

yes

yes

n/a

n/a

bindings

Returns a new binding for each cell or attribute exposed under the rows of a tree node binding.

no

no

no

no

no

no

yes

children

Returns the child nodes of a tree node binding.

n/a

n/a

n/a

n/a

n/a

n/a

yes

currentRow

Returns the current row on an action binding bound to an iterator (for example, built-in navigation actions).

n/a

yes

n/a

n/a

n/a

n/a

n/a

dataControl

Returns the iterator's associated data provider.

yes

n/a

n/a

n/a

n/a

n/a

n/a

displayData

Returns a list of map elements. Each map entry contains the following elements:

  • selected: A boolean true if the current entry should be selected.

  • index: The index value of the current entry.

  • prompt: A string value that may be used to render the entry in the UI.

  • displayValues: An ordered list of display attribute values for all display attributes in the list binding.

n/a

n/a

n/a

n/a

yes

n/a

n/a

displayHint

Returns the display hint for the first attribute to which the binding is associated. The hint identifies whether the attribute should be displayed or not. For more information, see oracle.jbo.AttributeHints.displayHint.

n/a

n/a

n/a

n/a

yes

n/a

n/a

displayHints

Returns a list of name-value pairs for UI hints for all display attributes to which the binding is associated. The map contains the following elements:

  • label: The label to display for the current attribute.

  • tooltip: The tooltip to display for the current attribute.

  • displayHint: The display hint for the current attribute.

  • displayHeight: The height in lines for the current attribute.

  • displayWidth: The width in characters for the current attribute.

  • controlType: The control type hint for the current attribute.

  • format: The format to be used for the current attribute.

n/a

n/a

n/a

yes

yes

n/a

n/a

enabled

Use the operationEnabled property.

n/a

n/a

n/a

n/a

n/a

n/a

n/a

enabledString

Returns disabled if the action binding is not ready to be invoked. Otherwise, returns an empty string ("").

n/a

yes

n/a

n/a

n/a

n/a

n/a

error

Returns any exception that was cached while updating the associated attribute value for a value binding or when invoking an operation bound by an operation binding.

yes

yes

yes

yes

yes

yes

yes

estimatedRowCount

Returns the maximum row count of the rows in the collection with which this iterator binding is associated

yes

n/a

n/a

n/a

n/a

yes

yes

findMode

Returns true if the iterator is currently operating in find mode. Otherwise, returns false.

yes

n/a

n/a

n/a

n/a

n/a

n/a

fullName

Returns the fully qualified name of the binding object in the Oracle ADF binding context.

yes

yes

yes

yes

yes

yes

yes

hints

Returns the value of the UI hint indicated for the binding. See displayHints for the list of UI hint keywords.

yes

yes

yes

yes

yes

yes

yes

inputValue

Returns the value of the first attribute to which the binding is associated. If the binding was used to set the value on the attribute and the set operation failed, this method returns the invalid value that was being set.

n/a

n/a

yes

yes

yes

yes

yes

iteratorBinding

Returns the iterator binding that provides access to the data collection.

n/a

yes

yes

yes

yes

yes

yes

label

Returns the label (if supplied by control hints) for the first attribute of the binding.

n/a

n/a

yes

yes

yes

n/a

n/a

labels

Returns a map of labels (if supplied by control hints) keyed by attribute name for all attributes to which the binding is associated.

n/a

n/a

yes

yes

yes

yes

n/a

labelSet

Returns an ordered set of labels for all the attributes to which the binding is associated.

n/a

n/a

yes

yes

yes

yes

n/a

mandatory

Returns whether the first attribute to which the binding is associated is required.

n/a

n/a

yes

yes

yes

n/a

n/a

name

Returns the name of the binding object in the context of the binding container to which it is registered. Note this property is not visible in the EL expression builder dialog.

yes

yes

yes

yes

yes

yes

yes

operationEnabled

Returns true or false, depending on the state of the action binding. For example, the action binding may be enabled (true) or disabled (false) based on the currency (as determined, for example, when the user clicks the First, Next, Previous, Last navigation buttons).

n/a

yes

n/a

n/a

n/a

n/a

n/a

rangeSet

Returns a list of map elements over the range of rows from the associated iterator binding. The elements in this list are wrapper objects over the indexed row in the range that restricts access to the attributes to which the binding is bound. The properties returned on the reference object are:

  • index: The range index of the row this reference is pointing to.

  • key: The key of the row this reference is pointing to.

  • keyStr: The string format of the key of the row this reference is pointing to.

  • currencyString: The current indexed row as a string. Returns "*" if the current entry belongs to the current row; otherwise, returns " ". This property is useful in JSP applications to display the current row.

  • attributeValues: The array of applicable attribute values from the row.

You may also access an attribute value by name on a range set like rangeSet.dname if dname is a bound attribute in the range binding.

n/a

n/a

n/a

n/a

n/a

yes

yes

rangeSize

Returns the range size of the ADF iterator binding's row set. This allows you to determine the number of data objects to bind from the data source.

yes

n/a

n/a

n/a

n/a

yes

yes

rangeStart

Returns the absolute index in a collection of the first row in range. See the javadoc for oracle.jbo.RowSetIterator.getRangeStart().

yes

n/a

n/a

n/a

n/a

yes

yes

result

Returns the result of a method that is bound and invoked by a method action binding.

n/a

yes

n/a

n/a

n/a

n/a

n/a

rootNodeBinding

Returns the root node of a tree binding.

n/a

n/a

n/a

n/a

n/a

n/a

yes

selectedValue

Returns the value corresponding to the current selected index in the list or button binding.

n/a

n/a

n/a

yes

yes

n/a

n/a

tooltip

Returns the tooltip hint for the first attribute to which the binding is associated.

n/a

n/a

yes

yes

yes

n/a

n/a

updateable

Returns true if the first attribute to which the binding is associated is updateable. Otherwise, returns false.

n/a

n/a

yes

yes

yes

n/a

n/a