oracle.jbo.uicli.jui
Class JUPanelBinding

java.lang.Object
  |
  +--oracle.jbo.uicli.binding.JUFormBinding
        |
        +--oracle.jbo.uicli.jui.JUPanelBinding

public class JUPanelBinding

extends JUFormBinding

A container class that manages JUIteratorBindings, etc. by extending the JUFormBinding class. It provides:

• Management of JUNavigationBarInterfaces bound to the iterators behind the iterator binding objects.
• Management of JUIteratorChangedListeners like NavigationBars, StatusBars and Menus.
• Management of JUPanelValidationListeners that perform attribute, panel and transaction level validations.
• Switching of iterators behind iterator-binding objects so that all relevant controls in this form are updated with new data from the new iterator.

Field Summary

protected java.lang.String	mAppName
protected java.util.ArrayList	mIteratorChangedListeners
protected java.util.ArrayList	mNavigationBarList

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

mAM, mApplication

Constructor Summary

JUPanelBinding()
*** For internal framework use only ***

JUPanelBinding(javax.swing.JPanel panel)
Applications should use this constructor to create a panel binding and associate it with a swing JPanel object.

JUPanelBinding(java.lang.String appName, javax.swing.JPanel panel)
Creates an instance of this class, associating it with a JPanel object and a JUApplication identified by appName.

JUPanelBinding(java.lang.String appName, java.lang.String amName, javax.swing.JPanel panel)
Creates an instance of this class, associating it with a JPanel object and a JUApplication identified by appName.

Method Summary

void	addBindingWithCellEditor(JUPanelStopEditingListener binding) Adds a listener that is interested in notification such that it stops its control's edit process before the panel is moved to a different set of data.
void	addIteratorChangedListener(JUIteratorChangedListener l) Adds a listener that should be notified when the iterator behind an iterator binding object changes or the display mode changes from find to data mode or the reverse.
void	addNavigationBar(JUNavigationBarInterface navBar) Adds a NavigationBar (or like object) that needs to listen into changes in an iterator, and focus events, etc.
void	addRowSetListener(JUPanelRowSetListener l) Adds the given listener to this panel's RowSet listeners list.
void	addValidationListener(JUPanelValidationListener l) Adds the given listener to this panel's validation listeners list.
void	beforeCurrencyChange(JUPanelValidationEvent ev) Notifies all JUPanelValidationListeners with the beforeCurrencyChange event.
void	beforeSaveTransaction(JUPanelValidationEvent ev) Notifies all JUPanelValidationListeners with the beforeSaveTransaction event.
void	beforeSetAttribute(JUPanelValidationEvent ev) Notifies all JUPanelValidationListeners with the beforeSetAttribute event.
void	bindRowSetIterator(java.lang.String iterBindingName, RowSetIterator rsi) Binds the iterator identified by iterBindingName in this panel with another iterator.
void	bindRowSetIterator(java.lang.String iterBindingName, java.lang.String voInstanceName) Binds the iterator identified by iterBindingName in this panel with another ViewObject in the current application module identified by the given voInstanceName.
protected void	callBeforeRowNavigated(JUIteratorBinding iter) Forces the current control to stop its editing mode (if used, like in JTable).
protected void	callBeforeSaveTransaction(Transaction txn) Forces the current control to stop its editing mode (if used, like in JTable).
protected void	callBeforeSetAttribute(JUControlBinding ctrl, Row row, AttributeDef ad, java.lang.Object value) Calls beforeSetAttribute() method to notify all validation listeners.
void	focusGained(JUIteratorBinding iterBinding, JUControlBinding binding, int attrIndex) Notifies the JUApplication object of focusGained event so that it could pass it on to its StatusBarInterface listeners (like JUStatusBar to update status message).
java.lang.String	getApplicationName() Returns the name of the JUApplication object in which this Panel binding was created.
java.lang.String	getAppModuleName() Returns the Application Module instance name to which this Panel binding is connected.
ViewObject[]	getOrderedVOUsageList() Returns an ordered list of ViewObject usages in this panel so that a JboException parameters can be transformed from Entity-layer names and exception parameters to ViewObject names and parameters.
java.util.ArrayList	getRowSetListeners() Returns a list of JUPanelRowSetListeners (returns an empty list if no such listener was registered).
java.util.ArrayList	getValidationListeners() Returns a list of JUPanelValidationListeners (returns an empty list if no such listener was registered).
protected void	initializeApplicationModule() Sets up the JUApplication and Application Module references based on name passed to this object via the constructors or various setter methods.
void	initializePanel(java.util.ArrayList controls) *** For internal framework use only ***
boolean	isTransactionDirty() Returns true, if the Transaction behind the associated ApplicationModule has pending changes In three-tier, this method will go across the tier boundary to get the actual middle-tier transaction status.
protected void	navigated(JUIteratorBinding iter, NavigationEvent event) Invoked when a JUIteratorBinding receives a navigated Event from BC4J RowSetIterator
protected void	notifyIteratorChanged(JUIteratorBinding iterBnd, boolean refresh) Notifies all JUIteratorChangedListeners and JUNavigationBarInterface objects registered with this panel of the change in iterator binding.
protected void	rangeRefreshed(JUIteratorBinding iter, RangeRefreshEvent event) Invoked when a JUIteratorBinding receives a rangeRefreshed Event from BC4J RowSetIterator
protected void	rangeScrolled(JUIteratorBinding iter, ScrollEvent event) Invoked when a JUIteratorBinding receives a rangeScrolled Event from BC4J RowSetIterator
void	removeBindingWithCellEditor(JUPanelStopEditingListener binding) Removes a listener from the list.
void	removeIteratorChangedListener(JUIteratorChangedListener l) Remove a listener from this list.
void	removeNavigationBar(JUNavigationBarInterface navBar) Removes a JUNavigationBarInterface listener object from the list.
void	removeRowSetListener(JUPanelRowSetListener l) Removes the given listener from this panel's RowSet listeners list.
void	removeValidationListener(JUPanelValidationListener l) Removes the given listener from this panel's validation listeners list.
protected void	rowDeleted(JUIteratorBinding iter, DeleteEvent event) Invoked when a JUIteratorBinding receives a rowDeleted Event from BC4J RowSetIterator
protected void	rowInserted(JUIteratorBinding iter, InsertEvent event) Invoked when a JUIteratorBinding receives a rowInserted Event from BC4J RowSetIterator
protected void	rowUpdated(JUIteratorBinding iter, UpdateEvent event) Invoked when a JUIteratorBinding receives a rowUpdated Event from BC4J RowSetIterator
void	setFindMode(boolean mode) Sets this panel and all its associated iterators into find mode.
void	setPanel(java.lang.Object panel) Sets the given object as the JPanel object associated with this panel binding.
void	stopEditing() Notifies all JUPanelStopEditingListeners to stop editing, so that their values can be updated with new set of data.

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

