oracle.jbo.uicli.jui
Class JUComboBoxBinding

java.lang.Object
  java.util.AbstractMap
      oracle.jbo.common.JboAbstractMap
          oracle.adf.model.binding.DCControlBinding
              oracle.jbo.uicli.binding.JUControlBinding
                  oracle.jbo.uicli.binding.JUCtrlValueBinding
                      oracle.jbo.uicli.binding.JUCtrlAttrsBinding
                          oracle.jbo.uicli.binding.JUCtrlListBinding
                              oracle.jbo.uicli.jui.JUComboBoxBinding

All Implemented Interfaces:

java.awt.event.ActionListener, javax.swing.ComboBoxModel, java.util.EventListener, JUCtrlInputValueHandler, javax.swing.ListModel, java.util.Map, javax.swing.MutableComboBoxModel, RowNavigationListener, RowSetListener, RowSetManagementListener, StructureDef

public class JUComboBoxBinding

extends JUCtrlListBinding

implements java.awt.event.ActionListener, javax.swing.MutableComboBoxModel

Implements binding a Swing JComboBox to a BC4J Attribute or ViewObject or as an LOV (list of values).

A combobox can be bound in the following ways:

• Display single or multiple attributes for rows in a RowSet and iterate the rowset currency.
• Display single attribute from rows in a RowSet and update another attribute in a different ViewObject.
• Display single or multiple attributes from rows in a RowSet and update one or multiple attributes in a different ViewObject (similar to an LOV).
• Display a static LOV and update one attribute in a BC4J row.

This class also implements ActionListener interface and listens to ActionEvents from the bound combobox. On an action event, it either performs an update of the target ViewObject attributes, or iterates a target ViewObject as per the list operation mode set in the constructor.

Nested Class Summary

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

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

DH_CONTROL_TYPE, DH_DISPLAY_HEIGHT, DH_DISPLAY_HINT, DH_DISPLAY_WIDTH, DH_FORMAT, DH_LABEL, DH_TOOLTIP, LIST_OPER_NAVIGATE, LIST_OPER_SET_ATTRIBUTE, LISTITEM_DisplayValues, LISTITEM_Index, LISTITEM_Prompt, LISTITEM_Selected, LISTITEM_SelectedIndex, mFirstDisplayAttr, mListAttrNames, mListDisplayAttrNames, mListIterBinding, mSingleAttrList, mStaticList, mValueList

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

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

Fields inherited from class oracle.adf.model.binding.DCControlBinding

ATTR_CURRENTROW, ATTR_DEF, ATTR_ERROR, ATTR_ERRORS, ATTR_FULLNAME, ATTR_ITER, ATTR_NAME, mInternalGet_KeyResolved, ROW_KEY_STR

Constructor Summary

JUComboBoxBinding(javax.swing.JComboBox cb, JUIteratorBinding iterBinding, java.lang.String[] attrNames, int listOperMode)
Binds a ComboBox to a RowSet associated with the given iterator binding and based on listOperMode setting, either iterates the currency on the target iterator or updates the attribute value for the given attribute (in attrNames) in the current row in the target RowSet.

JUComboBoxBinding(javax.swing.JComboBox cb, JUIteratorBinding iterBinding, java.lang.String[] attrNames, JUIteratorBinding listIterBinding, java.lang.String[] listAttrNames, java.lang.String[] listDisplayAttrNames)
Binds separate ViewObject/RowSets for display and update to the same ComboBox.

