JUCtrlAttrsBinding (Oracle ADF Model and Business Components API Reference 10.1.2)

A JUControlBinding class responsible for binding controls/models that are bound to a single Row object in the BC4J layer. This class is responsible for:

Updating the Control Bindings with attribute values from the BC4J Row object for all attributes that this Control Binding is bound to.
Enabling/disabling the control based on whether the corresponding Row's attribute is updateable.

This class defines the abstract APIs for subclasses to implement, so that Row's attributes can be passed to the Binding object for appropriate display/update.

Nested Class Summary

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

Fields inherited from class oracle.jbo.uicli.binding.JUCtrlValueBinding

ATTR_ATTRIBUTE, ATTR_ATTRIBUTE_DEF, ATTR_ATTRIBUTE_DEFS, ATTR_ATTRIBUTE_VALUE, ATTR_ATTRIBUTE_VALUES, ATTR_ATTRIBUTES, ATTR_DISPLAY_HINT, ATTR_INPUT_VALUE, ATTR_LABEL, ATTR_LABELS, ATTR_LABELSET, ATTR_MANDATORY, ATTR_PATH, ATTR_TOOLTIP, ATTR_UPDATEABLE, mHasInputVal, mInputVal, SEP_LIST_DISPLAY

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
`protected`	`JUCtrlAttrsBinding()` * For internal framework use only *
	`JUCtrlAttrsBinding(java.lang.Object control, DCIteratorBinding iterBinding, java.lang.String[] attrNames)` Creates a binding between the given control and attributes in the Rows returned by the passed in Iterator Binding.

Method Summary
`void`	`addControlToPanel(java.lang.Object panel, java.lang.Object layoutObject, java.lang.Object layoutCons)` * For internal framework use only *
`static JUCtrlAttrsBinding`	`createAttributeBinding(JUFormBinding formBinding, java.lang.Object control, java.lang.String voInstanceName, java.lang.String voIterName, java.lang.String voIterBindingName, java.lang.String attrName)` This method is used by the JDeveloper designtime wizards for binding a text component with an attribute of rows of a ViewObject/RowIterator.
`java.lang.Object`	`getValueAt(int attrIndex)` Gets the value from the control for the attribute at the given index.
`protected boolean`	`isControlQueriable()` Returns true if this control can participate in find form.
`void`	`refreshControl()` * For internal framework use only *
`protected void`	`setControlEnabled(boolean flag)`
`void`	`setDataValueAt(java.lang.Object value, int attrIndex)`
`void`	`setValueAt(java.lang.Object value, int attrIndex)` Updates the control/control-binding with the latest value of the attribute at the given index with the given value.
`java.lang.String`	`toString()`
`void`	`updateNavigated(NavigationEvent event)` Overridden as a no-op.
`void`	`updateRangeScrolled(ScrollEvent event)` Overridden as a no-op.
`void`	`updateValuesFromRow(Row row)` Updates the control-binding and hence the control with attribute values from the attributes of this Row.
`void`	`updateValuesFromRows(Row[] rows, boolean clear)` Passes on the first row from the given array of rows to updateValuesFromRow() method to update the bound control's display.

Methods inherited from class oracle.jbo.uicli.binding.JUCtrlValueBinding

compareAndSetAttribute, displayInShortForm, findAttributeDef, getAttribute, getAttribute, getAttribute, getAttributeCount, getAttributeDef, getAttributeDef, getAttributeDefs, getAttributeFromRow, getAttributeFromRow, getAttributeFromRow, getAttributeFromRow, getAttributeFromRow, getAttributeIndexOf, getAttributeNames, getAttributes, getAttributes, getAttributeUIHelper, getAttributeValidators, getAttributeValidators, getAttributeValue, getAttributeValue, getAttributeValueFromRow, getAttributeValues, getAttributeValues, getControlType, getDisplayHeight, getDisplayHint, getDisplayWidth, getError, getErrors, getHint, getHint, getInputValue, getLabel, getLabel, getLabels, getLabelSet, getLocaleContext, getMergedAttributeValues, getPath, getTooltip, getTooltip, hasFormatInformation, internalGet, internalGetRow, isArrayIteratorType, isAttributeMandatory, isAttributeUpdateable, isMandatory, isNewInputValue, isUpdateable, lookupAttributeDef, processInputException, processNewInputValue, put, release, resetInputState, setArrayIteratorType, setAttribute, setAttribute, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeValue, setError, setInputValue, setInputValue, setInputValueHandler, stopEditing, updateRowDeleted, updateRowInserted

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, getFullName, getLayoutObject, getName, getRowAtRangeIndex, getRowIterator, getTransaction, getViewObject, hashCode, internalSetName, needsEstimatedRowCount, removeFromDCExceptions, reportException, resetAttributeExceptionInRow, setBindingContainer, setControl, setName

