Skip navigation links

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

E10653-03


oracle.jbo.uicli.binding
Class JUCtrlHierNodeBinding

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.JUCtrlHierNodeBinding

All Implemented Interfaces:
java.util.Map, StructureDef, JUCtrlInputValueHandler, JUCtrlValueHandler
Direct Known Subclasses:
JUTreeNodeBinding

public class JUCtrlHierNodeBinding
extends JUCtrlValueBinding
javabean.class
name=JUCtrlHierNodeBinding

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_BINDINGS
           
static java.lang.String ATTR_CHILDREN
           
static java.lang.String ATTR_HIER_BINDING
           
static java.lang.String ATTR_HIER_TYPE
           
static java.lang.String ATTR_KEY_PATH
           
static java.lang.String ATTR_PARENT
           
static java.lang.String ATTR_PROMPT
           
static java.lang.String ATTR_REGION_BINDING
           
static java.lang.String ATTR_ROW
           
static java.lang.String ATTR_ROW_DATA_PROVIDER
           
static java.lang.String ATTR_ROW_KEY
           
static java.lang.String ATTR_ROW_SELECTED
           
static java.lang.String HIER_ACCESSOR_LABEL
           
protected  JUIteratorBinding mChildIterBinding
          *** For internal framework use only ***
protected  java.util.ArrayList mChildren
          *** For internal framework use only ***
protected  boolean mExpandable
          *** For internal framework use only ***
protected  JUCtrlHierBinding mHierBinding
          *** For internal framework use only ***
protected  java.lang.Object mNodeValue
          *** For internal framework use only ***
protected  JUCtrlHierNodeBinding mParentNode
          *** For internal framework use only ***
protected  Key mRowKey
          *** For internal framework use only ***
protected  JUCtrlHierTypeBinding mTypeBinding
          *** For internal framework use only ***

 

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
JUCtrlHierNodeBinding(JUCtrlHierBinding hierBinding, JUCtrlHierNodeBinding parent, JUIteratorBinding iterBinding, JUCtrlHierTypeBinding typeBinding, Row row, boolean expandable)
           

 

Method Summary
 void addChild(JUCtrlHierNodeBinding child)
           
 void addControlToPanel(java.lang.Object panel, java.lang.Object layoutObject, java.lang.Object layoutCons)
          *** For internal framework use only ***
protected  void convertRowsToNodes(Row[] rows)
           
protected  void createAndNotifyDCE(DataChangeEntry.DataChangeType type, java.lang.Object[] idvals, java.lang.String[] names)
           
protected  void createEventProducer()
          createEventProducer creates new instance of JUCtrlValueEventProducer is not exists
 void executeQueryIfNeeded()
          Execute the query for the RowIterator that this row is associated with if it is not already executed.
protected  AttributeDef[] fetchAttrDefs(DCIteratorBinding iter)
           
protected  JUCtrlHierNodeBinding findChildNode(Key key)
           
protected  JUCtrlHierNodeBinding findMatchingNode(Key key)
           
protected  java.lang.Object getBindingHint(java.lang.String key, LocaleContext lCtx)
          Subclasses to override to provide custom impl.
 RegionBinding getBindings()
          Return the nested bindingContainer regionBinding for this node.
protected  DataControl.DataChangeEventPolicy getChangeEventPolicy()
           
 DCIteratorBinding getChildIteratorBinding()
           
 java.util.ArrayList getChildren()
           
 java.util.ArrayList getChildren(java.lang.String accName)
          *** For internal framework use only *** Return a list of children nodes from an accessor child with the matching accessor name (accName) when this node expands into a multiple accessor nodes.
protected  int getChildrenCount(boolean deferred)
          For use by subclasses to get count of direct children nodes under this node.
 java.lang.String getCurrencyString()
           
protected  DataChangeListener getDataChangeListener()
           
 JUCtrlHierBinding getHierBinding()
           
 JUCtrlHierTypeBinding getHierTypeBinding()
          Returns the type binding that governs the display of this node.
protected  JUIteratorBinding getIteratorBindingForDCE()
           
 java.util.ArrayList getKeyPath()
           