addControlBinding, addControlBinding, addIterBinding, addIterBinding, addStatusBarInterface, clearIterBindings, displayInShortForm, displayStatus, displayStatus, execute, executeIfNeeded, findControlBinding, findIterBinding, getApplication, getApplicationModule, getControlBinding, getControlBinding, getControlBindingList, getControlType, getDef, getDisplayHeight, getDisplayHint, getDisplayWidth, getHint, getHint, getIterBindingList, getIterBindings, getLabel, getLabel, getLocaleContext, getName, getPanel, getRangeIterBinding, getRowIterBinding, getTooltip, getTooltip, hasFormatInformation, initializeFromDef, initializeFromDef, isExecuteOnRollback, isFindMode, release, removeControlBinding, removeControlBinding, removeIterBinding, removeStatusBarInterface, reportException, setApplication, setApplicationModule, setExecuteOnRollback, setName, setPanelInternal

Methods inherited from class java.lang.Object

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

Field Detail

mAppName

protected java.lang.String mAppName

mNavigationBarList

protected java.util.ArrayList mNavigationBarList

mIteratorChangedListeners

protected java.util.ArrayList mIteratorChangedListeners

Constructor Detail

JUPanelBinding

public JUPanelBinding()

*** For internal framework use only ***

JUPanelBinding

public JUPanelBinding(javax.swing.JPanel panel)

Applications should use this constructor to create a panel binding and associate it with a swing JPanel object. The binding thus created needs to be added to a JUApplication object and is not completely usable until then.

JUPanelBinding

public JUPanelBinding(java.lang.String appName,
                      javax.swing.JPanel panel)

Creates an instance of this class, associating it with a JPanel object and a JUApplication identified by appName. This constructor is used in the JClient design time generated code to pass in the name of the Application Model definition name that identifies the middle-tier (BC4J) connection and configuration information.

JUPanelBinding

public JUPanelBinding(java.lang.String appName,
                      java.lang.String amName,
                      javax.swing.JPanel panel)

Creates an instance of this class, associating it with a JPanel object and a JUApplication identified by appName. This constructor is used in the JClient design time generated code to pass in the name of the Application Model definition name that identifies the middle-tier (BC4J) connection and configuration information. This constructor also takes in the application module name in case the BC4J application module for this panel is a nested application module.

Method Detail

initializeApplicationModule

protected void initializeApplicationModule()

Sets up the JUApplication and Application Module references based on name passed to this object via the constructors or various setter methods.

Specified by:

initializeApplicationModule in class JUFormBinding

initializePanel

public void initializePanel(java.util.ArrayList controls)

*** For internal framework use only ***

Specified by:

initializePanel in class JUFormBinding

bindRowSetIterator

public void bindRowSetIterator(java.lang.String iterBindingName,
                               java.lang.String voInstanceName)

Binds the iterator identified by iterBindingName in this panel with another ViewObject in the current application module identified by the given voInstanceName.

bindRowSetIterator

public void bindRowSetIterator(java.lang.String iterBindingName,
RowSetIterator rsi)

Binds the iterator identified by iterBindingName in this panel with another iterator. This method notifies all JUIteratorChangeListeners in this panel of the change so that various NavigationBars, Menus, and Status bars can adjust their displays. Applications could register their own JUIteratorChangeListeners so that they get notified of data changes resulting from a change in iterator, thus allowing them to update the displays (like change button enabled state).

notifyIteratorChanged

protected final void notifyIteratorChanged(JUIteratorBinding iterBnd,
                                           boolean refresh)

Notifies all JUIteratorChangedListeners and JUNavigationBarInterface objects registered with this panel of the change in iterator binding. If refresh parameter is true, like when there is a change in the iterator behind the iterator binding instance or a change in data/find mode of the panel, then this method raises a rangeRefreshed event on the iteratorBinding object so that all controls also adjust/udpate their displays.

Specified by:

notifyIteratorChanged in class JUFormBinding

addIteratorChangedListener

public final void addIteratorChangedListener(JUIteratorChangedListener l)

Adds a listener that should be notified when the iterator behind an iterator binding object changes or the display mode changes from find to data mode or the reverse.

removeIteratorChangedListener

public final void removeIteratorChangedListener(JUIteratorChangedListener l)

Remove a listener from this list.

addNavigationBar

public final void addNavigationBar(JUNavigationBarInterface navBar)

Adds a NavigationBar (or like object) that needs to listen into changes in an iterator, and focus events, etc. By default the framework adds all Navigation Bars bound to the Panel Binding object into this list, so that these Navigation bars adjust their display based on current iterator in focus/use.

removeNavigationBar

public final void removeNavigationBar(JUNavigationBarInterface navBar)

Removes a JUNavigationBarInterface listener object from the list.

focusGained

public void focusGained(JUIteratorBinding iterBinding,
JUControlBinding binding,
                        int attrIndex)

Notifies the JUApplication object of focusGained event so that it could pass it on to its StatusBarInterface listeners (like JUStatusBar to update status message). Then this method notifies each JUNavigationBarInterface object in this object's list of the change in focus, so that the NavigationBars can adjust their display based on the current iterator binding.

Specified by:

focusGained in class JUFormBinding

getApplicationName

public final java.lang.String getApplicationName()

Returns the name of the JUApplication object in which this Panel binding was created.

getAppModuleName

public final java.lang.String getAppModuleName()

Returns the Application Module instance name to which this Panel binding is connected.

isTransactionDirty

public final boolean isTransactionDirty()

Returns true, if the Transaction behind the associated ApplicationModule has pending changes In three-tier, this method will go across the tier boundary to get the actual middle-tier transaction status.

setPanel

public final void setPanel(java.lang.Object panel)

Sets the given object as the JPanel object associated with this panel binding.

Specified by:

setPanel in class JUFormBinding

getValidationListeners

public final java.util.ArrayList getValidationListeners()

Returns a list of JUPanelValidationListeners (returns an empty list if no such listener was registered).

addValidationListener

public final void addValidationListener(JUPanelValidationListener l)

Adds the given listener to this panel's validation listeners list.

removeValidationListener

public final void removeValidationListener(JUPanelValidationListener l)

Removes the given listener from this panel's validation listeners list.

getRowSetListeners

public final java.util.ArrayList getRowSetListeners()

Returns a list of JUPanelRowSetListeners (returns an empty list if no such listener was registered).

addRowSetListener

public final void addRowSetListener(JUPanelRowSetListener l)

Adds the given listener to this panel's RowSet listeners list.

removeRowSetListener

public final void removeRowSetListener(JUPanelRowSetListener l)

Removes the given listener from this panel's RowSet listeners list.

