All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.vaccess.RecordListTablePane

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.ibm.as400.vaccess.RecordListTablePane

public class RecordListTablePane
extends JComponent
implements Serializable
The RecordListTablePane class represents a table that contains the records and fields of an AS/400 file using record-level access.

The data in the table is retrieved from the system when load() is called. If load() is not called, the table will be empty.

Users must call close() to ensure that the AS/400 resources are properly freed when this table is no longer needed.

Most errors are reported by firing ErrorEvents, rather than throwing exceptions. Users should listen for ErrorEvents in order to diagnose and recover from error conditions.

The data in this table is not editable, the individual cell values cannot be changed.

RecordListTablePane objects generate the following events:

// Set up table for file contents.
AS400 system = new AS400("MySystem", "Userid", "Password");
String file = "/QSYS.LIB/QGPL.LIB/MyFile.FILE";
final RecordListTablePane pane = new RecordListTablePane(system, file);
// Set up window to hold table
JFrame frame = new JFrame ("My Window");
WindowListener l = new WindowAdapter()
{
// Close the model when window is closed.
public void windowClosing(WindowEvent e)
{
pane.close();
}
};
frame.addWindowListener(l);
// Set up the error dialog adapter.
pane.addErrorListener (new ErrorDialogAdapter (frame));
// Add the component and get data from system.
frame.getContentPane().add(pane);
pane.load();
// Display the window
frame.setVisible(true)


Variable Index

 o KEY_EQ
Constant indicating search type of equal.
 o KEY_GE
Constant indicating search type of greater than or equal.
 o KEY_GT
Constant indicating search type of greater than.
 o KEY_LE
Constant indicating search type of less than or equal.
 o KEY_LT
Constant indicating search type of less than.

Constructor Index

 o RecordListTablePane()
Constructs a RecordListTablePane object.
 o RecordListTablePane(AS400, String)
Constructs a RecordListTablePane object.
 o RecordListTablePane(AS400, String, Object[], int)
Constructs a RecordListTablePane object.

Method Index

 o addErrorListener(ErrorListener)
Adds a listener to be notified when an error occurs.
 o addListSelectionListener(ListSelectionListener)
Adds a listener to be notified when the selection changes.
 o addPropertyChangeListener(PropertyChangeListener)
Adds a listener to be notified when the value of any bound property is changed.
 o addVetoableChangeListener(VetoableChangeListener)
Adds a listener to be notified when the value of any constrained property is changed.
 o close()
Closes the AS/400 file this table represents.
 o getColumnModel()
Returns the column model for this table.
 o getColumnTitle(int)
Returns the title of a column.
 o getColumnWidth(int)
Returns the width of a column.
 o getDataModel()
Returns the data model for the table.
 o getFileName()
Returns the file name.
 o getGridColor()
Returns the color used to draw grid lines.
 o getKey()
Returns the key.
 o getKeyed()
Returns whether the file will be accessed in key or sequential order.
 o getSearchType()
Returns the search type.
 o getSelectionModel()
Returns the ListSelectionModel that is used to maintain row selection state.
 o getShowHorizontalLines()
Returns whether horizontal lines are drawn between rows.
 o getShowVerticalLines()
Returns whether vertical lines are drawn between columns.
 o getStringValueAt(int, int)
Returns the string value at the specifed row and column.
 o getSystem()
Returns the AS400 where the file is located.
 o getValueAt(int, int)
Returns the value at the specifed row and column.
 o load()
Loads the table based on the state of the system.
 o moveColumn(int, int)
Moves the column and heading at columnIndex to newIndex.
 o refreshHeadings()
Updates the table header to match the data.
 o removeColumn(int)
Removes a column from the table.
 o removeErrorListener(ErrorListener)
Removes a listener from being notified when an error occurs.
 o removeListSelectionListener(ListSelectionListener)
Removes a listener from being notified when the selection changes.
 o removePropertyChangeListener(PropertyChangeListener)
Removes a listener from being notified when the value of any bound property is changed.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes a listener from being notified when the value of any constrained property is changed.
 o setColumnTitle(int, String)
Sets the title of a column.
 o setColumnWidth(int, int)
Sets the width of a column.
 o setFileName(String)
Sets the name of the file.
 o setGridColor(Color)
Sets the color used to draw grid lines.
 o setKey(Object[])
Sets the key.
 o setKeyed(boolean)
Sets whether the file will be accessed in key or sequential order.
 o setSearchType(int)
Sets the search type.
 o setSelectionModel(ListSelectionModel)
Sets the ListSelectionModel that is used to maintain row selection state.
 o setShowHorizontalLines(boolean)