protected  java.lang.Object getNodeValue()
           
 JUCtrlHierNodeBinding getParent()
           
 RowSetIterator getParentRowSetIterator()
          Returns the RowSetIterator that this node's row is part of.
protected  DCPermissionDef getPermissionDef(java.lang.String name)
           
 RegionBinding getRegionBinding()
          Get the current nested - bindingContainer associated with this node
 Row getRow()
           
 Key getRowKey()
          Returns the Key object that identifies the row that this node is displaying.
 boolean hasChildren()
          *** For internal framework use only *** For subclass usages to find out if this node has been executed and has children.
protected  java.lang.Object internalGet(java.lang.String key)
          Subclasses should override this to handle a specific key.
protected  Row internalGetRow()
          Internal: Applications should not use this method.
protected  boolean internalHasPermission(java.lang.String actions)
           
protected  boolean internalHasPermission(java.lang.String name, java.lang.String actions)
           
 boolean isAccessorFolderNode()
          *** For internal framework use only *** true if this node represents a folder node for an accessor in case of a master node with mulitple accessors.
protected  boolean isAutoSyncEnabled()
           
protected  boolean isPushOrPollDataChangeEvents()
           
 boolean isRowSelected()
           
 void myUpdateValuesFromRows(Row[] rows, boolean clear)
          Updates the child nodes that this node contains after optionally clearing out all the currently displayed children based on the clear flag.
protected  void processInputException(ValidationException vex)
           
 void refreshControl()
          *** For internal framework use only ***
protected  void refreshNode(Row row)
           
 void release(int flags)
           
 boolean removeChild(JUCtrlHierNodeBinding child)
           
 void setAttributeNames(java.lang.String[] attrNames)
           
 void setAttributes(AttributeDef[] attrs)
           
 void setAutoSyncEnabled(boolean flag)
          Advanced method: Applications should not use this method unless in batchmode and control the sync() calls to middletier.
protected  void setRowAsCurrentOnTargetIterator()
          Deprecated. since 11.1.1 use syncCurrentRow()
 void setRowSelected(boolean flag)
           
protected  void setupAccessors(Row row)
           
 void setValueAt(java.lang.Object value, int rowIndex, int attrIndex)
           
protected  void syncCurrentRow()
          Sync this node and it's parents are current row throughout the node hierarchy.
 java.lang.String toString()
          Renders the attribute value that this node is supposed to show.
 void updateNavigated(NavigationEvent event)
          Update the current row display as the currency has navigated in the iterator with which this control binding is working.
 void updateRangeScrolled(ScrollEvent event)
          Update the control display based on whether the rows of data has scrolled.
 void updateRowDeleted(DeleteEvent event)
          Removes a child node that displays the deleted row from amongst this node's children.
 void updateRowInserted(InsertEvent event)
          Update the display by adding a node to render the inserted row as this node's child.
 void updateValuesFromRow(Row row)
          Finds the child node that displays this row and updates its display.
 void updateValuesFromRows(Row[] rows, boolean clear)
          Given a set of rows, update the control with new attribute values from the rows based on the attributes with which this binding is associated.

 

