Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.4.0)

E10653-05

oracle.jbo.uicli.binding
Class JUCtrlHierBinding

java.lang.Object
  extended by java.util.AbstractMap
      extended by oracle.jbo.common.JboAbstractMap
          extended by oracle.adf.model.binding.DCControlBinding
              extended by oracle.jbo.uicli.binding.JUControlBinding
                  extended by oracle.jbo.uicli.binding.JUCtrlValueBinding
                      extended by oracle.jbo.uicli.binding.JUCtrlRangeBinding
                          extended by oracle.jbo.uicli.binding.JUCtrlHierBinding
All Implemented Interfaces:
java.util.Map, ControlBinding, RangeBinding, StructureDef, JUCtrlInputValueHandler, JUCtrlValueHandler
Direct Known Subclasses:
JUTableBinding, JUTreeBinding

public class JUCtrlHierBinding
extends JUCtrlRangeBinding

javabean.class
name=JUCtrlHierBinding

Nested Class Summary
 
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 ATTR_CHILDREN
           
static java.lang.String ATTR_ROOTNODE
           
protected  JUCtrlHierNodeBinding mRootBinding
           
protected  JUCtrlHierTypeBinding[] mTypeBindings
           
 
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_AUTOSUBMIT, ATTR_DISPLAY_HEIGHT, ATTR_DISPLAY_HINT, ATTR_DISPLAY_WIDTH, ATTR_FORMAT, ATTR_FORMATS, ATTR_HINTS, ATTR_INPUT_VALUE, ATTR_LABEL, ATTR_LABELS, ATTR_LABELSET, ATTR_MANDATORY, ATTR_PATH, ATTR_TOOLTIP, ATTR_UPDATEABLE, ATTR_VIEWABLE, DATACHANGE_EVENT_POLICY, GET_ALLOWS, mAttrs, 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, DC_BINDING_ERROR, mAttributeListener, mInternalGet_KeyResolved, mPermission, mPermissionInfo, ROW_KEY_STR
 
Fields inherited from class oracle.jbo.common.JboAbstractMap
MAP_NULL_VALUE
 
Constructor Summary
protected JUCtrlHierBinding()
           
  JUCtrlHierBinding(java.lang.Object control, JUIteratorBinding iterBinding, java.lang.String[] attrNames, JUCtrlHierTypeBinding[] typeBindings)
           
 
Method Summary
protected  JUCtrlHierNodeBinding bringNodeToRangeKeyPath(java.util.List<Key> keyPath, int rangeIndex)
          Find a node by KeyPath.
protected  void clearAttrDefs()
           
protected  void clearRootBinding()
           
protected  JUCtrlHierNodeBinding createNodeBinding(JUCtrlHierNodeBinding parent, JUIteratorBinding iterBinding, JUCtrlHierTypeBinding typeBinding, Row row, boolean expandable)
           
protected  void createRootBinding()
           
protected  JUCtrlHierNodeBinding findNodeByDCEPath(java.lang.Object[] vals)
          only for use by DataChangeEvents generated from nonADFbc DCs.
 JUCtrlHierNodeBinding findNodeByKeyPath(java.util.List al)
           
 java.util.List getChildren()
          *** For internal framework use only *** Returns children of the root node for easy el-access.
 java.util.Map getFormats()
           
protected  java.util.Map getHintMap(java.lang.String hintType)
           
 java.util.Map getHints()
          Returns a map that can resolve the custom properties on the attributeDef or attributeDef on an accessor that this tree exposes.
 java.util.Map getLabels()
           
 JUCtrlHierNodeBinding getMasterNodeForDCE(DataChangeEntry en)
          *** For internal framework use only *** Returns the master node for this event entry.
 JUCtrlHierNodeBinding getRootNodeBinding()
          Returns the root node binding that contains the iterator that the root node is displaying.
 JUCtrlHierTypeBinding[] getTypeBindings()
           
protected  java.lang.Object internalGet(java.lang.String key)
          Subclasses should override this to handle a specific key.
protected  JUCtrlHierNodeBinding internalGetRootNodeBinding()
           
 void release(int flags)
           
protected  JUCtrlHierNodeBinding restoreTreeAndExpand(java.util.ArrayList al)
          Advanced method: Applications should not use this method
 void setAttributeNames(java.lang.String[] attrNames)
           
 void setAttributes(AttributeDef[] attrs)
           
protected  void setDef(DCControlBindingDef controlDef)
           
protected  void setTypeBindings(JUCtrlHierTypeBinding[] typeBindings)
           
 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)
          Updates the nodes in the tree based on the given set of rows.
 