Sets whether horizontal lines are drawn between rows.
 o setShowVerticalLines(boolean)
Sets whether vertical lines are drawn between columns.
 o setSystem(AS400)
Sets the AS400 where the file is located.

Variables

 o KEY_EQ
 public static final int KEY_EQ
Constant indicating search type of equal.

 o KEY_GT
 public static final int KEY_GT
Constant indicating search type of greater than.

 o KEY_GE
 public static final int KEY_GE
Constant indicating search type of greater than or equal.

 o KEY_LT
 public static final int KEY_LT
Constant indicating search type of less than.

 o KEY_LE
 public static final int KEY_LE
Constant indicating search type of less than or equal.

Constructors

 o RecordListTablePane
 public RecordListTablePane()
Constructs a RecordListTablePane object. This constructor sets the keyed property to false.

 o RecordListTablePane
 public RecordListTablePane(AS400 system,
                            String fileName)
Constructs a RecordListTablePane object. This constructor sets the keyed property to false.

Parameters:
system - The AS400 where the file is located.
fileName - The file name. The name is specified as a fully qualified path name in the library file system.
 o RecordListTablePane
 public RecordListTablePane(AS400 system,
                            String fileName,
                            Object key[],
                            int searchType)
Constructs a RecordListTablePane object. This constructor sets the keyed property to true.

Parameters:
system - The AS400 where the file is located.
fileName - The keyed file name. The name is specified as a fully qualified path name in the library file system.
key - The values which make up the key with which to find the record. This value may be null.
searchType - Constant indicating the type of match required.

Methods

 o addErrorListener
 public void addErrorListener(ErrorListener listener)
Adds a listener to be notified when an error occurs.

Parameters:
listener - The listener.
 o addListSelectionListener
 public void addListSelectionListener(ListSelectionListener listener)
Adds a listener to be notified when the selection changes.

Parameters:
listener - The listener.
 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property is changed.

Parameters:
listener - The listener.
Overrides:
addPropertyChangeListener in class JComponent
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property is changed.

Parameters:
listener - The listener.
Overrides:
addVetoableChangeListener in class JComponent
 o close
 public void close()
Closes the AS/400 file this table represents.

 o getColumnModel
 public TableColumnModel getColumnModel()
Returns the column model for this table.

Returns:
The model for this table's columns.
 o getColumnTitle
 public String getColumnTitle(int columnIndex)
Returns the title of a column. This is used for the table column heading. If an error occurs, null is returned.

Parameters:
columnIndex - The index of the column. Indices start at 0.
Returns:
The title of the column.
 o getColumnWidth
 public int getColumnWidth(int columnIndex)
Returns the width of a column. If an error occurs, 0 is returned.

Parameters:
columnIndex - The index of the column. Indices start at 0.
Returns:
The width of the column.
 o getDataModel
 public RecordListTableModel getDataModel()
Returns the data model for the table.

Returns:
The data model for the table.
 o getFileName
 public String getFileName()
Returns the file name. The name is formatted as a fully qualified path name in the library file system.

Returns:
The file name.
 o getGridColor
 public Color getGridColor()
Returns the color used to draw grid lines.

Returns:
The color used to draw grid lines.
 o getKey
 public Object[] getKey()
Returns the key. The key is only used if the keyed property is true.

Returns:
The key.
 o getKeyed
 public boolean getKeyed()
Returns whether the file will be accessed in key or sequential order.

Returns:
true if the file will be accessed in key order; false if the file will be accessed in sequential order.
 o getSearchType
 public int getSearchType()
Returns the search type. The search type is only used if the keyed property is true and the key property is not null.

Returns:
The search type.
 o getSelectionModel
 public ListSelectionModel getSelectionModel()
Returns the ListSelectionModel that is used to maintain row selection state.

Returns:
The model that provides row selection state.
 o getShowHorizontalLines
 public boolean getShowHorizontalLines()
Returns whether horizontal lines are drawn between rows.

Returns:
true if horizontal lines are to be drawn; false otherwise.
 o getShowVerticalLines
 public boolean getShowVerticalLines()
Returns whether vertical lines are drawn between columns.

Returns:
true if vertical lines are to be drawn; false otherwise.
 o getSystem
 public AS400 getSystem()
Returns the AS400 where the file is located.

Returns:
The AS400 where the file is located.
 o getStringValueAt
 public String getStringValueAt(int rowIndex,
                                int columnIndex)
Returns the string value at the specifed row and column. Indices start at 0. If an error occurs, null is returned.

Parameters:
rowIndex - The row index.
columnIndex - The column index.
Returns:
The value at the specified row and column as a string.
 o getValueAt
 public Object getValueAt(int rowIndex,
                          int columnIndex)
Returns the value at the specifed row and column. Indices start at 0. If an error occurs, null is returned.

Parameters:
rowIndex - The row index.
columnIndex - The column index.
Returns:
The value at the specified row and column.
 o load
 public void load()
Loads the table based on the state of the system. The fileName and system properties must be set before this method is called. The table heading is reconstructed to ensure it matches the data, so any column customization will be lost.

 o moveColumn
 public void moveColumn(int columnIndex,
                        int newIndex)
Moves the column and heading at columnIndex to newIndex. The old column at columnIndex will now be found at newIndex, the column that used to be at newIndex is shifted left or right to make room. Indices start at 0.

Parameters:
columnIndex - The index of column to be moved.
newIndex - The new index to move the column to.
 o refreshHeadings
 public void refreshHeadings()
Updates the table header to match the data. Any column customization will be lost.

 o removeColumn
 public void removeColumn(int columnIndex)
Removes a column from the table.

Parameters:
columnIndex - The index of column. Indices start at 0.
 o removeErrorListener
 public void removeErrorListener(ErrorListener listener)
Removes a listener from being notified when an error occurs.

Parameters:
listener - The listener.
 o removeListSelectionListener
 public void removeListSelectionListener(ListSelectionListener listener)
Removes a listener from being notified when the selection changes.

Parameters:
listener - The listener.
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener listener)
Removes a listener from being notified when the value of any bound property is changed.

Parameters:
listener - The listener.
Overrides:
removePropertyChangeListener in class JComponent
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes a listener from being notified when the value of any constrained property is changed.

Parameters:
listener - The listener.
Overrides:
removeVetoableChangeListener in class JComponent
 o setColumnTitle
 public void setColumnTitle(int columnIndex,
                            String title)
Sets the title of a column. This is used for the table column heading.

Parameters:
columnIndex - The index of column. Indices start at 0.
title - The title of the column.
 o setColumnWidth
 public void setColumnWidth(int columnIndex,
                            int width)
Sets the width of a column.

Parameters:
columnIndex - The index of column. Indices start at 0.
width - The column width.
 o setFileName
 public void setFileName(String fileName) throws PropertyVetoException
Sets the name of the file. This property is bound and constrained. Note that the data in the table will not change until a load() is done.

Parameters:
fileName - The file name. The name is specified as a fully qualified path name in the library file system.
Throws: PropertyVetoException
If the change is vetoed.
 o setGridColor
 public void setGridColor(Color color)
Sets the color used to draw grid lines.

Parameters:
color - The color used to draw the grid lines.
 o setKey
 public void setKey(Object key[]) throws PropertyVetoException
Sets the key. This property is bound and constrained. Note that the data in the table will not change until a load() is done. The key is only used if the keyed property is true.

Parameters:
key - The values which make up the key with which to find the record. This value may be null.
Throws: PropertyVetoException
If the change is vetoed.
 o setKeyed
 public void setKeyed(boolean keyed) throws PropertyVetoException
Sets whether the file will be accessed in key or sequential order. This property is bound and constrained. Note that the data in the table will not change until a load() is done.

Parameters:
keyed - true if the file will be accessed in key order; false if the file will be accessed in sequential order.
Throws: PropertyVetoException
If the change is vetoed.
 o setSearchType
 public void setSearchType(int searchType) throws PropertyVetoException
Sets the search type. This property is bound and constrained. Note that the data in the table will not change until a load() is done. The search type is only used if the keyed property is true and the key property is not null.

Parameters:
searchType - Constant indicating the type of match required.
Throws: PropertyVetoException
If the change is vetoed.
 o setSelectionModel
 public void setSelectionModel(ListSelectionModel model)
Sets the ListSelectionModel that is used to maintain row selection state.

Parameters:
model - The model that provides the row selection state.
 o setShowHorizontalLines
 public void setShowHorizontalLines(boolean show)
Sets whether horizontal lines are drawn between rows.

Parameters:
show - true if horizontal lines are to be drawn; false otherwise.
 o setShowVerticalLines
 public void setShowVerticalLines(boolean show)
Sets whether vertical lines are drawn between columns.

Parameters:
show - true if vertical lines are to be drawn; false otherwise.
 o setSystem
 public void setSystem(AS400 system) throws PropertyVetoException
Sets the AS400 where the file is located. This property is bound and constrained. Note that the data in the table will not change until a load() is done.

Parameters:
system - The AS400 where the file is located.
Throws: PropertyVetoException
If the change is vetoed.

All Packages  Class Hierarchy  This Package  Previous  Next  Index