Methods inherited from class oracle.jbo.uicli.binding.JUCtrlValueBinding
addBindingContainerChangeListenerForCtxEvent, addDataChangeListener, clearAttrDefs, clearEventsCache, compareAndSetAttribute, displayInShortForm, ensureVariableManager, 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, getCachedEvents, getColumnNameForQuery, getControlType, getDataChangeEventPolicy, getDisplayHeight, getDisplayHint, getDisplayWidth, getError, getErrors, getEventProducer, getFormat, getFormats, getFormattedAttributeValue, getHint, getHint, getHints, getInputErrorsForRowKey, getInputValue, getInputValue, getInputValueHandler, getInputValueInRow, getIteratorRenderHint, getLabel, getLabel, getLabels, getLabelSet, getLastEventId, getLocaleContext, getMasterKeyPathForDCE, getMergedAttributeValues, getNullValueString, getPath, getPermissionHolder, getPermissionInfo, getSelectionDef, getState, getTooltip, getTooltip, hasEventProducer, hasFormatInformation, hasServerBindingChanged, hasVariables, initResources, isArrayIteratorType, isAttributeMandatory, isAttributeUpdateable, isAttributeUpdateable, isAttributeUpdateable, isAttributeUpdateable, isAutoSubmit, isEventsCachingEnabled, isMandatory, isNewInputValue, isNullInsertKeyPathForDCE, isUpdateable, isViewable, lookupAttributeDef, notifyDataChangeEvent, notifyDataExceptionEvent, notifyDCE, pinDataControl, processNewInputValue, put, removeAttrName, removeDataChangeListener, removeFromDCExceptions, resetAttributeDefs, resetInputState, resolvePath, restoreFromState, setArrayIteratorType, setAttribute, setAttribute, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeValue, setAttributeValuesInRow, setAttrViewExpressions, setDef, setError, setEventProducer, setEventsCaching, setInputValue, setInputValue, setInputValueHandler, setInputValueInRow, setIteratorBinding, setListener, setNullValueString, startEvents, stopEditing, stopEvents, updateRow, useRowSpecificHints, 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, 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, needsEstimatedRowCount, release, reportException, resetAttributeExceptionInRow, setBindingContainer, setControl, setDataControlPinned, setListener, setName, setViewableExpr

 

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.jbo.StructureDef
getDefFullName, getDefName, getFullName, getName

 

Field Detail

mTypeBinding

protected JUCtrlHierTypeBinding mTypeBinding
*** For internal framework use only ***

mHierBinding

protected JUCtrlHierBinding mHierBinding
*** For internal framework use only ***

mParentNode

protected JUCtrlHierNodeBinding mParentNode
*** For internal framework use only ***

mChildIterBinding

protected JUIteratorBinding mChildIterBinding
*** For internal framework use only ***

mNodeValue

protected java.lang.Object mNodeValue
*** For internal framework use only ***

mRowKey

protected Key mRowKey
*** For internal framework use only ***

mExpandable

protected boolean mExpandable
*** For internal framework use only ***

mChildren

protected java.util.ArrayList mChildren
*** For internal framework use only ***

HIER_ACCESSOR_LABEL

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

ATTR_HIER_TYPE

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

ATTR_CHILDREN

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

ATTR_PARENT

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

ATTR_ROW_KEY

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

ATTR_PROMPT

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

ATTR_HIER_BINDING

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

ATTR_ROW

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

ATTR_ROW_DATA_PROVIDER

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

ATTR_ROW_SELECTED

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

ATTR_BINDINGS

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

ATTR_REGION_BINDING

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

ATTR_KEY_PATH

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

Constructor Detail

JUCtrlHierNodeBinding

public JUCtrlHierNodeBinding(JUCtrlHierBinding hierBinding,
                             JUCtrlHierNodeBinding parent,
                             JUIteratorBinding iterBinding,
                             JUCtrlHierTypeBinding typeBinding,
                             Row row,
                             boolean expandable)

Method Detail

release

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

getHierBinding

public JUCtrlHierBinding getHierBinding()

getParent

public JUCtrlHierNodeBinding getParent()
javabean.property

getRowKey

public Key getRowKey()
Returns the Key object that identifies the row that this node is displaying.

getChildIteratorBinding

public DCIteratorBinding getChildIteratorBinding()
javabean.property

isAutoSyncEnabled

protected boolean isAutoSyncEnabled()
javabean.property

setAutoSyncEnabled

public void setAutoSyncEnabled(boolean flag)
Advanced method: Applications should not use this method unless in batchmode and control the sync() calls to middletier.

Reset this flag if the tree node should not force a DataControl.sync() call to force fetching of data for this node. This method should be used in batch mode when the Tree is viewed in a thin-client and the application wants to control when to perform sync.


executeQueryIfNeeded

public void executeQueryIfNeeded()
Execute the query for the RowIterator that this row is associated with if it is not already executed.
Overrides:
executeQueryIfNeeded in class DCControlBinding