callBeforeSetAttribute

protected void callBeforeSetAttribute(JUControlBinding ctrl,
Row row,
AttributeDef ad,
                                      java.lang.Object value)

Calls beforeSetAttribute() method to notify all validation listeners.

Specified by:

callBeforeSetAttribute in class JUFormBinding

callBeforeRowNavigated

protected void callBeforeRowNavigated(JUIteratorBinding iter)

Forces the current control to stop its editing mode (if used, like in JTable). Calls beforeRowNavigated() method to notify all validation listeners.

Specified by:

callBeforeRowNavigated in class JUFormBinding

callBeforeSaveTransaction

protected void callBeforeSaveTransaction(Transaction txn)

Forces the current control to stop its editing mode (if used, like in JTable). Calls beforeSaveTransaction() method to notify all validation listeners.

Specified by:

callBeforeSaveTransaction in class JUFormBinding

beforeSetAttribute

public void beforeSetAttribute(JUPanelValidationEvent ev)

Notifies all JUPanelValidationListeners with the beforeSetAttribute event. This event is raised before a control binding sets the value from a control into the corresponding BC4J row's attribute.

beforeCurrencyChange

public void beforeCurrencyChange(JUPanelValidationEvent ev)

Notifies all JUPanelValidationListeners with the beforeCurrencyChange event. This event is raised before an iterator-binding object moves the current row to another row.

beforeSaveTransaction

public void beforeSaveTransaction(JUPanelValidationEvent ev)

Notifies all JUPanelValidationListeners with the beforeSaveTransaction event. The JClient framework calls this method before invoking commit() on the BC4J transaction.

rangeRefreshed

protected void rangeRefreshed(JUIteratorBinding iter,
RangeRefreshEvent event)

Invoked when a JUIteratorBinding receives a rangeRefreshed Event from BC4J RowSetIterator

Specified by:

rangeRefreshed in class JUFormBinding

Parameters:

event - a description of the new ranges.

rangeScrolled

protected void rangeScrolled(JUIteratorBinding iter,
ScrollEvent event)

Invoked when a JUIteratorBinding receives a rangeScrolled Event from BC4J RowSetIterator

Specified by:

rangeScrolled in class JUFormBinding

Parameters:

event - a description of the new range.

rowInserted

protected void rowInserted(JUIteratorBinding iter,
InsertEvent event)

Invoked when a JUIteratorBinding receives a rowInserted Event from BC4J RowSetIterator

Specified by:

rowInserted in class JUFormBinding

Parameters:

event - a description of the new Row object.

rowDeleted

protected void rowDeleted(JUIteratorBinding iter,
DeleteEvent event)

Invoked when a JUIteratorBinding receives a rowDeleted Event from BC4J RowSetIterator

Specified by:

rowDeleted in class JUFormBinding

Parameters:

event - a description of the deleted Row object.

rowUpdated

protected void rowUpdated(JUIteratorBinding iter,
UpdateEvent event)

Invoked when a JUIteratorBinding receives a rowUpdated Event from BC4J RowSetIterator

Specified by:

rowUpdated in class JUFormBinding

Parameters:

event - a description of the modified Row object.

navigated

protected void navigated(JUIteratorBinding iter,
NavigationEvent event)

Invoked when a JUIteratorBinding receives a navigated Event from BC4J RowSetIterator

Specified by:

navigated in class JUFormBinding

Parameters:

event - a description of the new and previous current rows.

setFindMode

public void setFindMode(boolean mode)

Sets this panel and all its associated iterators into find mode.

Overrides:

setFindMode in class JUFormBinding

addBindingWithCellEditor

public void addBindingWithCellEditor(JUPanelStopEditingListener binding)

Adds a listener that is interested in notification such that it stops its control's edit process before the panel is moved to a different set of data.

removeBindingWithCellEditor

public void removeBindingWithCellEditor(JUPanelStopEditingListener binding)

Removes a listener from the list.

stopEditing

public void stopEditing()

Notifies all JUPanelStopEditingListeners to stop editing, so that their values can be updated with new set of data. This method is invoked before changing the find/data mode, or switching iterators behind an iterator binding, or before committing/rolling back the database transaction.

getOrderedVOUsageList

public ViewObject[] getOrderedVOUsageList()

Description copied from class: JUFormBinding

Returns an ordered list of ViewObject usages in this panel so that a JboException parameters can be transformed from Entity-layer names and exception parameters to ViewObject names and parameters.

Overrides:

getOrderedVOUsageList in class JUFormBinding