Methods inherited from class oracle.jbo.uicli.binding.JUCtrlRangeBinding
addControlToPanel, createValueBindingRef, findOrCreateSelectionAttributeDef, getCurrentRowIndex, getDeferredEstimatedRowCount, getEstimatedRowCount, getInputErrorsForRowKey, getInputValueInRow, getRangeSet, getRangeSize, getRangeStart, getValueAt, isSelectionEnabled, needsEstimatedRowCount, refreshControl, setCurrentRowAtIndex, setInputValueInRow, setRangeStart, setValueAt, updateNavigated, updateRangeScrolled, useRowSpecificHints
 
Methods inherited from class oracle.jbo.uicli.binding.JUCtrlValueBinding
addBindingContainerChangeListenerForCtxEvent, addDataChangeListener, clearEventsCache, compareAndSetAttribute, createAndNotifyDCE, createEventProducer, displayInShortForm, ensureVariableManager, fetchAttrDefs, findAttributeDef, generateDCE, getAttribute, getAttribute, getAttribute, getAttributeCount, getAttributeDef, getAttributeDef, getAttributeDefs, getAttributeDefsForRow, getAttributeFromRow, getAttributeFromRow, getAttributeFromRow, getAttributeFromRow, getAttributeFromRow, getAttributeIndexOf, getAttributeNames, getAttributes, getAttributes, getAttributeUIHelper, getAttributeValidators, getAttributeValidators, getAttributeValue, getAttributeValue, getAttributeValueFromRow, getAttributeValues, getAttributeValues, getAttrViewExpressions, getBindingHint, getCachedEvents, getChangeEventPolicy, getColumnNameForQuery, getControlType, getDataChangeEventPolicy, getDataChangeListener, getDisplayHeight, getDisplayHint, getDisplayWidth, getError, getErrors, getEventProducer, getFormat, getFormattedAttributeValue, getHint, getHint, getInputValue, getInputValue, getInputValueHandler, getInputValueOnError, getIteratorBindingForDCE, getIteratorRenderHint, getLabel, getLabel, getLabelSet, getLastEventId, getLocaleContext, getMasterKeyPathForDCE, getMergedAttributeValues, getNullValueString, getPath, getPermissionDef, getPermissionHolder, getPermissionInfo, getSelectionDef, getState, getTooltip, getTooltip, hasEventProducer, hasFormatInformation, hasServerBindingChanged, hasVariables, initResources, internalGetRow, internalHasPermission, internalHasPermission, isArrayIteratorType, isAttributeMandatory, isAttributeUpdateable, isAttributeUpdateable, isAttributeUpdateable, isAttributeUpdateable, isAutoSubmit, isEventsCachingEnabled, isMandatory, isNewInputValue, isNullInsertKeyPathForDCE, isPushDataChangeEvents, isPushOrPollDataChangeEvents, isUpdateable, isViewable, lookupAttributeDef, notifyDataChangeEvent, notifyDataExceptionEvent, notifyDCE, pinDataControl, processInputException, processNewInputValue, put, removeAttrName, removeDataChangeListener, removeFromDCExceptions, resetAttributeDefs, resetInputState, resolvePath, restoreFromState, setArrayIteratorType, setAttribute, setAttribute, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeValue, setAttributeValuesInRow, setAttrViewExpressions, setError, setEventProducer, setEventsCaching, setInputValue, setInputValue, setInputValueHandler, setIteratorBinding, setListener, setNullValueString, startEvents, stopEditing, stopEvents, updateRow, 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, evaluateBooleanExpression, executeQuery, executeQueryIfNeeded, get, getAllRowsInRange, getApplicationModule, getAttributeListener, getBindingContainer, getControl, getControlModel, getDCIteratorBinding, getDef, getDefFullName, getDefName, getFullName, getLayoutObject, getName, getPermission, getPermissionTargetName, getRowAtRangeIndex, getRowIterator, getTransaction, getViewableExpr, getViewObject, hashCode, internalSetName, isControlQueriable, isControlViewable, isReleased, release, reportException, resetAttributeExceptionInRow, setBindingContainer, setControl, setDataControlPinned, setListener, setName, setViewableExpr, toString
 
Methods inherited from class oracle.jbo.common.JboAbstractMap
entrySet, equals, internalPut, 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.adf.model.RangeBinding
getLabelSet
 
Methods inherited from interface oracle.adf.model.ControlBinding
setListener
 
Methods inherited from interface oracle.binding.ControlBinding
getName, getPath, release, resolvePath, setListener
 
Methods inherited from interface oracle.jbo.StructureDef
getDefFullName, getDefName, getFullName, getName
 

Field Detail

mTypeBindings

protected JUCtrlHierTypeBinding[] mTypeBindings

mRootBinding

protected JUCtrlHierNodeBinding mRootBinding

ATTR_ROOTNODE

public static final java.lang.String ATTR_ROOTNODE
See Also:
Constant Field Values

