Skip navigation links

oracle.jbo.uicli.binding
Class JUCtrlValueBinding

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

All Implemented Interfaces:

java.util.Map, StructureDef, JUCtrlInputValueHandler, JUCtrlValueHandler

Direct Known Subclasses:

JUCtrlAttrsBinding, JUCtrlHierNodeBinding, JUCtrlRangeBinding

public abstract class JUCtrlValueBinding

extends JUControlBinding

implements StructureDef, JUCtrlValueHandler

A JUControlBinding class responsible for maintaining which attribute(s) of a row this binding can display/update. This class accepts a list of attribute names and gets the AttributeDef objects for those attributes from the associated ViewObject. This class also provides APIs to update values in a control given a new row or a set of rows. JUIteratorBinding uses APIs in this class to notify the controls of:

• Change in scrolling range if the control works with a range of rows
• Change in currency
• Row-inserted event
• Row-deleted event

This class also has accessor methods that return attribute values for Attributes with which this control binding is working. The indices of these attributes are ordered based on the names provided to this control binding in the constructor.

javabean.class

name=JUCtrlValueBinding

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_ATTRIBUTE
static java.lang.String	ATTR_ATTRIBUTE_DEF
static java.lang.String	ATTR_ATTRIBUTE_DEFS
static java.lang.String	ATTR_ATTRIBUTE_VALUE
static java.lang.String	ATTR_ATTRIBUTE_VALUES
static java.lang.String	ATTR_ATTRIBUTES
static java.lang.String	ATTR_AUTOSUBMIT
static java.lang.String	ATTR_DISPLAY_HEIGHT
static java.lang.String	ATTR_DISPLAY_HINT
static java.lang.String	ATTR_DISPLAY_WIDTH
static java.lang.String	ATTR_FORMAT
static java.lang.String	ATTR_FORMATS
static java.lang.String	ATTR_HINTS
static java.lang.String	ATTR_INPUT_VALUE
static java.lang.String	ATTR_LABEL
static java.lang.String	ATTR_LABELS
static java.lang.String	ATTR_LABELSET
static java.lang.String	ATTR_MANDATORY
static java.lang.String	ATTR_PATH
static java.lang.String	ATTR_TOOLTIP
static java.lang.String	ATTR_UPDATEABLE
static java.lang.String	ATTR_VIEWABLE
static java.lang.String	DATACHANGE_EVENT_POLICY
static java.lang.String	GET_ALLOWS
protected AttributeDef[]	mAttrs
protected boolean	mHasInputVal
protected java.lang.Object	mInputVal
static java.lang.String	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	JUCtrlValueBinding()
	JUCtrlValueBinding(java.lang.Object control, DCIteratorBinding iterBinding, java.lang.String[] attrNames)

Method Summary

