Oracle Data-aware Controls Reference

oracle.dacf.control.swing
Class NavigationBar

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JToolBar
                  extended byoracle.dacf.control.swing.NavigationBar
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, Control, CurrencyListener, javax.infobus.DataItemChangeListener, java.util.EventListener, java.awt.image.ImageObserver, InfoBusManagerListener, java.awt.MenuContainer, java.io.Serializable, javax.swing.SwingConstants

public class NavigationBar
extends javax.swing.JToolBar
implements Control, java.awt.event.ActionListener, CurrencyListener, InfoBusManagerListener

Data aware toolbar. Can be bound to a ScrollableRowsetAccess dataitem and can be used to:

Inserting Cursors and Records

The NavigationBar uses methods on the javax.infobus.ScrollableRowsetAccess interface to move the cursor or insert a new record. You can use this interface to perform operations programatically. For example:

 import javax.infobus.*;

 NavigationBar navbar  = ...

 navbar.setDataItemName(...);
 ScrollableRowsetAccess rsAccess =
              (ScrollableRowsetAccess)navbar.getDataItem();

 rsAccess.absolute(1); // position the cursor at first row
 rsAccess.newRow(); // insert a new row
 ...
 

Version:
PUBLIC
See Also:
#setHasNavigationButtons(), #setHasInsertButton(), #setHasDeleteButton(), #setHasTransactionButtons(), Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JToolBar
javax.swing.JToolBar.AccessibleJToolBar, javax.swing.JToolBar.Separator
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  javax.swing.JDialog _findDialog
           
static int BUTTON_COMMIT
           
static int BUTTON_DELETE
           
static int BUTTON_DISABLED
           
static int BUTTON_FIND
           
static int BUTTON_FIRST
           
static int BUTTON_INSERT
           
static int BUTTON_LAST
           
static int BUTTON_NEXT
           
static int BUTTON_NORMAL
           
static int BUTTON_PRESSED
           
static int BUTTON_PREV
           
static int BUTTON_ROLLBACK
           
static int BUTTON_ROLLOVER
           
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface oracle.dacf.control.Control
DEFAULT_INFOBUS_NAME, EVENT_PROPERTY_ROW, EVENT_PROPERTY_ROW_CHANGE, EVENT_PROPERTY_ROW_COUNT, EVENT_PROPERTY_VIEW_CHANGE, EVENT_PROPERTY_VIEW_REFRESHED, EVENT_PROPERTY_VIEW_SCROLLED, EXCLUDE, HIDE, SHOW
 
Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
NavigationBar()
          Creates a default instance
 
Method Summary
protected  java.awt.Point _computeFindDialogLocation(java.awt.Dimension screenSize, java.awt.Dimension dlgSize)
          override this method to change the find dialog location
protected  java.awt.Dimension _computeFindDialogSize(java.awt.Dimension screenSize)
          override this method to change the size of the find dialog
protected  void _createFindPanel()
           
protected  javax.swing.JDialog _createFindPanelDialog()
          Create the find dialog which the NavigationBar uses.
protected  void _displayFindDialog()
          Display find dialog.
protected  void _escKeyPressed()
           
protected  void _invokeApplyEdits(Control focusedControl, boolean bFlag)
           
protected  void _updateButtonStates()
           