ATTR_CHILDREN

public static final java.lang.String ATTR_CHILDREN
See Also:
Constant Field Values
Constructor Detail

JUCtrlHierBinding

protected JUCtrlHierBinding()

JUCtrlHierBinding

public JUCtrlHierBinding(java.lang.Object control,
                         JUIteratorBinding iterBinding,
                         java.lang.String[] attrNames,
                         JUCtrlHierTypeBinding[] typeBindings)
Method Detail

setDef

protected void setDef(DCControlBindingDef controlDef)
Overrides:
setDef in class JUCtrlValueBinding

setTypeBindings

protected void setTypeBindings(JUCtrlHierTypeBinding[] typeBindings)

getRootNodeBinding

public JUCtrlHierNodeBinding getRootNodeBinding()
Returns the root node binding that contains the iterator that the root node is displaying.

javabean.property

getTypeBindings

public JUCtrlHierTypeBinding[] getTypeBindings()

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 JUCtrlRangeBinding

restoreTreeAndExpand

protected JUCtrlHierNodeBinding restoreTreeAndExpand(java.util.ArrayList al)
Advanced method: Applications should not use this method


updateValuesFromRows

public void updateValuesFromRows(Row[] rows,
                                 boolean clear)
Updates the nodes in the tree based on the given set of rows. Clears the existing display if clear flag is true.

Overrides:
updateValuesFromRows in class JUCtrlRangeBinding

getHintMap

protected java.util.Map getHintMap(java.lang.String hintType)

getFormats

public java.util.Map getFormats()
Overrides:
getFormats in class JUCtrlValueBinding

getLabels

public java.util.Map getLabels()
Overrides:
getLabels in class JUCtrlValueBinding

clearRootBinding

protected void clearRootBinding()

clearAttrDefs

protected void clearAttrDefs()
Overrides:
clearAttrDefs in class JUCtrlValueBinding
For internal use only. Application developers should not use this
*** For internal framework use only ***

createRootBinding

protected void createRootBinding()

createNodeBinding

protected JUCtrlHierNodeBinding createNodeBinding(JUCtrlHierNodeBinding parent,
                                                  JUIteratorBinding iterBinding,
                                                  JUCtrlHierTypeBinding typeBinding,
                                                  Row row,
                                                  boolean expandable)

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:

  • rootNodeBinding - returns getRootNodeBinding()
  • children - returns getRootNodeBinding().getChildren()()
  • Overrides:
    internalGet in class JUCtrlRangeBinding

    getHints

    public java.util.Map getHints()
    Returns a map that can resolve the custom properties on the attributeDef or attributeDef on an accessor that this tree exposes. el like: bindings.thisTree.(accessor.)*attr.label or bindings.thisTree.(accessor.)*attr.myCustomProperty where label and myCustomProperty are control hints or custom properties defined on the attributedef at that particular accessor level. Note that accessor entry in the el is optional.

    Overrides:
    getHints in class JUCtrlValueBinding
    javabean.property

    getChildren

    public java.util.List getChildren()
    *** For internal framework use only *** Returns children of the root node for easy el-access.


    release

    public void release(int flags)
    Overrides:
    release in class JUCtrlRangeBinding

    getMasterNodeForDCE

    public final JUCtrlHierNodeBinding getMasterNodeForDCE(DataChangeEntry en)
    *** For internal framework use only *** Returns the master node for this event entry.


    findNodeByDCEPath

    protected JUCtrlHierNodeBinding findNodeByDCEPath(java.lang.Object[] vals)
    only for use by DataChangeEvents generated from nonADFbc DCs. DCE keyPath contains keys of each level upto the root level (root level key value being the last.


    bringNodeToRangeKeyPath

    protected JUCtrlHierNodeBinding bringNodeToRangeKeyPath(java.util.List<Key> keyPath,
                                                            int rangeIndex)
    Find a node by KeyPath. Also, if necessary, scroll ranges at each level to place the node in a particular level at the given range index.

    Parameters:
    keyPath - A Java List containing keys from the root level down to a given node
    rangeIndex - The range index to put the node at each level
    Returns:

    findNodeByKeyPath

    public JUCtrlHierNodeBinding findNodeByKeyPath(java.util.List al)

    internalGetRootNodeBinding

    protected JUCtrlHierNodeBinding internalGetRootNodeBinding()

    setAttributes

    public void setAttributes(AttributeDef[] attrs)
    Overrides:
    setAttributes in class JUCtrlValueBinding

    setAttributeNames

    public void setAttributeNames(java.lang.String[] attrNames)
    Overrides:
    setAttributeNames in class JUCtrlValueBinding

    Oracle Fusion Middleware Java API Reference for Oracle ADF Model
    11g Release 1 (11.1.1.4.0)

    E10653-05

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