void	addBindingContainerChangeListenerForCtxEvent() Creates new instance of BindingContainerChangeAdapterForCtxEvent and calls getBindingContainer().addBindingContainerChangeListenerForCtxEvent.
void	addDataChangeListener(DataChangeListener listener)
protected void	clearAttrDefs()
protected void	clearEventsCache() Deprecated. since 11.1.1.1.2
void	compareAndSetAttribute(int index, java.lang.Object cVal) Advanced method.
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
boolean	displayInShortForm() Returns true if the attribute is to displayed in the short(summary) form.
VariableValueManager	ensureVariableManager()
protected AttributeDef[]	fetchAttrDefs(DCIteratorBinding iter)
AttributeDef	findAttributeDef(java.lang.String name) Gets an attribute definition, given its name.
protected boolean	generateDCE()
java.lang.Object	getAttribute() Returns formatted attribute value for this binding.
java.lang.Object	getAttribute(int index) Returns formatted attribute value for the attribute at the given index in this control binding's definition.
java.lang.Object	getAttribute(java.lang.String name)
int	getAttributeCount() Returns the number of defined attributes.
AttributeDef	getAttributeDef() Primarily for spel support.
AttributeDef	getAttributeDef(int index) Returns attribute definition at the given index.
AttributeDef[]	getAttributeDefs() Return Attribute definitions of the attributes to which this binding is bound to.
AttributeDef[]	getAttributeDefsForRow(Row row) Return Attribute definitions of the attributes to which this binding is bound to.
java.lang.Object	getAttributeFromRow(int rowIndexInRange, int attrIndex) Return formatted attribute value for the attribute at given index in the row at the given row index within the current range in the iterator that this binding is associated with.
java.lang.Object	getAttributeFromRow(int rowIndexInRange, java.lang.String name) Return formatted attribute value for the attribute of the given name in the row at the given row index within the current range in the iterator that this binding is associated with.
java.lang.Object	getAttributeFromRow(Row row, AttributeDef def) Return formatted attribute value for the attribute with the given attribute definition and in the given row.
java.lang.Object	getAttributeFromRow(Row row, int attrIndex) Return the attribute value for the attribute at the given index in this control binding and from within the given row.
java.lang.Object	getAttributeFromRow(Row row, java.lang.String name) Return the attribute value for the attribute of the given name from within the given row.
int	getAttributeIndexOf(java.lang.String name) Finds the index (0-based) of the named attribute.
java.lang.String[]	getAttributeNames() Return names of the attributes to which this binding is bound to and as defined in the binding definition.
java.lang.Object[]	getAttributes() Returns formatted attribute values for this binding.
protected java.util.ArrayList	getAttributes(Row row, AttributeDef[] attrs) Returns formatted attribute values for the given set of attribute defs.
protected AttributeHints	getAttributeUIHelper(java.lang.String attrName)
java.util.ArrayList	getAttributeValidators()
java.util.ArrayList	getAttributeValidators(int index)
java.lang.Object	getAttributeValue() Returns unformatted attribute value of the first attribute
java.lang.Object	getAttributeValue(int j) Returns unformatted attribute value of the first attribute
protected java.lang.Object	getAttributeValueFromRow(int rowIndexInRange, int attrIndex) Returns unformatted attribute value of the first attribute
java.lang.Object[]	getAttributeValues() Returns unformatted attribute values for this binding.
protected java.util.ArrayList	getAttributeValues(Row row, AttributeDef[] attrs) Returns un-formatted (raw) attribute values.
protected java.lang.String[]	getAttrViewExpressions()
protected java.lang.Object	getBindingHint(java.lang.String key, LocaleContext lCtx) Subclasses to override to provide custom impl.
protected java.util.List	getCachedEvents() Deprecated. since 11.1.1.1.2
protected DataControl.DataChangeEventPolicy	getChangeEventPolicy()
java.lang.String	getColumnNameForQuery(int index)
int	getControlType() Returns the preferred control type for this attribute.
DataControl.DataChangeEventPolicy	getDataChangeEventPolicy()
protected DataChangeListener	getDataChangeListener()
int	getDisplayHeight() Returns the display width for this attribute.
java.lang.String	getDisplayHint() Retrieves the display hint that dictates whether this attribute should be visible or not.
int	getDisplayWidth() Returns the display width for this attribute.
JboException	getError() Primarily for spel support.
java.util.List	getErrors() Primarily for spel support.
EventProducer	getEventProducer() getEventProducer returns the EventProducer
java.lang.String	getFormat() Retrieves the format to be used to format any attribute value.
java.util.Map	getFormats()
java.lang.Object	getFormattedAttributeValue(java.lang.String attrName, java.lang.Object rawValue)
java.lang.String	getHint(java.lang.String sHintName) Returns the hint value based on the hint name.
java.lang.String	getHint(java.lang.String voAttrName, java.lang.String objectAttrName, java.lang.String sHintName) Returns the hint value based on the hint name.
java.util.Map	getHints() Returns a map that can resolve the custom properties on the first attribute on this binding via el like: bindings.thisBindingName.label or bindings.thisBindingName.myCustomProperty where label and myCustomProperty are control hints or custom properties defined on the attributedef that this binding is associated with.
protected java.util.List	getInputErrorsForRowKey(Key key)
java.lang.Object	getInputValue() Primarily for spel support.
java.lang.Object	getInputValue(JUCtrlValueBinding binding, int index) Return a custom valueHandle for inputValue.
JUCtrlInputValueHandler	getInputValueHandler() Return the input handler that this binding uses for setInputValue.
protected java.lang.Object	getInputValueInRow(JUCtrlValueBinding binding, Row row, AttributeDef ad)
protected JUIteratorBinding	getIteratorBindingForDCE()
protected DCIteratorBinding.RenderHintTypes	getIteratorRenderHint() To be used by view-technology specific bindings to determine if the associated iterator binding may be rendered in a secondary thread or not.
java.lang.String	getLabel() Retrieves the label to be used in any attribute prompts
java.lang.String	getLabel(java.lang.String voAttrName, java.lang.String objectAttrName) Retrieves the label to be used in any attribute prompts
java.util.Map	getLabels()
java.lang.String[]	getLabelSet()
protected int	getLastEventId()
LocaleContext	getLocaleContext()
java.lang.Object[]	getMasterKeyPathForDCE(DataChangeEntry en) *** For internal framework use only *** Returns an array of all elements except the first one from KeyPath.
protected static java.lang.String	getMergedAttributeValues(java.util.List al)
java.lang.String	getNullValueString()
java.lang.String	getPath() The returned path uniquely identifies this binding within a top-level bindingContainer.
protected DCPermissionDef	getPermissionDef(java.lang.String name)
protected oracle.adf.share.security.PermissionHolder	getPermissionHolder(java.lang.String name)
PermissionInfo	getPermissionInfo()
protected oracle.jbo.uicli.binding.JUCtrlSelectionDef	getSelectionDef()
java.lang.Object	getState() In the process of re-creating a binding container.
java.lang.String	getTooltip() Retrives the tooltip text to be used for this attribute.
java.lang.String	getTooltip(java.lang.String voAttrName, java.lang.String objectAttrName) Retrives the tooltip text to be used for this attribute.
protected boolean	hasEventProducer()
boolean	hasFormatInformation() Returns true if any format hints have been defined for this attribute.
protected boolean	hasServerBindingChanged()
boolean	hasVariables()
protected void	initResources() Invoked when the bindingContainer is being initialized for the first time or after it's locale is changed.
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 target, java.lang.String actions)
boolean	isArrayIteratorType()
boolean	isAttributeMandatory(int index) Returns true if the attribute at the given index is set to be mandatory.
boolean	isAttributeUpdateable(int index) Determines whether this attribute (by attribute index relative to this binding) is updateable for the current row instance.
protected boolean	isAttributeUpdateable(Row row, int index)
protected boolean	isAttributeUpdateable(Row row, java.lang.String attrName)
boolean	isAttributeUpdateable(java.lang.String attrName) Determines whether the given attribute (by name) is updateable for the current row instance.
boolean	isAutoSubmit() Returns the autoSubmit value for this attribute.
protected boolean	isEventsCachingEnabled() Deprecated. since 11.1.1.1.2
boolean	isMandatory() Primarily for spel support.
boolean	isNewInputValue(JUCtrlValueBinding binding, int index, java.lang.Object value) Returns true, if the caller needs to call setInputValue() on this binding to update the current attribute value that this binding is set to.
boolean	isNullInsertKeyPathForDCE(DataChangeEntry en) *** For internal framework use only *** If this insert event is for data that need to be inserted before or after a known data point in the same hierarchy/level, then return false.
protected boolean	isPushOrPollDataChangeEvents()
boolean	isUpdateable() Primarily for spel support.
boolean	isViewable()
AttributeDef	lookupAttributeDef(java.lang.String name) Gets an attribute definition, given its name.
protected void	notifyDataChangeEvent(DataChangeEvent event)
protected void	notifyDataExceptionEvent(DataExceptionEvent event)
protected void	notifyDCE(DataChangeEvent event) Deprecated. ...use notifyDataChangeEvent.
protected void	pinDataControl(boolean flag) Advanced for ADS usage only.
protected void	processInputException(ValidationException vex)
boolean	processNewInputValue(java.lang.Object value) Returns true, if the caller needs to call setInputValue() on this binding to update the current attribute value that this binding is set to.
java.lang.Object	put(java.lang.Object obj, java.lang.Object value)
void	release(int flags)
void	removeAttrName(java.lang.String sName)
void	removeDataChangeListener(DataChangeListener listener)
protected void	removeFromDCExceptions()
protected void	resetAttributeDefs()
protected void	resetInputState() Resets any exceptions and client-side values that this binding may hold.
boolean	resolvePath(java.util.Map postMap) Return true if this binding's path is found as a key in the given map.
void	restoreFromState(java.lang.Object state) Initialize binding instance with value from state object
void	setArrayIteratorType()
void	setAttribute(int index, java.lang.Object value)
void	setAttribute(java.lang.String name, java.lang.Object value)
void	setAttributeInRow(int rowIndexInRange, int attrIndex, java.lang.Object value, boolean handleException)
void	setAttributeInRow(int rowIndexInRange, java.lang.String name, java.lang.Object value, boolean handleException)
void	setAttributeInRow(Row row, AttributeDef def, java.lang.Object value)
void	setAttributeInRow(Row row, AttributeDef def, java.lang.Object value, boolean handleException)
void	setAttributeInRow(Row row, int attrIndex, java.lang.Object value, boolean handleException)
void	setAttributeInRow(Row row, java.lang.String name, java.lang.Object value, boolean handleException)
void	setAttributeNames(java.lang.String[] attrNames)
void	setAttributes(AttributeDef[] attrs)
void	setAttributeValue(java.lang.Object val) Sets the value to the first attribute in this binding.
void	setAttributeValuesInRow(Row row, AttributeDef[] defs, java.lang.Object[] values, boolean handleException)
protected void	setAttrViewExpressions(java.lang.String[] stra)
protected void	setDef(DCControlBindingDef controlDef)
protected void	setError(JboException vex, java.lang.Object value)
protected void	setEventProducer(EventProducer producer)
protected void	setEventsCaching(boolean flag) Deprecated. since 11.1.1.1.2
void	setInputValue(JUCtrlValueBinding binding, int index, java.lang.Object value) Implement value specific handling of the inputValue.
void	setInputValue(java.lang.Object value) Sets the value given and caches any error/exception in member variables for further access.
void	setInputValueHandler(JUCtrlInputValueHandler hdlr)
protected void	setInputValueInRow(JUCtrlValueBinding binding, Row row, AttributeDef ad, java.lang.Object value, boolean handleException)
protected void	setIteratorBinding(DCIteratorBinding iterBinding) Internal method, don't use.
void	setListener(UpdateListener listener)
protected void	setNullValueString(java.lang.String str)
protected int	startEvents(int fromIndex)
void	stopEditing() Notified by NavigationBar to stop any edits on the current control.
protected void	stopEvents()
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	updateRow(UpdateEvent event) Notification that a row was updated in the associated iterator.
void	updateRowDeleted(DeleteEvent event) Notification that a row was deleted in the associated iterator.
void	updateRowInserted(InsertEvent event) Notification that a new row was inserted in the associated iterator.
void	updateValuesFromRow(Row row) Given a row, update the control with new attribute values from this row based on the attributes with which this binding is associated.
abstract 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.
protected boolean	useRowSpecificHints()
java.lang.Object	validateInputValue(java.lang.Object value) Return the failure exception object when this binding fails in validation.

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

addControlToPanel, 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, needsEstimatedRowCount, refreshControl, 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.jbo.StructureDef

getDefFullName, getDefName, getFullName, getName

Field Detail

mAttrs

protected AttributeDef[] mAttrs

mHasInputVal

protected boolean mHasInputVal

mInputVal

protected java.lang.Object mInputVal

SEP_LIST_DISPLAY

public static final java.lang.String SEP_LIST_DISPLAY

See Also:

Constant Field Values

ATTR_LABEL

public static final java.lang.String ATTR_LABEL

See Also:

Constant Field Values

ATTR_LABELS

public static final java.lang.String ATTR_LABELS

See Also:

Constant Field Values

ATTR_LABELSET

public static final java.lang.String ATTR_LABELSET

See Also:

Constant Field Values

ATTR_FORMAT

public static final java.lang.String ATTR_FORMAT

See Also:

Constant Field Values

ATTR_FORMATS

public static final java.lang.String ATTR_FORMATS

See Also:

Constant Field Values

ATTR_TOOLTIP

public static final java.lang.String ATTR_TOOLTIP

See Also:

Constant Field Values

ATTR_DISPLAY_HINT

public static final java.lang.String ATTR_DISPLAY_HINT

See Also:

Constant Field Values

ATTR_DISPLAY_HEIGHT

public static final java.lang.String ATTR_DISPLAY_HEIGHT

See Also:

Constant Field Values

ATTR_DISPLAY_WIDTH

public static final java.lang.String ATTR_DISPLAY_WIDTH

See Also:

Constant Field Values

ATTR_AUTOSUBMIT

public static final java.lang.String ATTR_AUTOSUBMIT

See Also:

Constant Field Values

ATTR_ATTRIBUTE

public static final java.lang.String ATTR_ATTRIBUTE

See Also:

Constant Field Values

ATTR_ATTRIBUTES

public static final java.lang.String ATTR_ATTRIBUTES

See Also:

Constant Field Values

ATTR_ATTRIBUTE_DEF

public static final java.lang.String ATTR_ATTRIBUTE_DEF

See Also:

Constant Field Values

ATTR_ATTRIBUTE_DEFS

public static final java.lang.String ATTR_ATTRIBUTE_DEFS

See Also:

Constant Field Values

ATTR_ATTRIBUTE_VALUE

public static final java.lang.String ATTR_ATTRIBUTE_VALUE

See Also:

Constant Field Values

ATTR_ATTRIBUTE_VALUES

public static final java.lang.String ATTR_ATTRIBUTE_VALUES

See Also:

Constant Field Values

ATTR_INPUT_VALUE

public static final java.lang.String ATTR_INPUT_VALUE

See Also:

Constant Field Values

ATTR_MANDATORY

public static final java.lang.String ATTR_MANDATORY

See Also:

Constant Field Values

ATTR_UPDATEABLE

public static final java.lang.String ATTR_UPDATEABLE

See Also:

Constant Field Values

ATTR_PATH

public static final java.lang.String ATTR_PATH

See Also:

Constant Field Values

ATTR_VIEWABLE

public static final java.lang.String ATTR_VIEWABLE

See Also:

Constant Field Values

DATACHANGE_EVENT_POLICY

public static final java.lang.String DATACHANGE_EVENT_POLICY

See Also:

Constant Field Values

ATTR_HINTS

public static final java.lang.String ATTR_HINTS

See Also:

Constant Field Values

GET_ALLOWS

public static final java.lang.String GET_ALLOWS

See Also:

Constant Field Values

Constructor Detail

JUCtrlValueBinding

protected JUCtrlValueBinding()

JUCtrlValueBinding

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

Method Detail

setAttributeNames

public void setAttributeNames(java.lang.String[] attrNames)

setAttributes

public void setAttributes(AttributeDef[] attrs)

setIteratorBinding

protected void setIteratorBinding(DCIteratorBinding iterBinding)

Description copied from class: DCControlBinding

Internal method, don't use.

Overrides:

setIteratorBinding in class DCControlBinding

removeAttrName

public void removeAttrName(java.lang.String sName)

initResources

protected void initResources()

Description copied from class: DCControlBinding

Invoked when the bindingContainer is being initialized for the first time or after it's locale is changed. This gives subclasses a chance to drop their initialized locale based resources.

Specified by:

initResources in class DCControlBinding

updateValuesFromRow

public void updateValuesFromRow(Row row)

Given a row, update the control with new attribute values from this row based on the attributes with which this binding is associated.

updateValuesFromRows

public abstract 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. 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.

generateDCE

protected final boolean generateDCE()

updateRangeScrolled

public void updateRangeScrolled(ScrollEvent event)

Update the control display based on whether the rows of data has scrolled.

See Also:

ScrollEvent

isPushOrPollDataChangeEvents

protected boolean isPushOrPollDataChangeEvents()

updateNavigated

public void updateNavigated(NavigationEvent event)

Update the current row display as the currency has navigated in the iterator with which this control binding is working.

createAndNotifyDCE

protected void createAndNotifyDCE(DataChangeEntry.DataChangeType type,
                                  java.lang.Object[] idvals,
                                  java.lang.String[] names)

updateRowInserted

public void updateRowInserted(InsertEvent event)

Notification that a new row was inserted in the associated iterator. Control-bindings like JTable refresh their display to show the new row on this event.

updateRowDeleted

public void updateRowDeleted(DeleteEvent event)

Notification that a row was deleted in the associated iterator. Moves the currency on the associated row iterator to the next row (or previous row if there is no next row) when the currency on the iterator was on the deleted row.

updateRow

public void updateRow(UpdateEvent event)

Notification that a row was updated in the associated iterator. Control-bindings like JTable refresh their display to show the new row on this event.

getAttributeNames

public java.lang.String[] getAttributeNames()

Return names of the attributes to which this binding is bound to and as defined in the binding definition.

getAttributeDefsForRow

public AttributeDef[] getAttributeDefsForRow(Row row)

Return Attribute definitions of the attributes to which this binding is bound to.

getAttributeDefs

public AttributeDef[] getAttributeDefs()

Return Attribute definitions of the attributes to which this binding is bound to.

Specified by:

getAttributeDefs in interface StructureDef

Returns:

an array of attribute definitions.

fetchAttrDefs

protected AttributeDef[] fetchAttrDefs(DCIteratorBinding iter)

resetAttributeDefs

protected void resetAttributeDefs()

getAttributeDef

public AttributeDef getAttributeDef(int index)

Returns attribute definition at the given index. Returns null if not found.

Specified by:

getAttributeDef in interface StructureDef

Parameters:

index - the index of an AttributeDef, where the leftmost attribute has index zero.

Returns:

an attribute definition.

getColumnNameForQuery

public java.lang.String getColumnNameForQuery(int index)

Specified by:

getColumnNameForQuery in interface StructureDef

lookupAttributeDef

public AttributeDef lookupAttributeDef(java.lang.String name)

Description copied from interface: StructureDef

Gets an attribute definition, given its name.

Specified by:

lookupAttributeDef in interface StructureDef

Parameters:

name - the name of an AttributeDef.

Returns:

an attribute definition if found, null otherwise

findAttributeDef

public AttributeDef findAttributeDef(java.lang.String name)

Description copied from interface: StructureDef

Gets an attribute definition, given its name.

Specified by:

findAttributeDef in interface StructureDef

Parameters:

name - the name of an AttributeDef.

Returns:

an attribute definition

getAttributeFromRow

public java.lang.Object getAttributeFromRow(int rowIndexInRange,
                                            int attrIndex)

Return formatted attribute value for the attribute at given index in the row at the given row index within the current range in the iterator that this binding is associated with.

getAttributeFromRow

public java.lang.Object getAttributeFromRow(int rowIndexInRange,
                                            java.lang.String name)

Return formatted attribute value for the attribute of the given name in the row at the given row index within the current range in the iterator that this binding is associated with.

getAttributeFromRow

public java.lang.Object getAttributeFromRow(Row row,
                                            AttributeDef def)

Return formatted attribute value for the attribute with the given attribute definition and in the given row.

getAttributeFromRow

public java.lang.Object getAttributeFromRow(Row row,
                                            int attrIndex)

Return the attribute value for the attribute at the given index in this control binding and from within the given row.

getAttributeFromRow

public java.lang.Object getAttributeFromRow(Row row,
                                            java.lang.String name)

Return the attribute value for the attribute of the given name from within the given row.

setAttributeInRow

public void setAttributeInRow(int rowIndexInRange,
                              int attrIndex,
                              java.lang.Object value,
                              boolean handleException)

getNullValueString

public java.lang.String getNullValueString()

setNullValueString

protected void setNullValueString(java.lang.String str)

setAttributeInRow

public void setAttributeInRow(int rowIndexInRange,
                              java.lang.String name,
                              java.lang.Object value,
                              boolean handleException)

setAttributeInRow

public void setAttributeInRow(Row row,
                              AttributeDef def,
                              java.lang.Object value)

setAttributeValuesInRow

public void setAttributeValuesInRow(Row row,
                                    AttributeDef[] defs,
                                    java.lang.Object[] values,
                                    boolean handleException)

setAttributeInRow

public void setAttributeInRow(Row row,
                              AttributeDef def,
                              java.lang.Object value,
                              boolean handleException)

getFormattedAttributeValue

public java.lang.Object getFormattedAttributeValue(java.lang.String attrName,
                                                   java.lang.Object rawValue)

setAttributeInRow

public void setAttributeInRow(Row row,
                              int attrIndex,
                              java.lang.Object value,
                              boolean handleException)

setAttributeInRow

public void setAttributeInRow(Row row,
                              java.lang.String name,
                              java.lang.Object value,
                              boolean handleException)

internalGetRow

protected Row internalGetRow()

Internal: Applications should not use this method.

getAttribute

public java.lang.Object getAttribute(int index)

Returns formatted attribute value for the attribute at the given index in this control binding's definition.

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

getAttribute

public java.lang.Object getAttribute()

Returns formatted attribute value for this binding.

getAttributes

public java.lang.Object[] getAttributes()

Returns formatted attribute values for this binding.

getAttributes

protected java.util.ArrayList getAttributes(Row row,
                                            AttributeDef[] attrs)

Returns formatted attribute values for the given set of attribute defs.

setAttribute

public void setAttribute(int index,
                         java.lang.Object value)

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

getAttributeCount

public int getAttributeCount()

Description copied from interface: StructureDef

Returns the number of defined attributes.

Specified by:

getAttributeCount in interface StructureDef

Returns:

the number of attributes.

getAttributeIndexOf

public int getAttributeIndexOf(java.lang.String name)

Description copied from interface: StructureDef

Finds the index (0-based) of the named attribute.

Specified by:

getAttributeIndexOf in interface StructureDef

Parameters:

name - the attribute's name.

Returns:

an integer in the range 0 to getAttributeCount() - 1. If the named attribute is not found, it returns -1.

getAttributeValue

public java.lang.Object getAttributeValue()

Returns unformatted attribute value of the first attribute

getAttributeValue

public java.lang.Object getAttributeValue(int j)

Returns unformatted attribute value of the first attribute

setAttributeValue

public void setAttributeValue(java.lang.Object val)

Sets the value to the first attribute in this binding. /p> For web UI bindings, note that calling this method does not guarentee that the containing BindingContainer will validate all the associated data during the validation phase of the page lifecycle. For web UI bindings, use processNewInputValue followed by setInputValue.

getAttributeValues

protected java.util.ArrayList getAttributeValues(Row row,
                                                 AttributeDef[] attrs)

Returns un-formatted (raw) attribute values.

getAttributeValueFromRow

protected java.lang.Object getAttributeValueFromRow(int rowIndexInRange,
                                                    int attrIndex)

Returns unformatted attribute value of the first attribute

getAttributeValues

public java.lang.Object[] getAttributeValues()

Returns unformatted attribute values for this binding.

getMergedAttributeValues

protected static java.lang.String getMergedAttributeValues(java.util.List al)

isAttributeMandatory

public boolean isAttributeMandatory(int index)

Returns true if the attribute at the given index is set to be mandatory.

isAttributeUpdateable

protected boolean isAttributeUpdateable(Row row,
                                        java.lang.String attrName)

isAttributeUpdateable

protected boolean isAttributeUpdateable(Row row,
                                        int index)

isAttributeUpdateable

public boolean isAttributeUpdateable(java.lang.String attrName)

Determines whether the given attribute (by name) is updateable for the current row instance. Returns true if iterator is in data mode and is the corresponding row. If iterator is in find mode, then does an additional check to determine whether the associated control is queriable.

isAttributeUpdateable

public boolean isAttributeUpdateable(int index)

Determines whether this attribute (by attribute index relative to this binding) is updateable for the current row instance. Returns true if iterator is in data mode and is the corresponding row. If iterator is in find mode, then does an additional check to determine whether the associated control is queriable.

stopEditing

public void stopEditing()

Notified by NavigationBar to stop any edits on the current control. Primarily for grid and tree to notify their cell editors to stop editing.

setArrayIteratorType

public void setArrayIteratorType()

isArrayIteratorType

public boolean isArrayIteratorType()

clearAttrDefs

protected void clearAttrDefs()

Overrides:

clearAttrDefs in class DCControlBinding

For internal use only. Application developers should not use this

*** For internal framework use only ***

release

public void release(int flags)

Overrides:

release in class DCControlBinding

removeFromDCExceptions

protected void removeFromDCExceptions()

Overrides:

removeFromDCExceptions in class DCControlBinding

getLocaleContext

public final LocaleContext getLocaleContext()

getAttributeUIHelper

protected final AttributeHints getAttributeUIHelper(java.lang.String attrName)

getLabelSet

public java.lang.String[] getLabelSet()

getLabels

public java.util.Map getLabels()

getLabel

public java.lang.String getLabel()

Retrieves the label to be used in any attribute prompts

Calling this on a control-binding that does not have an attribute will throw a NullPointerException

javabean.property

getFormats

public java.util.Map getFormats()

getFormat

public java.lang.String getFormat()

Retrieves the format to be used to format any attribute value.

getTooltip

public java.lang.String getTooltip()

Retrives the tooltip text to be used for this attribute. Calling this on a control-binding that does not have an attribute will throw a NullPointerException

javabean.property

getDisplayHint

public java.lang.String getDisplayHint()

Retrieves the display hint that dictates whether this attribute should be visible or not. The two possible values are:

• ATTRIBUTE_DISPLAY_HINT_DISPLAY = "Display";
• ATTRIBUTE_DISPLAY_HINT_HIDE = "Hide";

Calling this on a control-binding that does not have an attribute will throw a NullPointerException

getControlType

public int getControlType()

Returns the preferred control type for this attribute.

Calling this on a control-binding that does not have an attribute will throw a NullPointerException

getDisplayWidth

public int getDisplayWidth()

Returns the display width for this attribute.

Calling this on a control-binding that does not have an attribute will throw a NullPointerException

getDisplayHeight

public int getDisplayHeight()

Returns the display width for this attribute.

Calling this on a control-binding that does not have an attribute will throw a NullPointerException

isAutoSubmit

public boolean isAutoSubmit()

Returns the autoSubmit value for this attribute.

Calling this on a control-binding that does not have an attribute will throw a NullPointerException

getHint

public java.lang.String getHint(java.lang.String sHintName)

Returns the hint value based on the hint name.

Calling this on a control-binding that does not have an attribute will throw a NullPointerException

hasFormatInformation

public boolean hasFormatInformation()

Returns true if any format hints have been defined for this attribute. This function should be used to bracket any calls to the formatting API.

Calling this on a control-binding that does not have an attribute will throw a NullPointerException

displayInShortForm

public boolean displayInShortForm()

Returns true if the attribute is to displayed in the short(summary) form.

Calling this on a control-binding that does not have an attribute will throw a NullPointerException

getLabel

public java.lang.String getLabel(java.lang.String voAttrName,
                                 java.lang.String objectAttrName)

Retrieves the label to be used in any attribute prompts

getTooltip

public java.lang.String getTooltip(java.lang.String voAttrName,
                                   java.lang.String objectAttrName)

Retrives the tooltip text to be used for this attribute.

getHint

public java.lang.String getHint(java.lang.String voAttrName,
                                java.lang.String objectAttrName,
                                java.lang.String sHintName)

Returns the hint value based on the hint name.

getAttributeValidators

public final java.util.ArrayList getAttributeValidators()

getAttributeValidators

public java.util.ArrayList getAttributeValidators(int index)

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:

• attributeValue - returns getAttributeValue()
• inputValue - returns getInputValue()
• updateable - returns isUpdateable()
• mandatory - returns isMandatory()
• path - returns getPath()
• attributeValues - returns getAttributeValues()
• label - returns getLabel()
• tooltip - returns getTooltip()
• displayHint - returns getDisplayHint()
• displayHeight - returns getDisplayHeight()
• displayWidth - returns getDisplayWidth()
• autoSubmit - returns isAutoSubmit()
• attributeDef - returns getAttributeDef()
• attributeDefs - returns getAttributeDefs()
• labels - returns getLabels()
• labelSet - returns getLabelSet()
• hints - returns getHints()

• Overrides:

  internalGet in class DCControlBinding

  put

  public java.lang.Object put(java.lang.Object obj,
                              java.lang.Object value)
  

  Specified by:

  put in interface java.util.Map

  Overrides:

  put in class JboAbstractMap

  getHints

  public java.util.Map getHints()
  

  Returns a map that can resolve the custom properties on the first attribute on this binding via el like: bindings.thisBindingName.label or bindings.thisBindingName.myCustomProperty where label and myCustomProperty are control hints or custom properties defined on the attributedef that this binding is associated with.

  javabean.property

  resetInputState

  protected void resetInputState()
  

  Description copied from class: DCControlBinding

  Resets any exceptions and client-side values that this binding may hold. This is used by control-bindings to reset their state before refreshing values from the MT.

  Specified by:

  resetInputState in class DCControlBinding

  processInputException

  protected void processInputException(ValidationException vex)
  

  Overrides:

  processInputException in class DCControlBinding

  setError

  protected void setError(JboException vex,
                          java.lang.Object value)
  

  isUpdateable

  public boolean isUpdateable()
  

  Primarily for spel support. Could be removed prior to 905Prod and merged into a get() method for spel-access.

  Returns updateability of the first attribute

  javabean.property

  isMandatory

  public boolean isMandatory()
  

  Primarily for spel support. Could be removed prior to 905Prod and merged into a get() method for spel-access.

  Returns mandatory flag for the first attribute that this binding is bound to.

  javabean.property

  getAttributeDef

  public AttributeDef getAttributeDef()
  

  Primarily for spel support. Could be removed prior to 905Prod and merged into a get() method for spel-access.

  Returns Attribute definition for the first attribute

  javabean.property

  getPath

  public java.lang.String getPath()
  

  The returned path uniquely identifies this binding within a top-level bindingContainer.

  resolvePath

  public boolean resolvePath(java.util.Map postMap)
  

  Return true if this binding's path is found as a key in the given map.

  getInputValue

  public java.lang.Object getInputValue()
  

  Primarily for spel support. Could be removed prior to 905Prod and merged into a get() method for spel-access.

  Returns the last input value for the first attribute on this binding if this value raised an exception. Otherwise returns the value from the model object calling getAttribute(0);

  javabean.property

  getInputValue

  public java.lang.Object getInputValue(JUCtrlValueBinding binding,
                                        int index)
  

  Description copied from interface: JUCtrlValueHandler

  Return a custom valueHandle for inputValue.

  Specified by:

  getInputValue in interface JUCtrlValueHandler

  Parameters:

  binding - Control binding associated with the attribute.

  index - Index of the attribute in this control binding

  Returns:

  InputValue for the given control binding.

  setInputValue

  public void setInputValue(java.lang.Object value)
  

  Sets the value given and caches any error/exception in member variables for further access. Also rethrows the exception for outer methods to catch it. It is expected that this call is preceded by call to processNewInputValue which sets up the containing BindingContainer for validation phase of the web app lifecycle.

  validateInputValue

  public java.lang.Object validateInputValue(java.lang.Object value)
  

  Return the failure exception object when this binding fails in validation. On success return null.

  setInputValue

  public void setInputValue(JUCtrlValueBinding binding,
                            int index,
                            java.lang.Object value)
  

  Description copied from interface: JUCtrlInputValueHandler

  Implement value specific handling of the inputValue. For Example Intermedia domains know how to update their data based on a file url or Struts FileHandle as input value. JUCtrlValueBinding provides the base domain object (or null in which case it also provides access to the AttributeDef that contains the domain/value type). Custom implementation for the Intermedia domain may then update some fields on the domain instead of the entire domain Object.

  Specified by:

  setInputValue in interface JUCtrlInputValueHandler

  Parameters:

  binding - Control binding that is associated to the attribute to be updated.

  index - Index of the attribute in this control binding to update with the given Input Value. Note that for most single attribute control like TextFields, this value should be 0.

  setInputValueInRow

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

  getInputValueInRow

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

  processNewInputValue

  public boolean processNewInputValue(java.lang.Object value)
  

  Returns true, if the caller needs to call setInputValue() on this binding to update the current attribute value that this binding is set to.

  If the value is different than the attribute value, or if this binding had cached an error in a pervious setInputValue, then this method returns true.

  isNewInputValue

  public boolean isNewInputValue(JUCtrlValueBinding binding,
                                 int index,
                                 java.lang.Object value)
  

  Returns true, if the caller needs to call setInputValue() on this binding to update the current attribute value that this binding is set to.

  If the value is different than the attribute value, or if this binding had cached an error in a pervious setInputValue, then this method returns true.

  Specified by:

  isNewInputValue in interface JUCtrlInputValueHandler

  getError

  public JboException getError()
  

  Primarily for spel support.

  Returns exception that occured on last setInputValue

  Overrides:

  getError in class DCControlBinding

  javabean.property

  getErrors

  public java.util.List getErrors()
  

  Primarily for spel support.

  Returns exceptions that occured on last setInputValue

  Overrides:

  getErrors in class DCControlBinding

  getInputErrorsForRowKey

  protected java.util.List getInputErrorsForRowKey(Key key)
  

  hasServerBindingChanged

  protected boolean hasServerBindingChanged()
  

  compareAndSetAttribute

  public void compareAndSetAttribute(int index,
                                     java.lang.Object cVal)
  

  Advanced method. Compares the value from the value for an attribute at the given index as stored by the data that this binding is bound to and if the value is different, then sets it on the bound attribute at the given index.

  getInputValueHandler

  public final JUCtrlInputValueHandler getInputValueHandler()
  

  Return the input handler that this binding uses for setInputValue. By default this binding itself is the input handler. This handler may be customized by providing a custom inputhandler class name in the definition for this binding (declaritvely at designtime) or by setting it programmatically using the setInptuValueHandler method.

  setInputValueHandler

  public void setInputValueHandler(JUCtrlInputValueHandler hdlr)
  

  hasVariables

  public final boolean hasVariables()
  

  ensureVariableManager

  public final VariableValueManager ensureVariableManager()
  

  internalHasPermission

  protected boolean internalHasPermission(java.lang.String actions)
  

  Overrides:

  internalHasPermission in class DCControlBinding

  internalHasPermission

  protected boolean internalHasPermission(java.lang.String target,
                                          java.lang.String actions)
  

  Overrides:

  internalHasPermission in class DCControlBinding

  getPermissionInfo

  public PermissionInfo getPermissionInfo()
  

  Overrides:

  getPermissionInfo in class DCControlBinding

  isViewable

  public final boolean isViewable()
  

  getPermissionHolder

  protected oracle.adf.share.security.PermissionHolder getPermissionHolder(java.lang.String name)
  

  getPermissionDef

  protected DCPermissionDef getPermissionDef(java.lang.String name)
  

  setEventsCaching

  protected void setEventsCaching(boolean flag)
  

  Deprecated. since 11.1.1.1.2

  Internal: Applications should not use this method. Disables or enables the event cache. Event cache is currently maintained at the iterator binding level. Disabling the event cache will also disable event caching on other control bindings under the same iterator binding. Similarly, enabling the event cache will also Enable event caching on other control bindings under the same iterator binding.

  Parameters:

  flag - true to enable event caching, false to disable.

  For internal use only. Application developers should not use this

  isEventsCachingEnabled

  protected boolean isEventsCachingEnabled()
  

  Deprecated. since 11.1.1.1.2

  Internal: Applications should not use this method. Checks whether the event cache is enabled.

  Returns:

  true if the event cache is enabled. false otherwise.

  For internal use only. Application developers should not use this

  getCachedEvents

  protected java.util.List getCachedEvents()
  

  Deprecated. since 11.1.1.1.2

  Internal: Applications should not use this method.

  For internal use only. Application developers should not use this

  clearEventsCache

  protected void clearEventsCache()
  

  Deprecated. since 11.1.1.1.2

  Internal: Applications should not use this method.

  For internal use only. Application developers should not use this

  setListener

  public void setListener(UpdateListener listener)
  

  Overrides:

  setListener in class DCControlBinding

  getIteratorBindingForDCE

  protected JUIteratorBinding getIteratorBindingForDCE()
  

  addDataChangeListener

  public void addDataChangeListener(DataChangeListener listener)
  

  removeDataChangeListener

  public void removeDataChangeListener(DataChangeListener listener)
  

  getDataChangeListener

  protected DataChangeListener getDataChangeListener()
  

  notifyDataExceptionEvent

  protected void notifyDataExceptionEvent(DataExceptionEvent event)
  

  notifyDCE

  protected void notifyDCE(DataChangeEvent event)
  

  Deprecated. ...use notifyDataChangeEvent.

  notifyDataChangeEvent

  protected void notifyDataChangeEvent(DataChangeEvent event)
  

  setDef

  protected void setDef(DCControlBindingDef controlDef)
  

  Overrides:

  setDef in class DCControlBinding

  For internal use only. Application developers should not use this

  *** For internal framework use only ***

  addBindingContainerChangeListenerForCtxEvent

  public void addBindingContainerChangeListenerForCtxEvent()
  

  Creates new instance of BindingContainerChangeAdapterForCtxEvent and calls getBindingContainer().addBindingContainerChangeListenerForCtxEvent.

  getAttrViewExpressions

  protected java.lang.String[] getAttrViewExpressions()
  

  setAttrViewExpressions

  protected void setAttrViewExpressions(java.lang.String[] stra)
  

  For internal use only. Application developers should not use this

  *** For internal framework use only ***

  getSelectionDef

  protected oracle.jbo.uicli.binding.JUCtrlSelectionDef getSelectionDef()
  

  pinDataControl

  protected void pinDataControl(boolean flag)
  

  Advanced for ADS usage only.

  startEvents

  protected int startEvents(int fromIndex)
  

  For internal use only. Application developers should not use this

  *** For internal framework use in ADS only ***

  stopEvents

  protected void stopEvents()
  

  getLastEventId

  protected int getLastEventId()
  

  For internal use only. Application developers should not use this

  *** For internal framework use in ADS only ***

  getDataChangeEventPolicy

  public DataControl.DataChangeEventPolicy getDataChangeEventPolicy()
  

  For internal use only. Application developers should not use this

  *** For internal framework use in ADS only ***

  isNullInsertKeyPathForDCE

  public final boolean isNullInsertKeyPathForDCE(DataChangeEntry en)
  

  *** For internal framework use only *** If this insert event is for data that need to be inserted before or after a known data point in the same hierarchy/level, then return false. Otherwise return true. Check if the first entry in the insertKey path is null if so, datacontrol is implying that this insert event is for data that can be inserted at the beginning or end of the collection at that level (based on data change type).

  getMasterKeyPathForDCE

  public final java.lang.Object[] getMasterKeyPathForDCE(DataChangeEntry en)
  

  *** For internal framework use only *** Returns an array of all elements except the first one from KeyPath. Returns null if the KeyPath is null or KeyPath has only one element.

  getChangeEventPolicy

  protected DataControl.DataChangeEventPolicy getChangeEventPolicy()
  

  getIteratorRenderHint

  protected DCIteratorBinding.RenderHintTypes getIteratorRenderHint()
  

  To be used by view-technology specific bindings to determine if the associated iterator binding may be rendered in a secondary thread or not. The default is DCIteratorBinding.RenderHintTypes.immediate to indicate that the data for this binding should be fetched and rendered when the page is rendered. A user may choose to mark the iteratorBinding's hint to background to indicate that the iteratorBinding's data may be fetched lazily during the secondary render threads.

  useRowSpecificHints

  protected boolean useRowSpecificHints()
  

  getBindingHint

  protected java.lang.Object getBindingHint(java.lang.String key,
                                            LocaleContext lCtx)
  

  Subclasses to override to provide custom impl. of a binding hint name lookup.

  getState

  public java.lang.Object getState()
  

  Description copied from class: DCControlBinding

  In the process of re-creating a binding container. Each control binding wil be asked if it has a state object that should be saved and passed in during the re-create of the binding. This state object is opaque, only the binding will interpret the contents.

  Overrides:

  getState in class DCControlBinding

  Returns:

  For internal use only. Application developers should not use this

  restoreFromState

  public void restoreFromState(java.lang.Object state)
  

  Description copied from class: DCControlBinding

  Initialize binding instance with value from state object

  Overrides:

  restoreFromState in class DCControlBinding

  Parameters:

  state -

  For internal use only. Application developers should not use this

  getEventProducer

  public EventProducer getEventProducer()
  

  getEventProducer returns the EventProducer

  hasEventProducer

  protected boolean hasEventProducer()
  

  setEventProducer

  protected void setEventProducer(EventProducer producer)
  

  createEventProducer

  protected void createEventProducer()
  

  createEventProducer creates new instance of JUCtrlValueEventProducer is not exists