JUComboBoxBinding(javax.swing.JComboBox cb, JUIteratorBinding iterBinding, java.lang.String[] attrNames, java.lang.Object[] valueList)
Binds a combobox to an attribute in the associated RowSet.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Based on listOperMode, this binding either navigates the target rowset to the selected row or sets the attribute/attributes as based on the settings in the constructor.
void	addControlToPanel(java.lang.Object panel, java.lang.Object layoutObject, java.lang.Object layoutCons) *** For internal framework use only ***
void	addElement(java.lang.Object obj)
void	addListDataListener(javax.swing.event.ListDataListener l)
static javax.swing.MutableComboBoxModel	createEnumerationBinding(JUFormBinding formBinding, javax.swing.JComboBox control, java.lang.String voInstanceName, java.lang.String voIterName, java.lang.String voIterBindingName, java.lang.String attrName, java.lang.Object[] values) Use this method to bind a combobox control to a ViewObject/RowSet identified by voInstanceName when a static list of values are displayed in the combobox, and the combobox is used to display/update the same attribute in the same viewobject.
static javax.swing.MutableComboBoxModel	createLovBinding(JUFormBinding formBinding, javax.swing.JComboBox control, java.lang.String voInstanceName, java.lang.String voIterName, java.lang.String voIterBindingName, java.lang.String[] voAttrNames, java.lang.String lovVOInstanceName, java.lang.String[] lovVOAttrNames, java.lang.String[] lovVODisplayedAttrNames, javax.swing.ListCellRenderer cellRenderer, javax.swing.ComboBoxEditor editor) Use this binding when two ViewObjects are to be used in this combobox: one for displaying the list of values and the other ViewObject the rows of which are updated.
static javax.swing.MutableComboBoxModel	createNavigationBinding(JUFormBinding formBinding, javax.swing.JComboBox control, java.lang.String voInstanceName, java.lang.String voIterName, java.lang.String voIterBindingName, java.lang.String[] voAttrNames, javax.swing.ListCellRenderer cellRenderer, javax.swing.ComboBoxEditor editor) Use this binding when the given combobox is used as a navigation control to iterate through a range or rows in a RowSet.
java.lang.Object	getControlModel(java.lang.Object control) Gets the associated View's model object.
java.lang.Object	getElementAt(int index)
static javax.swing.MutableComboBoxModel	getInstance(JUFormBinding formBinding, javax.swing.JComboBox control, java.lang.String voInstanceName, java.lang.String voIterName, java.lang.String voIterBindingName, java.lang.String[] voAttrNames, java.lang.String lovVOInstanceName, java.lang.String[] lovVOAttrNames, java.lang.String[] lovVODisplayedAttrNames, javax.swing.ListCellRenderer cellRenderer, javax.swing.ComboBoxEditor editor) Deprecated. since 9.0.2 use createEnumerationBinding, createNavigationBinding or createLovBinding instead
static javax.swing.MutableComboBoxModel	getInstance(JUFormBinding formBinding, javax.swing.JComboBox control, java.lang.String voInstanceName, java.lang.String voIterName, java.lang.String voIterBindingName, java.lang.String attrName, java.lang.Object[] values) Deprecated. since 9.0.2 use createEnumerationBinding, createNavigationBinding or createLovBinding instead
protected javax.swing.MutableComboBoxModel	getModelImpl(javax.swing.JComboBox control) Sets the model reference in this binding class by using the current model in the combobox.
java.lang.Object	getSelectedItem()
int	getSize()
java.lang.Object	getValueAt(int attrIndex) Returns the currently selected item from the list model.
void	insertElementAt(java.lang.Object obj, int index)
protected boolean	isControlQueriable() Returns true, so that JTextComponents can participate in a query in the Find Mode of the containing panel.
protected boolean	isViewInitialized()
void	refreshControl() *** For internal framework use only ***
void	removeElement(java.lang.Object obj)
void	removeElementAt(int index)
void	removeListDataListener(javax.swing.event.ListDataListener l)
void	setDataValueAt(java.lang.Object value, int attrIndex) Should be used by applications to update both the combobox selection and the correpsonding attributes in the current row of the target viewobject.
void	setSelectedIndex(int listIndex) Sets the item at the given index as current selection in the listbox.
void	setSelectedItem(java.lang.Object anItem)
protected void	setupListItems(boolean clean, boolean keepSelectedIndex) This method is used by the framwork to setup the list of values (LOV) that will be displayed in this combobox.
void	setValueAt(java.lang.Object value, int attrIndex) Finds the item in the combobox that matches the given value and sets it as the current item.
protected void	updateTargetFromSelectedValue(java.lang.Object val)

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

convertValueList, findListIndex, findMatchingListValue, findValue, getDisplayAttributeDefs, getDisplayData, getDisplayHints, getDisplayListIterator, getInputValue, getListDisplayAttrNames, getListIterBinding, getListOperMode, getSelectedIndex, getSelectedIndexValue, getSelectedValue, getValueFromList, getValueList, internalGet, isSingleAttrList, iteratorClosed, iteratorReset, matchTargetWithLov, navigated, processNewInputValue, put, rangeRefreshed, rangeScrolled, release, rowDeleted, rowInserted, rowUpdated, setAttributeFromValueList, setInputValue, setListOperMode, setListValueAsSelected, setSelectedIndexValue, setSingleAttrList, setStaticList, setTargetAttrsFromLovRow, setValueList, toString, updateValuesFromRow

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

createAttributeBinding, setControlEnabled, updateNavigated, updateRangeScrolled, updateValuesFromRows

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

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

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

getFormBinding, getIteratorBinding, reportException, setFormBinding

Methods inherited from class oracle.adf.model.binding.DCControlBinding

addToDCExceptions, executeQuery, executeQueryIfNeeded, get, getAllRowsInRange, getApplicationModule, getBindingContainer, getControl, getCurrentRow, getDCIteratorBinding, getDef, getDefFullName, getDefName, getFullName, getLayoutObject, getName, getRowAtRangeIndex, getRowIterator, getTransaction, getViewObject, hashCode, internalSetName, needsEstimatedRowCount, removeFromDCExceptions, reportException, resetAttributeExceptionInRow, setBindingContainer, setControl, setName

Methods inherited from class oracle.jbo.common.JboAbstractMap

entrySet, equals

Methods inherited from class java.util.AbstractMap

clear, clone, containsKey, containsValue, isEmpty, keySet, putAll, remove, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.jbo.StructureDef

getDefFullName, getDefName, getFullName, getName

Constructor Detail

JUComboBoxBinding

public JUComboBoxBinding(javax.swing.JComboBox cb,
                         JUIteratorBinding iterBinding,
                         java.lang.String[] attrNames,
                         int listOperMode)

Binds a ComboBox to a RowSet associated with the given iterator binding and based on listOperMode setting, either iterates the currency on the target iterator or updates the attribute value for the given attribute (in attrNames) in the current row in the target RowSet. Note that the combobox will display and (optionally)update the same attribute from a RowSet.

Parameters:

cb - ComboBox with which to associate this binding.

iterBinding - Provides the RowSet from which this binding accesses data to display in the combobox and optionally the current row for which attribute(s) are to be updated.

attrNames - An ordered array of attribute names to display and optionally update in a ViewObject.

listOperMode - Can be one of two values:

• LIST_OPER_SET_ATTRIBUTE (the default) to indicate that this combobox is to be used to update attributes in the current row of the associated RowSet.
• LIST_OPER_NAVIGATE to indicate that this combobox should be used to iterate currency in the associated RowSet.

JUComboBoxBinding

public JUComboBoxBinding(javax.swing.JComboBox cb,
                         JUIteratorBinding iterBinding,
                         java.lang.String[] attrNames,
                         java.lang.Object[] valueList)

Binds a combobox to an attribute in the associated RowSet. The values displayed in combobox are provided by the valueList objects.

Parameters:

cb - ComboBox with which to associate this binding.

iterBinding - Provides the RowSet that is used to update current selection from the combobox into the current row in the rowset.

attrNames - Provides the name of an attribute (only one attribute is updateable in this mode).

valueList - A static list of values displayed as options in the combobox from which to select.

JUComboBoxBinding

public JUComboBoxBinding(javax.swing.JComboBox cb,
                         JUIteratorBinding iterBinding,
                         java.lang.String[] attrNames,
                         JUIteratorBinding listIterBinding,
                         java.lang.String[] listAttrNames,
                         java.lang.String[] listDisplayAttrNames)

Binds separate ViewObject/RowSets for display and update to the same ComboBox. Use this binding constructor to provide a separate iterator binding for update and a separate iterator binding which provides rows for display in the combobox. Optionally, the attributes displayed can be different from the attributes that should be used to update a corresponding set of attributes in the target/updateable ViewObject.

Parameters:

cb - ComboBox to associate this binding with.

iterBinding - Provides the RowSet in which the current row is updated based on selection in the combobox.

attrNames - An ordered array of attribute names to update in a ViewObject. This list should have the same number of attributes as in listAttrNames, which provides the corresponding attribute names from the display ViewObject/RowSet.

listIterBinding - Provides the RowSet which is used to display data in the combobox.

listAttrNames - An ordered list of attribute names, which are used to get the values to update into the attributes from the attrNames list in the target ViewObject. If this list is null, then the attribute names for display are set the same as attrNames.

listDisplayAttrNames - An ordered list of attribute names that specify the attributes to display from rows in the display ViewObject/RowSet. If this list is null, then attribute names are assumed to be same as in attrNames.

Method Detail

getModelImpl

protected javax.swing.MutableComboBoxModel getModelImpl(javax.swing.JComboBox control)

Sets the model reference in this binding class by using the current model in the combobox. Returns the same model reference. If there is no model in the combobox, creates a DefaultComboBoxModel and returns that.

addControlToPanel

public void addControlToPanel(java.lang.Object panel,
                              java.lang.Object layoutObject,
                              java.lang.Object layoutCons)

*** For internal framework use only ***

Overrides:

addControlToPanel in class JUCtrlListBinding

isViewInitialized

protected boolean isViewInitialized()

Overrides:

isViewInitialized in class JUCtrlListBinding

setupListItems

protected void setupListItems(boolean clean,
                              boolean keepSelectedIndex)

This method is used by the framwork to setup the list of values (LOV) that will be displayed in this combobox.

Overrides:

setupListItems in class JUCtrlListBinding

Parameters:

clean - Controls whether to clean the existing entries in the combobox.

keepSelectedIndex - Controls whether to maintain current index as the selected index after the display data is updated. If this value is true, the current index is maintained. However if the current index is more than the number of items in the combobox, then the selection is reset to the first item.

getValueAt

public java.lang.Object getValueAt(int attrIndex)

Returns the currently selected item from the list model. This is used by the framework to update the values into the target rowset.

Overrides:

getValueAt in class JUCtrlListBinding

Parameters:

attrIndex - This argument is ignored by this method.

setValueAt

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

Finds the item in the combobox that matches the given value and sets it as the current item.

Overrides:

setValueAt in class JUCtrlListBinding

Parameters:

value - This value is used in findMatchingListValue method to find out the item in the combobox that represents the given value. If the value is not found, then no item is selected in the list.

attrIndex - This argument is ignored by this method.

setDataValueAt

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

Should be used by applications to update both the combobox selection and the correpsonding attributes in the current row of the target viewobject.

Overrides:

setDataValueAt in class JUCtrlListBinding

Parameters:

value - This value is used in findMatchingListValue method to find out the item in the combobox that represents the given value. If the value is not found, then no item is selected in the list.

attrIndex - This argument is ignored by this method.

setSelectedIndex

public void setSelectedIndex(int listIndex)

Sets the item at the given index as current selection in the listbox.

Overrides:

setSelectedIndex in class JUCtrlListBinding

isControlQueriable

protected boolean isControlQueriable()

Returns true, so that JTextComponents can participate in a query in the Find Mode of the containing panel. When the containing panel Binding object is set to Find mode, it queries all control-bindings in it and disables those controls whose bindings return false for this method during the Find mode. The return value from this method indicates whether to consult an attribute definition for queriability.

An application could create a subclass of this binding object and return false from this method to prevent the associated control from participating in find mode. Additionally, a BC4J attribute itself can control whether that attribute can participate in Query or not. That property takes precedence over this method's return, if this method returns true. In other words, if this binding is bound to a CLOB attribute type and the attribute definition for that attribute indicates that it is not queriable, then the default behavior of JUPanelBinding in Find mode will be to disable this binding's control, even though this method returns true.

Overrides:

isControlQueriable in class JUCtrlListBinding

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Based on listOperMode, this binding either navigates the target rowset to the selected row or sets the attribute/attributes as based on the settings in the constructor.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

updateTargetFromSelectedValue

protected void updateTargetFromSelectedValue(java.lang.Object val)

Overrides:

updateTargetFromSelectedValue in class JUCtrlListBinding

setSelectedItem

public void setSelectedItem(java.lang.Object anItem)

Specified by:

setSelectedItem in interface javax.swing.ComboBoxModel

getSelectedItem

public java.lang.Object getSelectedItem()

Specified by:

getSelectedItem in interface javax.swing.ComboBoxModel

getSize

public int getSize()

Specified by:

getSize in interface javax.swing.ListModel

getElementAt

public java.lang.Object getElementAt(int index)

Specified by:

getElementAt in interface javax.swing.ListModel

addListDataListener

public void addListDataListener(javax.swing.event.ListDataListener l)

Specified by:

addListDataListener in interface javax.swing.ListModel

removeListDataListener

public void removeListDataListener(javax.swing.event.ListDataListener l)

Specified by:

removeListDataListener in interface javax.swing.ListModel

addElement

public void addElement(java.lang.Object obj)

Specified by:

addElement in interface javax.swing.MutableComboBoxModel

removeElement

public void removeElement(java.lang.Object obj)

Specified by:

removeElement in interface javax.swing.MutableComboBoxModel

insertElementAt

public void insertElementAt(java.lang.Object obj,
                            int index)

Specified by:

insertElementAt in interface javax.swing.MutableComboBoxModel

removeElementAt

public void removeElementAt(int index)

Specified by:

removeElementAt in interface javax.swing.MutableComboBoxModel

getControlModel

public java.lang.Object getControlModel(java.lang.Object control)

Gets the associated View's model object.

Overrides:

getControlModel in class DCControlBinding

refreshControl

public void refreshControl()

Description copied from class: JUCtrlAttrsBinding

*** For internal framework use only ***

Updates the values in a control that is bound using an Iterator already in use. (a valid row iterator) If you do not call this method, your control won't update unless you refresh the Iterator.

Overrides:

refreshControl in class JUCtrlAttrsBinding

createEnumerationBinding

public static javax.swing.MutableComboBoxModel createEnumerationBinding(JUFormBinding formBinding,
                                                                        javax.swing.JComboBox control,
                                                                        java.lang.String voInstanceName,
                                                                        java.lang.String voIterName,
                                                                        java.lang.String voIterBindingName,
                                                                        java.lang.String attrName,
                                                                        java.lang.Object[] values)

Use this method to bind a combobox control to a ViewObject/RowSet identified by voInstanceName when a static list of values are displayed in the combobox, and the combobox is used to display/update the same attribute in the same viewobject.

getInstance

public static javax.swing.MutableComboBoxModel getInstance(JUFormBinding formBinding,
                                                           javax.swing.JComboBox control,
                                                           java.lang.String voInstanceName,
                                                           java.lang.String voIterName,
                                                           java.lang.String voIterBindingName,
                                                           java.lang.String attrName,
                                                           java.lang.Object[] values)

Deprecated. since 9.0.2 use createEnumerationBinding, createNavigationBinding or createLovBinding instead

createLovBinding

public static javax.swing.MutableComboBoxModel createLovBinding(JUFormBinding formBinding,
                                                                javax.swing.JComboBox control,
                                                                java.lang.String voInstanceName,
                                                                java.lang.String voIterName,
                                                                java.lang.String voIterBindingName,
                                                                java.lang.String[] voAttrNames,
                                                                java.lang.String lovVOInstanceName,
                                                                java.lang.String[] lovVOAttrNames,
                                                                java.lang.String[] lovVODisplayedAttrNames,
                                                                javax.swing.ListCellRenderer cellRenderer,
                                                                javax.swing.ComboBoxEditor editor)

Use this binding when two ViewObjects are to be used in this combobox: one for displaying the list of values and the other ViewObject the rows of which are updated. Optionally, a UI can provide a cell renderer for the list and a editor which can be used to implement ComboBox customization. By default, if this binding method creates an instance of JUMultiAttrListCellRenderer and JUMultiAttrListCellEditor to display and edit LOVs.

createNavigationBinding

public static javax.swing.MutableComboBoxModel createNavigationBinding(JUFormBinding formBinding,
                                                                       javax.swing.JComboBox control,
                                                                       java.lang.String voInstanceName,
                                                                       java.lang.String voIterName,
                                                                       java.lang.String voIterBindingName,
                                                                       java.lang.String[] voAttrNames,
                                                                       javax.swing.ListCellRenderer cellRenderer,
                                                                       javax.swing.ComboBoxEditor editor)

Use this binding when the given combobox is used as a navigation control to iterate through a range or rows in a RowSet. Optionally, a UI can provide a cell renderer for the list and an editor which can be used to implement ComboBox customization. By default, if this binding method creates an instance of JUMultiAttrListCellRenderer and JUMultiAttrListCellEditor to display and edit LOVs.

getInstance

public static javax.swing.MutableComboBoxModel getInstance(JUFormBinding formBinding,
                                                           javax.swing.JComboBox control,
                                                           java.lang.String voInstanceName,
                                                           java.lang.String voIterName,
                                                           java.lang.String voIterBindingName,
                                                           java.lang.String[] voAttrNames,
                                                           java.lang.String lovVOInstanceName,
                                                           java.lang.String[] lovVOAttrNames,
                                                           java.lang.String[] lovVODisplayedAttrNames,
                                                           javax.swing.ListCellRenderer cellRenderer,
                                                           javax.swing.ComboBoxEditor editor)

Deprecated. since 9.0.2 use createEnumerationBinding, createNavigationBinding or createLovBinding instead