protected  void _updateButtonStatesLater()
           
 void actionPerformed(java.awt.event.ActionEvent event)
          This method is an implementation side effect
 void addNavigatedListener(NavigatedListener listener)
          Adds a navigated listener to this control.
 void addNavigatingListener(NavigatingListener listener)
          Adds a navigating listener to this control.
 void addVetoableNavigationBarButtonClickListener(NavigationBarButtonClickListener l)
           
 void currencyChanged(CurrencyChangedEvent e)
          This method is called by the NavigationManager after is has determined the new current control and keyboard focus has been moved to that control.
 void dataItemAdded(javax.infobus.DataItemAddedEvent event)
          Indicates that a new item was added to the bound aggregate data item (e.g.
 void dataItemChanged(java.lang.Object oldDataItem, java.lang.Object newDataItem)
          notification that the dataitem changed
 void dataItemDeleted(javax.infobus.DataItemDeletedEvent event)
          Indicates that an item was deleted from the bound aggregate data item (e.
 void dataItemRevoked(javax.infobus.DataItemRevokedEvent event)
          Indicates that the bound data item (and its sub-items, if any) has been revoked, and is temporarily unavailable.
 void dataItemValueChanged(javax.infobus.DataItemValueChangedEvent event)
          Indicates a changed value in the bound data item.
 void doClick(int index)
          This method allows a menu (for example) to use the navigation bar's navigation logic.
 java.awt.Cursor getBusyCursor()
          get the cursor currently used to indicated busy status
 javax.swing.JButton getButton(int whichButton)
          get the button object used in the toolbar
 javax.swing.Icon getButtonIcon(int button)
          Deprecated.  
 javax.swing.Icon getButtonIcons(int button, int type)
          Get the icon being used for a button.
 javax.swing.Icon getButtonPressedIcon(int button)
          Deprecated.  
 java.awt.Component getComponent()
          Returns the AWT component associated with this control.
 java.lang.Object getDataItem()
          get the dataitem object to which the control is bound to
 java.lang.String getDataItemName()
          get the data item name to which this control is bound
 FindPanel getFindPanel()
           
 javax.swing.JDialog getFindPanelDialog()
          get the JDialog object which is used to display the Find dialog
 FindPanelUI getFindPanelUI()
          Deprecated.  
 boolean getFollowKeyboardFocus()
          Returns keyboard focus following policy.
 boolean getHasDeleteButton()
          Determines if the toolbar has the button that can be used to delete an existing row from the bound ScrollableRowsetAccess.
 boolean getHasFindButton()
          Determines if the toolbar has the button that can be used to run a restricted query (Find dialog) from the bound ScrollableRowsetAccess.
 boolean getHasInsertButton()
          Determines if the toolbar has the button that can be used to insert a new row in the bound ScrollableRowsetAccess.
 boolean getHasNavigationButtons()
          Determines if the toolbar has the buttons that are used to change the current row of the bound ScrollableRowsetAccess.
 boolean getHasTransactionButtons()
          Determines if the toolbar has the buttons that can be used to commit/rollback the changes made to the bound ScrollableRowsetAccess.
 java.lang.String getInfoBusName()
          get the infobus name to which the control is bound to
protected  boolean isBoundToLOV(Control c)
          check if an LOV property has been set on the control's dataobject
 boolean isFocusValidated()
          Determines whether focus into this control causes validation to occur.
 void processNavigatedEvent(NavigatedEvent event)
          Processes a navigated event for this control.
 void processNavigatingEvent(NavigatingEvent event)
          Processes a navigating event for this control.
 void releaseResources(InfoBusManagerReleaseEvent e)
          A signalling method used to indicate the the control should free all resources and unregister any listeners that it has registered.
 void removableVetoableNavigationBarButtonClickListener(NavigationBarButtonClickListener l)
           
 void removeNavigatedListener(NavigatedListener listener)
          Removes a navigated listener from this control.
 void removeNavigatingListener(NavigatingListener listener)
          Removes a navigating listener from this control.
 void restoreDefaultCursor()
          show default cursor
 void rowsetCursorMoved(javax.infobus.RowsetCursorMovedEvent event)
          Indicates that the cursor for the bound RowsetAccess data item has changed rows.
 void setBusyCursor(java.awt.Cursor busyCursor)
          Change the cursor used to indicate busy status
 void setButtonIcon(int button, javax.swing.Icon icon)
          Deprecated.  
 void setButtonIcons(int button, javax.swing.Icon icon, javax.swing.Icon pressedIcon, javax.swing.Icon disabledIcon, javax.swing.Icon rolloverIcon)
          Set the icon to be used for a button.
 void setButtonPressedIcon(int button, javax.swing.Icon icon)
          Deprecated.  
 void setDataItemName(java.lang.String dataItemName)
          set the data item name to which the control is bound
 void setFindPanelUI(FindPanelUI findPanelUI)
          Deprecated.  
 void setFocusValidated(boolean focusValidated)
          Sets whether focus into this control causes validation to occur.
 void setFollowKeyboardFocus(boolean nuFollowKeyboardFocus)
          Set keyboard focus following policy.
 void setHasDeleteButton(boolean b)
          Tells the toolbar whether to include the delete button or not
 void setHasFindButton(boolean b)
          Tells the toolbar whether to include the 'Find button or not
 void setHasInsertButton(boolean b)
          Tells the toolbar whether to include the insert button or not
 void setHasNavigationButtons(boolean b)
          Tells the toolbar whether to include the navigation buttons or not.
 void setHasTransactionButtons(boolean b)
          Tells the toolbar whether to include the commit/rollback buttons or not
 void setInfoBusName(java.lang.String infoBusName)
          set the infobus name to which the control is bound to
 void showBusyCursor()
          displays a busy cursor
 
Methods inherited from class javax.swing.JToolBar
add, addImpl, addSeparator, addSeparator, createActionChangeListener, createActionComponent, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, isRollover, paintBorder, paramString, setBorderPainted, setFloatable, setLayout, setMargin, setOrientation, setRollover, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.dacf.control.Control
setEnabled
 

Field Detail

BUTTON_FIRST

public static final int BUTTON_FIRST
See Also:
Constant Field Values

BUTTON_PREV

public static final int BUTTON_PREV
See Also:
Constant Field Values

BUTTON_NEXT

public static final int BUTTON_NEXT
See Also:
Constant Field Values

BUTTON_LAST

public static final int BUTTON_LAST
See Also:
Constant Field Values

BUTTON_INSERT

public static final int BUTTON_INSERT
See Also:
Constant Field Values

BUTTON_DELETE

public static final int BUTTON_DELETE
See Also:
Constant Field Values

BUTTON_COMMIT

public static final int BUTTON_COMMIT
See Also:
Constant Field Values

BUTTON_ROLLBACK

public static final int BUTTON_ROLLBACK
See Also:
Constant Field Values

BUTTON_FIND

public static final int BUTTON_FIND
See Also:
Constant Field Values

BUTTON_NORMAL

public static final int BUTTON_NORMAL
See Also:
Constant Field Values

BUTTON_PRESSED

public static final int BUTTON_PRESSED
See Also:
Constant Field Values

BUTTON_DISABLED

public static final int BUTTON_DISABLED
See Also:
Constant Field Values

BUTTON_ROLLOVER

public static final int BUTTON_ROLLOVER
See Also:
Constant Field Values

_findDialog

protected javax.swing.JDialog _findDialog
Constructor Detail

NavigationBar

public NavigationBar()
Creates a default instance

Method Detail

setButtonIcon

public void setButtonIcon(int button,
                          javax.swing.Icon icon)
Deprecated.  

Set the icon to be used for a button.

Parameters:
button - The button whose icon should be changed. Allowed values should be one of defined by the BUTTON_XXX constants
icon - The new icon

getButtonIcon

public javax.swing.Icon getButtonIcon(int button)
Deprecated.  

Get the icon being used for a button.

Parameters:
button - The button whose icon is being requested Allowed values should be one of defined by the BUTTON_XXX constants
Returns:
The icon being used by button

setButtonIcons

public void setButtonIcons(int button,
                           javax.swing.Icon icon,
                           javax.swing.Icon pressedIcon,
                           javax.swing.Icon disabledIcon,
                           javax.swing.Icon rolloverIcon)
Set the icon to be used for a button.

Parameters:
button - The button whose icon should be changed. Allowed values should be one of defined by the BUTTON_XXX constants
icon - The new button icon
pressedIcon - The new button pressed icon
disabledIcon - The new button disabled icon
rolloverIcon - The new button rollover icon

getButtonIcons

public javax.swing.Icon getButtonIcons(int button,
                                       int type)
Get the icon being used for a button.

Parameters:
button - The button whose icon is being requested Allowed values should be one of defined by the BUTTON_XXX constants
type - The icon type. Allowed values are BUTTON_NORMAL, BUTTON_PRESSED, BUTTON_DISABLED, and BUTTON_ROLLOVER
Returns:
The icon being used by button

setButtonPressedIcon

public void setButtonPressedIcon(int button,
                                 javax.swing.Icon icon)
Deprecated.  

Set the icon to be used when a button is pressed.

Parameters:
button - The button whose icon should be changed. Allowed values should be one of defined by the BUTTON_XXX constants
icon - The new icon

getButtonPressedIcon

public javax.swing.Icon getButtonPressedIcon(int button)
Deprecated.  

Get the icon displayed when a navigation bar button is pressed.

Parameters:
button - The button whose icon is being requested Allowed values should be one of defined by the BUTTON_XXX constants
Returns:
The icon being used by the button in the pressed button

showBusyCursor

public void showBusyCursor()
displays a busy cursor


restoreDefaultCursor

public void restoreDefaultCursor()
show default cursor


setBusyCursor

public void setBusyCursor(java.awt.Cursor busyCursor)
Change the cursor used to indicate busy status

Parameters:
busyCursor - cursor to indicated busy status

getBusyCursor

public java.awt.Cursor getBusyCursor()
get the cursor currently used to indicated busy status

Returns:
get the busy cursor

getButton

public javax.swing.JButton getButton(int whichButton)
get the button object used in the toolbar

Parameters:
whichButton - A constant indicating which button is requested Allowed values should be one of defined by the BUTTON_XXX constants
Returns:
The button object

setFollowKeyboardFocus

public void setFollowKeyboardFocus(boolean nuFollowKeyboardFocus)
Set keyboard focus following policy.

If true, when the keyboard focus moves from one rowset to another, the NavigationBar will reconfigure itself so that it manipulates that rowset.

Parameters:
nuFollowKeyboardFocus - if true, then track the keyboard focus
See Also:
getFollowKeyboardFocus()

getFollowKeyboardFocus

public boolean getFollowKeyboardFocus()
Returns keyboard focus following policy.

If true, when the keyboard focus moves from one rowset to another, the NavigationBar will reconfigure itself so that it manipulates that rowset.

Returns:
Returns keyboard focus following policy
See Also:
setFollowKeyboardFocus(boolean nuFollowKeyboardFocus)

getHasNavigationButtons

public boolean getHasNavigationButtons()
Determines if the toolbar has the buttons that are used to change the current row of the bound ScrollableRowsetAccess.

Returns:
true if the currency can be changed otherwise returns false

setHasNavigationButtons

public void setHasNavigationButtons(boolean b)
Tells the toolbar whether to include the navigation buttons or not.

Parameters:
b - if true the the navigation buttons are included in the bar else the navigation buttons are not included

getHasInsertButton

public boolean getHasInsertButton()
Determines if the toolbar has the button that can be used to insert a new row in the bound ScrollableRowsetAccess.

Returns:
true if the button is included else false

setHasInsertButton

public void setHasInsertButton(boolean b)
Tells the toolbar whether to include the insert button or not

Parameters:
b - if true the insert button is be included else the button is removed

getHasDeleteButton

public boolean getHasDeleteButton()
Determines if the toolbar has the button that can be used to delete an existing row from the bound ScrollableRowsetAccess.

Returns:
true if the button is included else false

setHasDeleteButton

public void setHasDeleteButton(boolean b)
Tells the toolbar whether to include the delete button or not

Parameters:
b - if true the delete button is be included else the button is removed

getHasTransactionButtons

public boolean getHasTransactionButtons()
Determines if the toolbar has the buttons that can be used to commit/rollback the changes made to the bound ScrollableRowsetAccess.

Returns:
true if the buttons are included else false

setHasTransactionButtons

public void setHasTransactionButtons(boolean b)
Tells the toolbar whether to include the commit/rollback buttons or not

Parameters:
b - if true the buttons are included else the buttons are removed

getHasFindButton

public boolean getHasFindButton()
Determines if the toolbar has the button that can be used to run a restricted query (Find dialog) from the bound ScrollableRowsetAccess.

Returns:
true if the button is included else false

setHasFindButton

public void setHasFindButton(boolean b)
Tells the toolbar whether to include the 'Find button or not

Parameters:
b - if true the 'Find' button is included else the button is removed

getFindPanel

public FindPanel getFindPanel()

setFindPanelUI

public void setFindPanelUI(FindPanelUI findPanelUI)
Deprecated.  

customize the find dialog displayed by the navigation bar

Parameters:
findPanelUI - - object which implements FindPanelUI interface

getFindPanelUI

public FindPanelUI getFindPanelUI()
Deprecated.  

get the find panel UI object which customizes the find dialog

Returns:
findPanelUI renderer

releaseResources

public void releaseResources(InfoBusManagerReleaseEvent e)
Description copied from interface: InfoBusManagerListener
A signalling method used to indicate the the control should free all resources and unregister any listeners that it has registered.

Specified by:
releaseResources in interface InfoBusManagerListener

getInfoBusName

public final java.lang.String getInfoBusName()
get the infobus name to which the control is bound to

Specified by:
getInfoBusName in interface Control
Returns:
the infobus name
See Also:
ControlSupport.getInfoBusName()

setInfoBusName

public final void setInfoBusName(java.lang.String infoBusName)
set the infobus name to which the control is bound to

Specified by:
setInfoBusName in interface Control
Parameters:
infoBusName - name of the infobus
See Also:
Control.DEFAULT_INFOBUS_NAME, ControlSupport.setInfoBusName(java.lang.String)

getDataItemName

public final java.lang.String getDataItemName()
get the data item name to which this control is bound

Specified by:
getDataItemName in interface Control
Returns:
the name of the data item to which the control is bound
See Also:
Control.getDataItem(), ControlSupport.getDataItemName()

setDataItemName

public final void setDataItemName(java.lang.String dataItemName)
set the data item name to which the control is bound

Specified by:
setDataItemName in interface Control
Parameters:
dataItemName - The name of the DataItem to bind to.
See Also:
Control.getDataItem(), ControlSupport.setDataItemName(java.lang.String)

getDataItem

public final java.lang.Object getDataItem()
get the dataitem object to which the control is bound to

Specified by:
getDataItem in interface Control
Returns:
the dataitem object to which the control is bound
See Also:
ControlSupport.getDataItem()

dataItemChanged

public final void dataItemChanged(java.lang.Object oldDataItem,
                                  java.lang.Object newDataItem)
notification that the dataitem changed

Specified by:
dataItemChanged in interface Control
Parameters:
oldDataItem - old data item object
newDataItem - new data item object

getComponent

public final java.awt.Component getComponent()
Returns the AWT component associated with this control.

Specified by:
getComponent in interface Control
Returns:
The AWT component for this control.

isFocusValidated

public final boolean isFocusValidated()
Determines whether focus into this control causes validation to occur.

Most controls should delegate this method to ControlSupport.

Specified by:
isFocusValidated in interface Control
Returns:
true if focus into this control causes validation to occur, false otherwise.
See Also:
ControlSupport.isFocusValidated()

setFocusValidated

public final void setFocusValidated(boolean focusValidated)
Sets whether focus into this control causes validation to occur.

Most controls should delegate this method to ControlSupport.

Specified by:
setFocusValidated in interface Control
Parameters:
focusValidated - If true, focus into this control will cause validation to occur.
See Also:
ControlSupport.setFocusValidated(boolean)

addNavigatedListener

public final void addNavigatedListener(NavigatedListener listener)
Adds a navigated listener to this control.

The listener will be notified of NavigateIn and NavigateOut events.

Most controls should delegate this method to ControlSupport.

Specified by:
addNavigatedListener in interface Control
Parameters:
listener - The listener to add.
See Also:
ControlSupport.addNavigatedListener(oracle.dacf.control.NavigatedListener)

removeNavigatedListener

public final void removeNavigatedListener(NavigatedListener listener)
Removes a navigated listener from this control.

Most controls should delegate this method to ControlSupport.

Specified by:
removeNavigatedListener in interface Control
Parameters:
listener - The listener to remove.
See Also:
ControlSupport.removeNavigatedListener(oracle.dacf.control.NavigatedListener)

processNavigatedEvent

public final void processNavigatedEvent(NavigatedEvent event)
Processes a navigated event for this control.

This method is for use by the NavigationManager only.

Most controls should delegate this method to ControlSupport.

Specified by:
processNavigatedEvent in interface Control
Parameters:
event - The navigated event.
See Also:
ControlSupport.processNavigatedEvent(oracle.dacf.control.NavigatedEvent)

addNavigatingListener

public final void addNavigatingListener(NavigatingListener listener)
Adds a navigating listener to this control.

The listener will be notified of NavigateIn and NavigateOut events.

Most controls should delegate this method to ControlSupport.

Specified by:
addNavigatingListener in interface Control
Parameters:
listener - The listener to add.
See Also:
ControlSupport.addNavigatedListener(oracle.dacf.control.NavigatedListener)

removeNavigatingListener

public final void removeNavigatingListener(NavigatingListener listener)
Removes a navigating listener from this control.

Most controls should delegate this method to ControlSupport.

Specified by:
removeNavigatingListener in interface Control
Parameters:
listener - The listener to remove.
See Also:
ControlSupport.removeNavigatedListener(oracle.dacf.control.NavigatedListener)

processNavigatingEvent

public final void processNavigatingEvent(NavigatingEvent event)
                                  throws NavigatingException
Processes a navigating event for this control.

This method is for use by the NavigatedManager only.

Most controls should delegate this method to ControlSupport.

Specified by:
processNavigatingEvent in interface Control
Parameters:
event - The navigating event.
Throws:
NavigatingException - If the navigation is redirected to a different control.
See Also:
ControlSupport.processNavigatedEvent(oracle.dacf.control.NavigatedEvent)

addVetoableNavigationBarButtonClickListener

public void addVetoableNavigationBarButtonClickListener(NavigationBarButtonClickListener l)

removableVetoableNavigationBarButtonClickListener

public void removableVetoableNavigationBarButtonClickListener(NavigationBarButtonClickListener l)

dataItemValueChanged

public final void dataItemValueChanged(javax.infobus.DataItemValueChangedEvent event)
Indicates a changed value in the bound data item.

A reference to the data item that changed can be obtained from the event.

Specified by:
dataItemValueChanged in interface javax.infobus.DataItemChangeListener
Parameters:
event - Contains change information.
See Also:
DataItemChangeListener.dataItemValueChanged(javax.infobus.DataItemValueChangedEvent)

dataItemAdded

public final void dataItemAdded(javax.infobus.DataItemAddedEvent event)
Indicates that a new item was added to the bound aggregate data item (e.g. ArrayAccess, a JDK Collection, etc).

A reference to the data item that was added, and a reference to the one that gained it, can be obtained from the event.

Specified by:
dataItemAdded in interface javax.infobus.DataItemChangeListener
Parameters:
event - Contains details of the addition.
See Also:
DataItemChangeListener.dataItemAdded(javax.infobus.DataItemAddedEvent)

dataItemDeleted

public final void dataItemDeleted(javax.infobus.DataItemDeletedEvent event)
Indicates that an item was deleted from the bound aggregate data item (e. g. ArrayAccess, a JDK Collection, etc).

A reference to the data item that was deleted, and a reference to the one that lost it, can be obtained from the event.

Specified by:
dataItemDeleted in interface javax.infobus.DataItemChangeListener
Parameters:
event - Contains details of the deletion.
See Also:
DataItemChangeListener.dataItemDeleted(javax.infobus.DataItemDeletedEvent)

dataItemRevoked

public final void dataItemRevoked(javax.infobus.DataItemRevokedEvent event)
Indicates that the bound data item (and its sub-items, if any) has been revoked, and is temporarily unavailable.

A reference to the data item that was revoked can be obtained from the event.

Specified by:
dataItemRevoked in interface javax.infobus.DataItemChangeListener
Parameters:
event - Contains details of the revoked data.
See Also:
DataItemChangeListener.dataItemRevoked(javax.infobus.DataItemRevokedEvent)

rowsetCursorMoved

public void rowsetCursorMoved(javax.infobus.RowsetCursorMovedEvent event)
Indicates that the cursor for the bound RowsetAccess data item has changed rows.

A reference to the rowset data item can be obtained from the event.

Specified by:
rowsetCursorMoved in interface javax.infobus.DataItemChangeListener
Parameters:
event - Contains details of the cursor move.
See Also:
DataItemChangeListener.rowsetCursorMoved(javax.infobus.RowsetCursorMovedEvent)

doClick

public void doClick(int index)
This method allows a menu (for example) to use the navigation bar's navigation logic.

Parameters:
index - the identifier for the button to click (one of the BUTTON_XXX constants)

getFindPanelDialog

public javax.swing.JDialog getFindPanelDialog()
get the JDialog object which is used to display the Find dialog

Returns:
the dialog object to display the find dialog

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)
This method is an implementation side effect

Specified by:
actionPerformed in interface java.awt.event.ActionListener

_invokeApplyEdits

protected void _invokeApplyEdits(Control focusedControl,
                                 boolean bFlag)

currencyChanged

public void currencyChanged(CurrencyChangedEvent e)
Description copied from interface: CurrencyListener
This method is called by the NavigationManager after is has determined the new current control and keyboard focus has been moved to that control.

Specified by:
currencyChanged in interface CurrencyListener

_createFindPanelDialog

protected javax.swing.JDialog _createFindPanelDialog()
Create the find dialog which the NavigationBar uses. This method should be overriden if you want to have a custom dialog. This dialog is used to host the FindPanel


_createFindPanel

protected void _createFindPanel()

_escKeyPressed

protected void _escKeyPressed()

_updateButtonStatesLater

protected void _updateButtonStatesLater()

_updateButtonStates

protected void _updateButtonStates()

_displayFindDialog

protected void _displayFindDialog()
Display find dialog. Set up the find panel and display the find dialog.


_computeFindDialogSize

protected java.awt.Dimension _computeFindDialogSize(java.awt.Dimension screenSize)
override this method to change the size of the find dialog


_computeFindDialogLocation

protected java.awt.Point _computeFindDialogLocation(java.awt.Dimension screenSize,
                                                    java.awt.Dimension dlgSize)
override this method to change the find dialog location


isBoundToLOV

protected boolean isBoundToLOV(Control c)
check if an LOV property has been set on the control's dataobject


Oracle Data-aware Controls Reference

 

Copyright © 1997, 2003, Oracle. All rights reserved.