syncCurrentRow

protected void syncCurrentRow()
Sync this node and it's parents are current row throughout the node hierarchy. also sync up currencies with each level's target iterator.

setRowAsCurrentOnTargetIterator

protected void setRowAsCurrentOnTargetIterator()
Deprecated. since 11.1.1 use syncCurrentRow()

hasChildren

public boolean hasChildren()
*** For internal framework use only *** For subclass usages to find out if this node has been executed and has children. If this node is a leaf level node (determined by it's metadata), then this method returns false. If this node is expandable but has not been executed yet, then this method returns true implying that the node may be expandable. If the node already has children, then this method returns true if there are more than zero children. *** For internal framework use only ***

getChildrenCount

protected int getChildrenCount(boolean deferred)
For use by subclasses to get count of direct children nodes under this node. If deferred = true, return a DeferredEstimatedRowCount for the children collection, otherwise return EstimatedRowCount.

isAccessorFolderNode

public final boolean isAccessorFolderNode()
*** For internal framework use only *** true if this node represents a folder node for an accessor in case of a master node with mulitple accessors. Subclasses can use this to skip this node during node searches.

getChildren

public java.util.ArrayList getChildren(java.lang.String accName)
*** For internal framework use only *** Return a list of children nodes from an accessor child with the matching accessor name (accName) when this node expands into a multiple accessor nodes.

getChildren

public java.util.ArrayList getChildren()

addChild

public void addChild(JUCtrlHierNodeBinding child)

removeChild

public boolean removeChild(JUCtrlHierNodeBinding child)

findChildNode

protected JUCtrlHierNodeBinding findChildNode(Key key)

findMatchingNode

protected JUCtrlHierNodeBinding findMatchingNode(Key key)

updateRowInserted

public void updateRowInserted(InsertEvent event)
Update the display by adding a node to render the inserted row as this node's child.
Overrides:
updateRowInserted in class JUCtrlValueBinding

updateRowDeleted

public void updateRowDeleted(DeleteEvent event)
Removes a child node that displays the deleted row from amongst this node's children.
Overrides:
updateRowDeleted in class JUCtrlValueBinding

refreshNode

protected void refreshNode(Row row)

getNodeValue

protected final java.lang.Object getNodeValue()

updateValuesFromRow

public void updateValuesFromRow(Row row)
Finds the child node that displays this row and updates its display.
Overrides:
updateValuesFromRow in class JUCtrlValueBinding

updateValuesFromRows

public void updateValuesFromRows(Row[] rows,
                                 boolean clear)
Description copied from class: JUCtrlValueBinding
Given a set of rows, update the control with new attribute values from the rows based on the attributes with which this binding is associated. If clear is true, the control is expected to remove the current displayed value and associated children values (like in a tree, remove all subnodes) and then set the new values.
Specified by:
updateValuesFromRows in class JUCtrlValueBinding

myUpdateValuesFromRows

public void myUpdateValuesFromRows(Row[] rows,
                                   boolean clear)
Updates the child nodes that this node contains after optionally clearing out all the currently displayed children based on the clear flag.

This method determines the rules to associate with each row in the given array of rows.


convertRowsToNodes

protected void convertRowsToNodes(Row[] rows)

setupAccessors

protected void setupAccessors(Row row)

toString

public java.lang.String toString()
Renders the attribute value that this node is supposed to show. This method is used by JTree to display the String for a node in the tree.
Overrides:
toString in class DCControlBinding

getParentRowSetIterator

public RowSetIterator getParentRowSetIterator()
Returns the RowSetIterator that this node's row is part of.
javabean.property

getHierTypeBinding

public final JUCtrlHierTypeBinding getHierTypeBinding()
Returns the type binding that governs the display of this node. The returned object can be used to find out the name of the attribute that this node displays and the accessor that this row will expand (if any). else if (ATTR_ROW_KEY == key) { mInternalGet_KeyResolved = true; return getRowKey(); }
javabean.property

isRowSelected

public final boolean isRowSelected()

setRowSelected

public void setRowSelected(boolean flag)

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: