oracle.jbo.uicli.jui
Class JULovButtonBinding

java.lang.Object
  |
  +--oracle.jbo.uicli.binding.JUControlBinding
        |
        +--oracle.jbo.uicli.binding.JUCtrlValueBinding
              |
              +--oracle.jbo.uicli.binding.JUCtrlAttrsBinding
                    |
                    +--oracle.jbo.uicli.binding.JUCtrlListBinding
                          |
                          +--oracle.jbo.uicli.jui.JULovButtonBinding

All Implemented Interfaces:

java.awt.event.ActionListener, AttributeList, javax.swing.ButtonModel, java.util.EventListener, java.awt.ItemSelectable, RowNavigationListener, RowSetListener

public class JULovButtonBinding

extends JUCtrlListBinding

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

Binds a JButton with an iterator such that on button action, an LOV dialog (either a framework default dialog or an application-specific one) is displayed; upon the dialog close, the current row from the associated iterator is used to update values of bound attributes in a target row of a target RowIterator. This behavior is similar to JUComboBoxBinding or JUListSingleSelBinding in their LOV Mode. This kind of control/binding is used when the LOV row count is large enough to make navigation in a ListBox or ComboBox difficult. Also this binding allows easier application customization as the display of LOV data is completely delegated to the LOV dialog/LOV panel.

See Also:

JUComboBoxBinding, JUListSingleSelBinding

Field Summary

protected java.lang.String[]	mLovAttrs Attribute names that are being displayed by this LOV.
protected JULovPanelInterface	mLovPanel Panel that displays LOV data.
protected RowSetIterator	mLovRSI RowSet which contains data that is to be displayed in the LOV.

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

LIST_OPER_NAVIGATE, LIST_OPER_SET_ATTRIBUTE, mFirstDisplayAttr, mListAttrNames, mListDisplayAttrNames, mListIterBinding, mSingleAttrList, mStaticList, mValueList

Constructor Summary

JULovButtonBinding(java.lang.Object control, JUIteratorBinding iterBinding, java.lang.String[] targetAttrs, RowSetIterator lovRsi, java.lang.String[] lovVOAttrNames, java.lang.String[] lovVODisplayedAttrNames)

JULovButtonBinding(java.lang.Object control, JUIteratorBinding iterBinding, java.lang.String[] targetAttrs, RowSetIterator lovRsi, java.lang.String[] listAttrNames, java.lang.String[] lovVODisplayedAttrNames, boolean searchability, java.lang.String title, java.awt.Point location)

JULovButtonBinding(java.lang.Object control, JUIteratorBinding iterBinding, java.lang.String[] targetAttrs, RowSetIterator lovRsi, java.lang.String[] listAttrNames, java.lang.String[] lovVODisplayedAttrNames, JULovPanelInterface lovPanel)

Method Summary

void	actionPerformed(java.awt.event.ActionEvent evt)
void	addActionListener(java.awt.event.ActionListener l)
void	addChangeListener(javax.swing.event.ChangeListener l)
void	addControlToPanel(java.lang.Object panel, java.lang.Object layoutObject, java.lang.Object layoutCons) *** For internal framework use only ***
void	addItemListener(java.awt.event.ItemListener l)
static javax.swing.ButtonModel	createLovBinding(JUFormBinding formBinding, javax.swing.AbstractButton 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) This method should be used to create a JULovButtonBinding and bind it to a JButton control.
static javax.swing.ButtonModel	createLovBinding(JUFormBinding formBinding, javax.swing.AbstractButton control, java.lang.String voInstanceName, java.lang.String voIterName, java.lang.String voIterBindingName, java.lang.String[] voAttrNames, java.lang.String lovVOInstanceName, java.lang.String lovVOIterName, java.lang.String lovVOIterBindingName, java.lang.String[] lovVOAttrNames, java.lang.String[] lovVODisplayedAttrNames, boolean searchability, java.lang.String title, java.awt.Point location) This method should be used to create a JULovButtonBinding and bind it to a JButton control.
static javax.swing.ButtonModel	createLovBinding(JUFormBinding formBinding, javax.swing.AbstractButton control, java.lang.String voInstanceName, java.lang.String voIterName, java.lang.String voIterBindingName, java.lang.String[] voAttrNames, java.lang.String lovVOInstanceName, java.lang.String lovVOIterName, java.lang.String lovVOIterBindingName, java.lang.String[] lovVOAttrNames, java.lang.String[] lovVODisplayedAttrNames, JULovPanelInterface lovPanel) This method should be used to create a JULovButtonBinding and bind it to a JButton control.
java.lang.String	getActionCommand()
static javax.swing.ButtonModel	getInstance(JUFormBinding formBinding, javax.swing.AbstractButton 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) Deprecated. since 9.0.2 use createLovBinding()
JULovPanelInterface	getLovPanelInterface()
RowSetIterator	getLOVRowSetIterator() Returns the RowSet Iterator used to display LOV data.
int	getMnemonic()
protected javax.swing.ButtonModel	getModelImpl(java.lang.Object control) *** For internal framework use only ***
java.lang.Object[]	getSelectedObjects()
java.lang.Object	getValueAt(int attrIndex) Gets the value from the control for the attribute at the given index.
boolean	isArmed()
boolean	isEnabled()
boolean	isNavigationMode()
boolean	isPressed()
boolean	isRollover()
boolean	isSelected()
void	performLOVAction() This method is invoked when action is to be performed on the associated button.
void	removeActionListener(java.awt.event.ActionListener l)
void	removeChangeListener(javax.swing.event.ChangeListener l)
void	removeItemListener(java.awt.event.ItemListener l)
void	setActionCommand(java.lang.String s)
void	setArmed(boolean b)
void	setDataValueAt(java.lang.Object value, int attrIndex)
void	setEnabled(boolean b)
void	setGroup(javax.swing.ButtonGroup group)
void	setHelpAction(java.awt.event.ActionListener al) If the default LOV dialog is being used to display LOV Data, this method should be used by applications to set the ActionListener that is triggered on activating the help button in the LOV Dialog.
void	setMnemonic(int key)
void	setNavigationMode(boolean flag)
void	setPressed(boolean b)
void	setRollover(boolean b)
void	setSelected(boolean b)
protected void	setupListItems(boolean clean, boolean keepSelectedIndex) If this list is displaying a single attribute and updates a single attribute, then this method fetches the attribute value from all the rows in the given LOV list iterator and sets that as the list of values to display in the bound control.
void	setValueAt(java.lang.Object value, int attrIndex) Updates the control/control-binding with the latest value of the attribute at the given index with the given value.

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

convertValueList, findListIndex, findMatchingListValue, findValue, getAttrValuesFromRSI, getListOperMode, getSelectedIndex, getSelectedValue, getValueFromList, getValueList, isSingleAttrList, matchTargetWithLov, navigated, rangeRefreshed, rangeScrolled, rowDeleted, rowInserted, rowUpdated, setAttributeFromValueList, setListOperMode, setSelectedIndex, setSingleAttrList, setTargetAttrsFromLovRow, setValueList, updateTargetFromSelectedValue, updateValuesFromRow

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

refreshControl, updateNavigated, updateRangeScrolled, updateValuesFromRows

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

findAttributeDef, getAttribute, getAttribute, getAttributeCount, getAttributeDef, getAttributeDefs, getAttributeFromRow, getAttributeFromRow, getAttributeFromRow, getAttributeFromRow, getAttributeFromRow, getAttributeIndexOf, getAttributeNames, getAttributeValues, isArrayIteratorType, isAttributeUpdateable, setArrayIteratorType, setAttribute, setAttribute, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, setAttributeInRow, stopEditing, updateRowDeleted, updateRowInserted

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

executeQuery, executeQueryIfNeeded, getAllRowsInRange, getApplicationModule, getControl, getCurrentRow, getDef, getFormBinding, getIteratorBinding, getLayoutObject, getName, getRowAtRangeIndex, getRowIterator, getTransaction, getViewObject, isControlQueriable, reportException, reportException, setFormBinding, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mLovRSI

protected RowSetIterator mLovRSI

RowSet which contains data that is to be displayed in the LOV.

mLovAttrs

protected java.lang.String[] mLovAttrs

Attribute names that are being displayed by this LOV.

mLovPanel

protected JULovPanelInterface mLovPanel

Panel that displays LOV data.

Constructor Detail

JULovButtonBinding

public JULovButtonBinding(java.lang.Object control,
JUIteratorBinding iterBinding,
                          java.lang.String[] targetAttrs,
RowSetIterator lovRsi,
                          java.lang.String[] lovVOAttrNames,
                          java.lang.String[] lovVODisplayedAttrNames)

JULovButtonBinding

public JULovButtonBinding(java.lang.Object control,
JUIteratorBinding iterBinding,
                          java.lang.String[] targetAttrs,
RowSetIterator lovRsi,
                          java.lang.String[] listAttrNames,
                          java.lang.String[] lovVODisplayedAttrNames,
JULovPanelInterface lovPanel)

JULovButtonBinding

public JULovButtonBinding(java.lang.Object control,
JUIteratorBinding iterBinding,
                          java.lang.String[] targetAttrs,
RowSetIterator lovRsi,
                          java.lang.String[] listAttrNames,
                          java.lang.String[] lovVODisplayedAttrNames,
                          boolean searchability,
                          java.lang.String title,
                          java.awt.Point location)

Method Detail

createLovBinding

public static javax.swing.ButtonModel createLovBinding(JUFormBinding formBinding,
                                                       javax.swing.AbstractButton 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)

This method should be used to create a JULovButtonBinding and bind it to a JButton control. It returns the model associated with JButton that can be used in setModel() calls to the JButton.

Parameters:

formBinding - The containing JUPanelBinding in which the given iterator binding would be found/created.

control - The control instance to bind to a ViewObject's attribute.

voInstanceName - Name of the instance of the ViewObject in a BC4J ApplicationModule.

voIterName - Runtime instance name of the iterator in the ViewObject (optional).

voIterBindingName - Instance name of the iterator binding that uniquely identifies an iterator binding object used to read/write data in this given JUPanelBinding instance.

voAttrNames - The names of the attributes of the target ViewObject rows that are updated when a LOV row is selected.

lovVOInstanceName - Name of the instance of the ViewObject in BC4J application module to use for LOV display and selection.

lovVOAttrNames - Names of the attributes that are used to update the target ViewObject attributes.

createLovBinding

public static javax.swing.ButtonModel createLovBinding(JUFormBinding formBinding,
                                                       javax.swing.AbstractButton control,
                                                       java.lang.String voInstanceName,
                                                       java.lang.String voIterName,
                                                       java.lang.String voIterBindingName,
                                                       java.lang.String[] voAttrNames,
                                                       java.lang.String lovVOInstanceName,
                                                       java.lang.String lovVOIterName,
                                                       java.lang.String lovVOIterBindingName,
                                                       java.lang.String[] lovVOAttrNames,
                                                       java.lang.String[] lovVODisplayedAttrNames,
                                                       boolean searchability,
                                                       java.lang.String title,
                                                       java.awt.Point location)

This method should be used to create a JULovButtonBinding and bind it to a JButton control. It returns the model associated with JButton that can be used in setModel() calls to the JButton.

Parameters:

formBinding - The containing JUPanelBinding in which the given iterator binding would be found/created.

control - The control instance to bind to a ViewObject's attribute.

voInstanceName - Name of the instance of the ViewObject in a BC4J ApplicationModule.

voIterName - Runtime instance name of the iterator in the ViewObject (optional).