Methods inherited from class oracle.jbo.common.JboAbstractMap

entrySet, equals

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.jbo.StructureDef

getDefFullName, getDefName, getFullName, getName

Constructor Detail

JUCtrlAttrsBinding

protected JUCtrlAttrsBinding()

*** For internal framework use only ***

JUCtrlAttrsBinding

public JUCtrlAttrsBinding(java.lang.Object control,
                          DCIteratorBinding iterBinding,
                          java.lang.String[] attrNames)

Creates a binding between the given control and attributes in the Rows returned by the passed in Iterator Binding.

Method Detail

getValueAt

public java.lang.Object getValueAt(int attrIndex)

Gets the value from the control for the attribute at the given index. (The index is calculated from the list of attributes this control binding is bound to as passed in the constructor). Framework uses this method to get the attribute value from the control and pass it on to the Row object on the BC4J side.

setValueAt

public void setValueAt(java.lang.Object value,
                       int attrIndex)

Updates the control/control-binding with the latest value of the attribute at the given index with the given value. This method is used by the framework to update the control with attribute values from a BC4J row.

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

setDataValueAt

public void setDataValueAt(java.lang.Object value,
                           int attrIndex)

updateValuesFromRow

public void updateValuesFromRow(Row row)

Updates the control-binding and hence the control with attribute values from the attributes of this Row. Invokes setValueAt() with the attribute value and attribute index with respect to attributes for which this binding is interested.

This method also enables/disables the Swing control based on the updateability of the first (Default) attribute to which this control is bound.

Overrides:: updateValuesFromRow in class JUCtrlValueBinding

setControlEnabled

protected void setControlEnabled(boolean flag)

updateValuesFromRows

public void updateValuesFromRows(Row[] rows,
                                 boolean clear)

Passes on the first row from the given array of rows to updateValuesFromRow() method to update the bound control's display.

Specified by:: updateValuesFromRows in class JUCtrlValueBinding

updateRangeScrolled

public void updateRangeScrolled(ScrollEvent event)

Overridden as a no-op. Since this control is bound to only one row, when that row becomes current the framework uses updateValuesFromRow to update the display

Specified by:: updateRangeScrolled in class JUCtrlValueBinding

See Also:: ScrollEvent

updateNavigated

public void updateNavigated(NavigationEvent event)

Overridden as a no-op. Since this control is bound to only one row, when that row becomes current the framework uses updateValuesFromRow to update the display

Specified by:: updateNavigated in class JUCtrlValueBinding

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

isControlQueriable

protected boolean isControlQueriable()

Description copied from class: DCControlBinding

Returns true if this control can participate in find form. Note that some controls like ProgressBar cannot participate in a find form as they do no accept user inputs. By default this method returns false and it's up to the individual control bindings to determine whether they can participate in a find mode.

Overrides:: isControlQueriable in class DCControlBinding

createAttributeBinding

public static JUCtrlAttrsBinding createAttributeBinding(JUFormBinding formBinding,
                                                        java.lang.Object control,
                                                        java.lang.String voInstanceName,
                                                        java.lang.String voIterName,
                                                        java.lang.String voIterBindingName,
                                                        java.lang.String attrName)

This method is used by the JDeveloper designtime wizards for binding a text component with an attribute of rows of a ViewObject/RowIterator. This method calls JUFormBinding.getRowIterBinding to get the iterator binding using the given parameters and then registers a new JUTextFieldBinding with the iterator binding object so as to display/edit the current row's attribute of the given name.

Parameters:: formBinding - The containing JUPanelBinding in which the given iterator binding would be found/created.; control - The control instance to bind to a ViewObject's attribute.; voInstanceName - Name of the instance of the ViewObject in a BC4J ApplicationModule.; voIterName - Runtime instance name of the iterator in the ViewObject (optional).; voIterBindingName - Instance name of the iterator binding that uniquely identifies an iterator binding object used to read/write data in this given JUPanelBinding instance.; attrName - The name of the attribute of this ViewObject rows that contains data to display/edit in the associated text control.
Returns:: Document object bound to the given text control.