Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Oracle Application Development Framework Model Java API Reference 10g Release 3 (10.1.3) B25778-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## oracle.jbo.uicli.binding
Class JUCtrlRangeBinding

`java.lang.Object
java.util.AbstractMap
oracle.jbo.common.JboAbstractMap
oracle.adf.model.binding.DCControlBinding
oracle.jbo.uicli.binding.JUControlBinding
oracle.jbo.uicli.binding.JUCtrlValueBinding
oracle.jbo.uicli.binding.JUCtrlRangeBinding`

All Implemented Interfaces:
  ControlBinding, oracle.adf.model.ControlBinding, JUCtrlInputValueHandler, JUCtrlValueHandler, java.util.Map, RangeBinding, oracle.adf.model.RangeBinding, StructureDef

Direct Known Subclasses:
  GraphDataFromCol, JUCtrlHierBinding, JUGraphBinding, JUTableBinding

public class JUCtrlRangeBinding
extends JUCtrlValueBinding
implements oracle.adf.model.RangeBinding

A JUControlBinding class responsible for binding controls/models that are bound to a range of Row objects in the BC4J layer. This class:

- Is responsible for updating the Control Bindings with attribute values from the BC4J Row objects for all attributes that this Control Binding is bound to by calling setValueAt() method for each attribute value with approprate row, column and value information.
- Declares (abstract) methods that all subclasses need to implement to handle Scroll and Navigation events from the BC4J RowIterator.

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_HEIGHT, ATTR_DISPLAY_HINT, ATTR_DISPLAY_WIDTH, ATTR_FORMAT, ATTR_FORMATS, ATTR_INPUT_VALUE, ATTR_LABEL, ATTR_LABELS, ATTR_LABELSET, ATTR_MANDATORY, ATTR_PATH, ATTR_TOOLTIP, ATTR_UPDATEABLE, ATTR_VIEWABLE, 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, mAttributeListener, mInternalGet_KeyResolved, ROW_KEY_STR`

Constructor Summary
`JUCtrlRangeBinding(java.lang.Object control, DCIteratorBinding iterBinding, java.lang.String[] attrNames)` This constructor passes on the control, iterator, and attribute binding information to its super.

Method Summary
`void` | `addControlToPanel(java.lang.Object panel, java.lang.Object layoutObject, java.lang.Object layoutCons)` *** For internal framework use only ***
`protected JUCtrlValueBindingRef` | `createValueBindingRef(JUCtrlRangeBinding rangeBinding, int index, Row row)`
`int` | `getCurrentRowIndex()` Returns the index of the current row.
`long` | `getEstimatedRowCount()` Returns the number of rows in the collection defined by the associated ViewObject's query (if this control is in data display mode).
`protected java.util.List` | `getInputErrorsForRowKey(Key key)`
`protected java.lang.Object` | `getInputValueInRow(JUCtrlValueBinding binding, Row row, AttributeDef ad)`
`java.util.List` | `getRangeSet()` Returns a list of Map elements over the range of rows from the associated iterator binding.
`int` | `getRangeSize()`
`int` | `getRangeStart()`
`java.lang.Object` | `getValueAt(int rowIndex, int attrIndex)` Deprecated. since 10.1.2
`protected java.lang.Object` | `internalGet(java.lang.String key)` Subclasses should override this to handle a specific key.
`protected boolean` | `needsEstimatedRowCount()`
`void` | `refreshControl()` *** For internal framework use only ***
`void` | `release(int flags)` Releases this ControlBinding.
`void` | `setCurrentRowAtIndex(int rowIndex)` Designates a given index as the current row.
`protected void` | `setInputValueInRow(JUCtrlValueBinding binding, Row row, AttributeDef ad, java.lang.Object value, boolean handleException)`
`protected void` | `setRangeStart(int x)`
`void` | `setValueAt(java.lang.Object value, int rowIndex, int attrIndex)` Deprecated. since 10.1.2
`void` | `updateNavigated(NavigationEvent event)` Method to handle Navigation event from the BC4J iterator.
`void` | `updateRangeScrolled(ScrollEvent event)` Method to handle scroll events from the BC4J iterator.
`void` | `updateValuesFromRow(Row row)` This method is called in the framework when values of a single row need to be updated in a control (typically on a navigation event).
`void` | `updateValuesFromRows(Row[] rows, boolean clear)` This method is invoked in the framework to update values displayed in the associated control.

Methods inherited from class oracle.jbo.uicli.binding.JUCtrlValueBinding
`compareAndSetAttribute, displayInShortForm, ensureVariableManager, 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, getFormat, getFormats, getHint, getHint, getInputValue, getInputValue, getInputValueHandler, getLabel, getLabel, getLabels, getLabelSet, getLocaleContext, getMergedAttributeValues, getNullValueString, getPath, getTooltip, getTooltip, hasFormatInformation, hasVariables, initResources, internalGetRow, internalHasPermission, isArrayIteratorType, isAttributeMandatory, isAttributeUpdateable, isAttributeUpdateable, isMandatory, isNewInputValue, isUpdateable, lookupAttributeDef, processInputException, processNewInputValue, put, resetInputState, resolvePath, setArrayIteratorType, setAttribute, setAttribute, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeValue, setError, setInputValue, setInputValue, setInputValueHandler, setNullValueString, stopEditing, updateRowDeleted, updateRowInserted, validateInputValue`

Methods inherited from class oracle.jbo.uicli.binding.JUControlBinding
`getCurrentRow, getFormBinding, getIteratorBinding, reportException, setFormBinding`

Methods inherited from class oracle.adf.model.binding.DCControlBinding
`addToDCExceptions, executeQuery, executeQueryIfNeeded, get, getAllRowsInRange, getApplicationModule, getBindingContainer, getControl, getControlModel, getDCIteratorBinding, getDef, getDefFullName, getDefName, getFullName, getLayoutObject, getName, getRowAtRangeIndex, getRowIterator, getTransaction, getViewObject, hashCode, internalHasPermission, internalSetName, isControlQueriable, removeFromDCExceptions, reportException, resetAttributeExceptionInRow, setBindingContainer, setControl, setListener, setListener, setName, toString`

Methods inherited from class oracle.jbo.common.JboAbstractMap
`entrySet, equals, internalPut`

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.adf.model.RangeBinding
`getLabelSet`

Methods inherited from interface oracle.adf.model.ControlBinding
`setListener`

Methods inherited from interface oracle.binding.ControlBinding
`getName, getPath, resolvePath, setListener`

Methods inherited from interface oracle.jbo.StructureDef
`getDefFullName, getDefName, getFullName, getName`

Constructor Detail

### JUCtrlRangeBinding

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

  This constructor passes on the control, iterator, and attribute binding information to its super.

Method Detail

### getValueAt

    public java.lang.Object getValueAt(int rowIndex,
                                       int attrIndex)

  Deprecated. since 10.1.2

### 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`