voIterBindingName - Instance name of the iterator binding that uniquely identifies an iterator binding object used to read/write data in this given JUPanelBinding instance.

voAttrNames - The names of the attributes of the target ViewObject rows that are updated when a LOV row is selected.

lovVOInstanceName - Name of the instance of the ViewObject in BC4J application module to use for LOV display and selection.

lovVOIterName - Runtime instance name of the iterator in the LOV ViewObject

lovVOIterBindingName - Instance name of the iterator binding that uniquely identifies an iterator binding object used to get Lov rows.

lovVOAttrNames - Names of the attributes that are used to update the target ViewObject attributes.

searchability - true if this binding is to allow search mode in the Lov Dialog.

title - String that should be displayed as the title of the Lov Dialog.

location - Where the Lov dialog should be anchored.

createLovBinding

public static javax.swing.ButtonModel createLovBinding(JUFormBinding formBinding,
                                                       javax.swing.AbstractButton control,
                                                       java.lang.String voInstanceName,
                                                       java.lang.String voIterName,
                                                       java.lang.String voIterBindingName,
                                                       java.lang.String[] voAttrNames,
                                                       java.lang.String lovVOInstanceName,
                                                       java.lang.String lovVOIterName,
                                                       java.lang.String lovVOIterBindingName,
                                                       java.lang.String[] lovVOAttrNames,
                                                       java.lang.String[] lovVODisplayedAttrNames,
JULovPanelInterface lovPanel)

This method should be used to create a JULovButtonBinding and bind it to a JButton control. It returns the model associated with JButton that can be used in setModel() calls to the JButton.

Parameters:

formBinding - The containing JUPanelBinding in which the given iterator binding would be found/created.

control - The control instance to bind to a ViewObject's attribute.

voInstanceName - Name of the instance of the ViewObject in a BC4J ApplicationModule.

voIterName - Runtime instance name of the iterator in the ViewObject (optional).

voIterBindingName - Instance name of the iterator binding that uniquely identifies an iterator binding object used to read/write data in this given JUPanelBinding instance.

voAttrNames - The names of the attributes of the target ViewObject rows that are updated when a LOV row is selected.

lovVOInstanceName - Name of the instance of the ViewObject in BC4J application module to use for LOV display and selection.

lovVOAttrNames - Names of the attributes that are used to update the target ViewObject attributes.

lovPanel - the JULovPanelInterface interface default constructor so that it can be instantiated by this binding method.

getInstance

public static javax.swing.ButtonModel getInstance(JUFormBinding formBinding,
                                                  javax.swing.AbstractButton 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)

Deprecated. since 9.0.2 use createLovBinding()

setupListItems

protected void setupListItems(boolean clean,
                              boolean keepSelectedIndex)

Description copied from class: JUCtrlListBinding

If this list is displaying a single attribute and updates a single attribute, then this method fetches the attribute value from all the rows in the given LOV list iterator and sets that as the list of values to display in the bound control.

If this list is displaying multiple attributes and/or is used in navigation mode, then the valueList is set with the list of all rows from the LOV Iterator binding. In this case, this binding also listens to events from the RowSetIterator for row currency changes, new rows, etc.

Overrides:

setupListItems in class JUCtrlListBinding

getValueAt

public java.lang.Object getValueAt(int attrIndex)

Description copied from class: JUCtrlAttrsBinding

Gets the value from the control for the attribute at the given index. (The index is calculated from the list of attributes this control binding is bound to as passed in the constructor). Framework uses this method to get the attribute value from the control and pass it on to the Row object on the BC4J side.

Overrides:

getValueAt in class JUCtrlListBinding

setDataValueAt

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

Specified by:

setDataValueAt in class JUCtrlAttrsBinding

setValueAt

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

Description copied from class: JUCtrlAttrsBinding

Updates the control/control-binding with the latest value of the attribute at the given index with the given value. This method is used by the framework to update the control with attribute values from a BC4J row.

Specified by:

setValueAt in class JUCtrlAttrsBinding

isNavigationMode

public boolean isNavigationMode()

setNavigationMode

public void setNavigationMode(boolean flag)

getLovPanelInterface

public JULovPanelInterface getLovPanelInterface()

setHelpAction

public void setHelpAction(java.awt.event.ActionListener al)

If the default LOV dialog is being used to display LOV Data, this method should be used by applications to set the ActionListener that is triggered on activating the help button in the LOV Dialog. This allows applications to display custom help for the LOV dialog.

getModelImpl

protected javax.swing.ButtonModel getModelImpl(java.lang.Object control)

*** For internal framework use only ***

addControlToPanel

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

*** For internal framework use only ***

Specified by:

addControlToPanel in class JUControlBinding

actionPerformed

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

Specified by:

actionPerformed in interface java.awt.event.ActionListener

performLOVAction

public void performLOVAction()

This method is invoked when action is to be performed on the associated button. It gets the current row from the LOV RowSet Iterator and update the values from this row in to the current row of the target RowSet Iterator by mapping each element in the lovAttributeNames[] in the source/LOV Row with each element in the attributeNames[] in the target Row.

isArmed

public boolean isArmed()

Specified by:

isArmed in interface javax.swing.ButtonModel

isSelected

public boolean isSelected()

Specified by:

isSelected in interface javax.swing.ButtonModel

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface javax.swing.ButtonModel

isPressed

public boolean isPressed()

Specified by:

isPressed in interface javax.swing.ButtonModel

isRollover

public boolean isRollover()

Specified by:

isRollover in interface javax.swing.ButtonModel

setArmed

public void setArmed(boolean b)

Specified by:

setArmed in interface javax.swing.ButtonModel

setSelected

public void setSelected(boolean b)

Specified by:

setSelected in interface javax.swing.ButtonModel

setEnabled

public void setEnabled(boolean b)

Specified by:

setEnabled in interface javax.swing.ButtonModel

setPressed

public void setPressed(boolean b)

Specified by:

setPressed in interface javax.swing.ButtonModel

setRollover

public void setRollover(boolean b)

Specified by:

setRollover in interface javax.swing.ButtonModel

setMnemonic

public void setMnemonic(int key)

Specified by:

setMnemonic in interface javax.swing.ButtonModel

getMnemonic

public int getMnemonic()

Specified by:

getMnemonic in interface javax.swing.ButtonModel

setActionCommand

public void setActionCommand(java.lang.String s)

Specified by:

setActionCommand in interface javax.swing.ButtonModel

getActionCommand

public java.lang.String getActionCommand()

Specified by:

getActionCommand in interface javax.swing.ButtonModel

setGroup

public void setGroup(javax.swing.ButtonGroup group)

Specified by:

setGroup in interface javax.swing.ButtonModel

addActionListener

public void addActionListener(java.awt.event.ActionListener l)

Specified by:

addActionListener in interface javax.swing.ButtonModel

removeActionListener

public void removeActionListener(java.awt.event.ActionListener l)

Specified by:

removeActionListener in interface javax.swing.ButtonModel

addItemListener

public void addItemListener(java.awt.event.ItemListener l)

Specified by:

addItemListener in interface javax.swing.ButtonModel

removeItemListener

public void removeItemListener(java.awt.event.ItemListener l)

Specified by:

removeItemListener in interface javax.swing.ButtonModel

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener l)

Specified by:

addChangeListener in interface javax.swing.ButtonModel

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener l)

Specified by:

removeChangeListener in interface javax.swing.ButtonModel

getSelectedObjects

public java.lang.Object[] getSelectedObjects()

Specified by:

getSelectedObjects in interface java.awt.ItemSelectable

getLOVRowSetIterator

public RowSetIterator getLOVRowSetIterator()

Returns the RowSet Iterator used to display LOV data. This could be used to programmatically set a current selection in the LOV RowSet Iterator.