Class powersoft.jcm.db.DataNavigator
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class powersoft.jcm.db.DataNavigator

java.lang.Object
   |
   +----powersoft.jcm.ui.Component
           |
           +----powersoft.jcm.db.DataNavigator

public final class DataNavigator
extends Component
implements DataNavigatorButtons, DataOpenListener, DataCloseListener, DataAvailableListener, AdjustCursorListener
A data navigator provides the user with an easy-to-use tool for navigating through a data source. It consists of command buttons which when clicked move the query's cursor.
See Also:
DataSource

Variable Index

 o ACTION_MOVE_FIRST
 o ACTION_MOVE_LAST
 o ACTION_NONE
constants used in the BOFAction and EOFAction properties

Constructor Index

 o DataNavigator()

Method Index

 o adjustCursor(AdjustCursorEvent)
 o createAWTComponent(Component)
Creates the AWT component.
 o dataAvailable(DataAvailableEvent)
 o dataClose(DataCloseEvent)
 o dataOpen(DataOpenEvent)
 o getBOFAction()
Determines the behavior of the cursor when the user clicks the data navigator's "up one row" button when the cursor is at the BOF position.
 o getDataSource()
Gets the data source associated with the data navigator.
 o getEOFAction()
Determines the behavior of the cursor when the user clicks the data navigator's "down one row" button when the cursor is at the BOF position.
 o getShowAdd()
 o getShowCancel()
 o getShowDelete()
 o getShowEdit()
 o getShowMoveFirst()
 o getShowMoveLast()
 o getShowMoveNext()
 o getShowMovePrevious()
 o getShowRefresh()
 o getShowState(byte)
Get the show state of a button in the navigator.
 o getShowUpdate()
 o setBOFAction(byte)
Specifies the behavior of the cursor when the user clicks the data navigator's "up one row" button when the cursor is at the BOF position.
 o setDataSource(DataSource)
Sets the data source associated with the data navigator.
 o setEOFAction(byte)
Specifies the behavior of the cursor when the user clicks the data navigator's "down one row" button when the cursor is at the BOF position.
 o setShowAdd(boolean)
 o setShowCancel(boolean)
 o setShowDelete(boolean)
 o setShowEdit(boolean)
 o setShowMoveFirst(boolean)
 o setShowMoveLast(boolean)
 o setShowMoveNext(boolean)
 o setShowMovePrevious(boolean)
 o setShowRefresh(boolean)
 o setShowState(byte, boolean)
Show or hide a button in the navigator.
 o setShowUpdate(boolean)

Variables

 o ACTION_NONE
  public final static byte ACTION_NONE
constants used in the BOFAction and EOFAction properties
 o ACTION_MOVE_FIRST
  public final static byte ACTION_MOVE_FIRST
 o ACTION_MOVE_LAST
  public final static byte ACTION_MOVE_LAST

Constructors

 o DataNavigator
  public DataNavigator()

Methods

 o getDataSource
  public DataSource getDataSource()
Gets the data source associated with the data navigator.
Returns:
The data source object associated with this data navigator.
 o setDataSource
  public void setDataSource(DataSource source)
Sets the data source associated with the data navigator.
Parameters:
source - The data source to associate with this data navigator.
 o getBOFAction
  public byte getBOFAction()
Determines the behavior of the cursor when the user clicks the data navigator's "up one row" button when the cursor is at the BOF position.
Returns:
One of the following:
  • ACTION_NONE
  • ACTION_MOVE_FIRST
  • ACTION_MOVE_LAST
 o setBOFAction
  public void setBOFAction(byte action)
Specifies the behavior of the cursor when the user clicks the data navigator's "up one row" button when the cursor is at the BOF position.
Parameters:
One - of the following:
  • ACTION_NONE
  • ACTION_MOVE_FIRST
  • ACTION_MOVE_LAST
 o getEOFAction
  public byte getEOFAction()
Determines the behavior of the cursor when the user clicks the data navigator's "down one row" button when the cursor is at the BOF position.
Returns:
One of the following:
  • ACTION_NONE
  • ACTION_MOVE_FIRST
  • ACTION_MOVE_LAST
 o setEOFAction
  public void setEOFAction(byte action)
Specifies the behavior of the cursor when the user clicks the data navigator's "down one row" button when the cursor is at the BOF position.
Returns:
One of the following:
  • ACTION_NONE
  • ACTION_MOVE_FIRST
  • ACTION_MOVE_LAST
 o setShowState
  public void setShowState(byte which,
                           boolean state)
Show or hide a button in the navigator.
Parameters:
which - Specifies which button to show or hide; must be one of the button constants in DataNavigatorButtons.
state - true to show the button; false to hide the button.
Throws: IllegalArgumentException
thrown if 'which' is not a valid number in DataNavigatorButtons.
 o getShowState
  public boolean getShowState(byte which)
Get the show state of a button in the navigator.
Parameters:
which - Specifies which button to test; must be one of the button constants in DataNavigatorButtons.
Returns:
true if the button is showing; false if the button is not.
Throws: IllegalArgumentException
thrown if 'which' is not a valid number in DataNavigatorButtons.
 o setShowAdd
  public void setShowAdd(boolean state)
 o getShowAdd
  public boolean getShowAdd()
 o setShowCancel
  public void setShowCancel(boolean state)
 o getShowCancel
  public boolean getShowCancel()
 o setShowDelete
  public void setShowDelete(boolean state)
 o getShowDelete
  public boolean getShowDelete()
 o setShowEdit
  public void setShowEdit(boolean state)
 o getShowEdit
  public boolean getShowEdit()
 o setShowMoveFirst
  public void setShowMoveFirst(boolean state)
 o getShowMoveFirst
  public boolean getShowMoveFirst()
 o setShowMoveLast
  public void setShowMoveLast(boolean state)
 o getShowMoveLast
  public boolean getShowMoveLast()
 o setShowMoveNext
  public void setShowMoveNext(boolean state)
 o getShowMoveNext
  public boolean getShowMoveNext()
 o setShowMovePrevious
  public void setShowMovePrevious(boolean state)
 o getShowMovePrevious
  public boolean getShowMovePrevious()
 o setShowRefresh
  public void setShowRefresh(boolean state)
 o getShowRefresh
  public boolean getShowRefresh()
 o setShowUpdate
  public void setShowUpdate(boolean state)
 o getShowUpdate
  public boolean getShowUpdate()
 o dataOpen
  public void dataOpen(DataOpenEvent event)
 o dataAvailable
  public void dataAvailable(DataAvailableEvent event)
 o dataClose
  public void dataClose(DataCloseEvent event)
 o adjustCursor
  public void adjustCursor(AdjustCursorEvent __event)
 o createAWTComponent
  protected Component createAWTComponent(Component parent)
Creates the AWT component.
Overrides:
createAWTComponent in class Component

All Packages  Class Hierarchy  This Package  Previous  Next  Index