### setValueAt

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

  Deprecated. since 10.1.2

### getRangeStart

    public int getRangeStart()

### getRangeSize

    public int getRangeSize()

### getEstimatedRowCount

    public long getEstimatedRowCount()

  Returns the number of rows in the collection defined by the associated ViewObject's query (if this control is in data display mode). If this control is in find mode, returns the number of rows in the associated ViewCriteria object.

### getCurrentRowIndex

    public int getCurrentRowIndex()

  Description copied from interface: `RangeBinding`
  Returns the index of the current row.
  Specified by:
    `getCurrentRowIndex` in interface `oracle.adf.model.RangeBinding`

### setCurrentRowAtIndex

    public void setCurrentRowAtIndex(int rowIndex)

  Description copied from interface: `RangeBinding`
  Designates a given index as the current row.
  Specified by:
    `setCurrentRowAtIndex` in interface `oracle.adf.model.RangeBinding`

### getInputErrorsForRowKey

    protected java.util.List getInputErrorsForRowKey(Key key)

  Overrides:
    `getInputErrorsForRowKey` in class `JUCtrlValueBinding`

### getInputValueInRow

    protected java.lang.Object getInputValueInRow(JUCtrlValueBinding binding,
                                                  Row row,
                                                  AttributeDef ad)

  Overrides:
    `getInputValueInRow` in class `JUCtrlValueBinding`

### setInputValueInRow

    protected void setInputValueInRow(JUCtrlValueBinding binding,
                                      Row row,
                                      AttributeDef ad,
                                      java.lang.Object value,
                                      boolean handleException)

  Overrides:
    `setInputValueInRow` in class `JUCtrlValueBinding`

### updateValuesFromRow

    public void updateValuesFromRow(Row row)

  This method is called in the framework when values of a single row need to be updated in a control (typically on a navigation event).
  Overrides:
    `updateValuesFromRow` in class `JUCtrlValueBinding`

### getRangeSet

    public java.util.List getRangeSet()

  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 only the attributes that this control-binding is bound to. The map exposes the following properties for each row in the range:
  - `index` - returns Range Index of the row
  - `key` - returns Key of the row
  - `keyStr` - returns String format of the key of the row at this index()
  - `currencyString` - if this row is the current row, returns * else returns a space " ".
  - `attributeValues` - returns array of attribute values for attributes that are bound in this rangeBinding from the row
  -   Specified by:
        `getRangeSet` in interface `oracle.adf.model.RangeBinding`

### createValueBindingRef

    protected JUCtrlValueBindingRef createValueBindingRef(JUCtrlRangeBinding rangeBinding,
                                                          int index,
                                                          Row row)

### updateValuesFromRows

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

  This method is invoked in the framework to update values displayed in the associated control. This implementation updates all values given in the array of rows irrespective of the clear flag (which indicates whether to clear out the existing displayed values or not).
  Specified by:
    `updateValuesFromRows` in class `JUCtrlValueBinding`

### updateRangeScrolled

    public void updateRangeScrolled(ScrollEvent event)

  Method to handle scroll events from the BC4J iterator. Subclasses need to implement this method to update the currently displayed rowset (if desired).
  Specified by:
    `updateRangeScrolled` in class `JUCtrlValueBinding`
  See Also:
    `ScrollEvent`

### updateNavigated

    public void updateNavigated(NavigationEvent event)

  Method to handle Navigation event from the BC4J iterator. Subclasses need to implement this method to update their current row display (if desired).
  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`

### 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:

  - `rangeSet` - returns getRangeSet()
  - `estimatedRowCount` - returns getEstimatedRowCount()
  -   Overrides:
        `internalGet` in class `JUCtrlValueBinding`

### release

    public void release(int flags)

  Description copied from interface: `ControlBinding`
  Releases this ControlBinding. This method is called when the view component has finished using this ControlBinding.
  Specified by:
    `release` in interface `oracle.adf.model.ControlBinding`
  Overrides:
    `release` in class `JUCtrlValueBinding`

### needsEstimatedRowCount

    protected boolean needsEstimatedRowCount()

  Overrides:
    `needsEstimatedRowCount` in class `DCControlBinding`

### setRangeStart

    protected void setRangeStart(int x)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Oracle Application Development Framework Model Java API Reference 10g Release 3 (10.1.3) B25778-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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