arlut.csd.JTable

Class rowTable

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

arlut.csd.JTable.baseTable

arlut.csd.JTable.rowTable

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.AdjustmentListener, java.awt.event.MouseWheelListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener

public class rowTable
extends baseTable
implements java.awt.event.ActionListener

rowTable is a specialized baseTable, supporting a per-row access model based on a hashtable.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
(package private) rowSelectCallback	callback
(package private) java.util.Vector<rowHandle>	crossref
(package private) static boolean	debug
static java.lang.String	delColStr
(package private) javax.swing.JMenuItem	DeleteColMI
(package private) java.util.Hashtable<java.lang.Object,rowHandle>	index
private int	lastSortColumn
private boolean	lastSortForward
static java.lang.String	menuTitle
private int	olderSortColumn
private boolean	olderSortForward
static java.lang.String	optColWidStr
(package private) javax.swing.JMenuItem	OptimizeMI
(package private) javax.swing.JMenuItem	RevSortByMI
static java.lang.String	revSortByStr
(package private) javax.swing.JPopupMenu	rowMenu
(package private) java.lang.Object	rowSelectedKey The hash key for the selected row, or null if no row is selected.
(package private) javax.swing.JMenuItem	SortByMI
static java.lang.String	sortByStr
(package private) static TranslationService	ts TranslationService object for handling string localization in the Ganymede client.

Fields inherited from class arlut.csd.JTable.baseTable

bounding_rect, canvas, colPos, cols, hbar, hbar_visible, headerAttrib, headerMenu, hHeadLineColor, hHeadLineThickness, horizLines, hRowLineColor, hRowLineThickness, hVertFill, in, menu, menuCol, menuRow, origTotalWidth, row_baseline, row_height, rows, rowsToShow, scalefact, selectedRow, tableAttrib, vbar, vbar_visible, vertFill, vertLines, vHeadLineColor, vLineThickness, vRowLineColor

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 java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
rowTable(int[] colWidths, java.lang.String[] headers, rowSelectCallback callback, boolean horizLines, javax.swing.JPopupMenu menu, boolean allowDeleteColumn) Constructor with default fonts, justification, and behavior
rowTable(int[] colWidths, java.lang.String[] headers, rowSelectCallback callback, javax.swing.JPopupMenu menu, boolean allowDeleteColumn) Constructor with default fonts, justification, and behavior
rowTable(tableAttr headerAttrib, tableAttr tableAttrib, tableAttr[] colAttribs, int[] colWidths, java.awt.Color vHeadLineColor, java.awt.Color vRowLineColor, java.awt.Color hHeadLineColor, java.awt.Color hRowLineColor, java.lang.String[] headers, boolean horizLines, boolean vertLines, boolean vertFill, boolean hVertFill, rowSelectCallback callback, javax.swing.JPopupMenu menu, boolean allowDeleteColumn) This is the base constructor for rowTable, which allows all aspects of the rowTable's appearance and behavior to be customized.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Method used to handle the popup menu
void	clearCells() Erases all the cells in the table and removes any per-cell attribute sets.
void	clickInCell(int x, int y, boolean rightButton) Hook for subclasses to implement selection logic
boolean	containsKey(java.lang.Object key) Returns true if a key is already in use in the table
void	deleteRow(java.lang.Object key, boolean repaint) Deletes a row.
void	doubleClickInCell(int x, int y) Hook for subclasses to implement selection logic
private rowHandle	findRow(int y)
tableCell	getCell(java.lang.Object key, int col) Gets a cell based on hashkey
tableAttr	getCellAttr(java.lang.Object key, int col) Gets the tableAttr of a cell in the table.
java.lang.String	getCellText(java.lang.Object key, int col) Gets the contents of a cell in the table.
java.lang.Object	getSelectedRow()
java.lang.String	getSortPref() Gets the sort preferences for this rowTable as a String encoding suitable for storage in a Java Prefrences object.
java.util.Enumeration	keys() Return an enumeration of the keys in the table
void	newRow(java.lang.Object key) Creates a new row, adds it to the hashtable
void	resort(boolean repaint) Sort by the last two sort columns and sort orders, if set.
void	resort(int column, boolean forward, boolean repaint) Do a sort by column and forward direction.
void	selectRow(java.lang.Object key, boolean refreshTable) This method unselects any rows currently selected that do not match key and selects the row that does match key (if any).
void	setCellAttr(java.lang.Object key, int col, tableAttr attr, boolean repaint) Sets the tableAttr of a cell in the table.
void	setCellBackColor(java.lang.Object key, int col, java.awt.Color color, boolean repaint) Sets the background color of a cell A color of (Color) null will cause baseTable to revert to using the background selected for the column (if defined) or the background for the table.
void	setCellColor(java.lang.Object key, int col, java.awt.Color color, boolean repaint) Sets the foreground color of a cell A color of (Color) null will cause baseTable to revert to using the foreground selected for the column (if defined) or the foreground for the table.
void	setCellFont(java.lang.Object key, int col, java.awt.Font font, boolean repaint) Sets the font of a cell in the table.
void	setCellJust(java.lang.Object key, int col, int just, boolean repaint) Sets the justification of a cell in the table.
void	setCellText(java.lang.Object key, int col, java.lang.String cellText, boolean repaint) Sets the contents of a cell in the table.
void	setCellText(java.lang.Object key, int col, java.lang.String cellText, java.lang.Object data, boolean repaint) Sets the contents of a cell in the table.
void	setSortPref(java.lang.String sortPref) Sets the sort preferences for this rowTable from a String encoding suitable for storage in a Java Prefrences object.
void	unSelectAll() Unselect all cells.. override of a baseTable method.
void	unSelectRow() This method unselects the currently selected row.

Methods inherited from class arlut.csd.JTable.baseTable

addRow, adjustmentValueChanged, adjustScrollbars, calcCols, calcFonts, calcVSize, clickInCell, deleteColumn, deleteRow, displayRegionFirstLine, dispose, getCell, getCellAttr, getCellText, getCellText, getColCount, getRowCount, getTableHeaders, getWrappedCellText, getWrappedCellText, mouseWheelMoved, optimizeCols, reCalcRowPos, refreshTable, reinitialize, reinitialize, reShape, scrollRowTo, selectCell, selectCol, selectRow, setBounds, setCellAttr, setCellBackColor, setCellColor, setCellFont, setCellJust, setCellText, setColAttr, setColBackColor, setColColor, setColFont, setColJust, setHeadAttr, setHeadBackColor, setHeadColor, setHeadFont, setRows, setRowsVisible, setTableAttr, setTableBackColor, setTableColor, setTableFont, setTableJust, testCellSelected, testColSelected, testRowSelected, unSelectCell, unSelectCol, unSelectRow

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

debug

static final boolean debug

See Also:

Constant Field Values

ts

static final TranslationService ts

TranslationService object for handling string localization in the Ganymede client.

menuTitle

public static final java.lang.String menuTitle

sortByStr

public static final java.lang.String sortByStr

revSortByStr

public static final java.lang.String revSortByStr

delColStr

public static final java.lang.String delColStr

optColWidStr

public static final java.lang.String optColWidStr

index

java.util.Hashtable<java.lang.Object,rowHandle> index

crossref

java.util.Vector<rowHandle> crossref

callback

rowSelectCallback callback

rowMenu

javax.swing.JPopupMenu rowMenu

SortByMI

javax.swing.JMenuItem SortByMI

RevSortByMI

javax.swing.JMenuItem RevSortByMI

DeleteColMI

javax.swing.JMenuItem DeleteColMI

OptimizeMI

javax.swing.JMenuItem OptimizeMI

lastSortColumn

private int lastSortColumn

lastSortForward

private boolean lastSortForward

olderSortColumn

private int olderSortColumn

olderSortForward

private boolean olderSortForward

rowSelectedKey

java.lang.Object rowSelectedKey

The hash key for the selected row, or null if no row is selected.

Constructor Detail

rowTable

public rowTable(tableAttr headerAttrib,
        tableAttr tableAttrib,
        tableAttr[] colAttribs,
        int[] colWidths,
        java.awt.Color vHeadLineColor,
        java.awt.Color vRowLineColor,
        java.awt.Color hHeadLineColor,
        java.awt.Color hRowLineColor,
        java.lang.String[] headers,
        boolean horizLines,
        boolean vertLines,
        boolean vertFill,
        boolean hVertFill,
        rowSelectCallback callback,
        javax.swing.JPopupMenu menu,
        boolean allowDeleteColumn)

This is the base constructor for rowTable, which allows all aspects of the rowTable's appearance and behavior to be customized.

Parameters:

headerAttrib - attribute set for the column headers

tableAttrib - default attribute set for the body of the table

colAttribs - per column attribute sets

colWidths - array of initial column widths

vHeadLineColor - color of vertical lines in the column headers, if any

vRowLineColor - color of vertical lines in the table body, if any

hHeadLineColor - color of horizontal lines in the column headers, if any

hRowLineColor - color of vertical lines in the table body, if any

headers - array of column header titles, must be same size as colWidths

horizLines - true if horizontal lines should be shown between rows in report table

vertLines - true if vertical lines should be shown between columns in report table

vertFill - true if table should expand vertically to fill size of baseTable

hVertFill - true if horizontal lines should be drawn in the vertical fill region (only applies if vertFill and horizLines are true)

callback - reference to an object that implements the rowSelectCallback interface

menu - reference to a popup menu to be associated with rows in this table

allowDeleteColumn - if true, a 'Delete This Column' menu item will be added to the per-column popup menu

rowTable

public rowTable(int[] colWidths,
        java.lang.String[] headers,
        rowSelectCallback callback,
        boolean horizLines,
        javax.swing.JPopupMenu menu,
        boolean allowDeleteColumn)

Constructor with default fonts, justification, and behavior

Parameters:

colWidths - array of initial column widths

headers - array of column header titles, must be same size as colWidths

callback - reference to an object that implements the rowSelectCallback interface

horizLines - draw horizontal lines between rows?

menu - reference to a popup menu to be associated with rows in this table

rowTable

public rowTable(int[] colWidths,
        java.lang.String[] headers,
        rowSelectCallback callback,
        javax.swing.JPopupMenu menu,
        boolean allowDeleteColumn)

Constructor with default fonts, justification, and behavior

Parameters:

colWidths - array of initial column widths

headers - array of column header titles, must be same size as colWidths

callback - reference to an object that implements the rowSelectCallback interface

menu - reference to a popup menu to be associated with rows in this table

Method Detail

clickInCell

public void clickInCell(int x,
               int y,
               boolean rightButton)

Hook for subclasses to implement selection logic

Overrides:

clickInCell in class baseTable

Parameters:

x - col of cell clicked in

y - row of cell clicked in

rightButton - if true, the cell click was with the right button

doubleClickInCell

public void doubleClickInCell(int x,
                     int y)

Hook for subclasses to implement selection logic

Overrides:

doubleClickInCell in class baseTable

Parameters:

x - col of cell double clicked in

y - row of cell double clicked in

unSelectAll

public void unSelectAll()

Unselect all cells.. override of a baseTable method.

Overrides:

unSelectAll in class baseTable

getSelectedRow

public java.lang.Object getSelectedRow()

selectRow

public void selectRow(java.lang.Object key,
             boolean refreshTable)

This method unselects any rows currently selected that do not match key and selects the row that does match key (if any).

Parameters:

key - The key to the row to be selected

unSelectRow

public void unSelectRow()

This method unselects the currently selected row.

clearCells

public void clearCells()

Erases all the cells in the table and removes any per-cell attribute sets.

Overrides:

clearCells in class baseTable

newRow

public void newRow(java.lang.Object key)

Creates a new row, adds it to the hashtable

Parameters:

key - A hashtable key to be used to refer to this row in the future

deleteRow

public void deleteRow(java.lang.Object key,
             boolean repaint)

Deletes a row.

Parameters:

key - A hashtable key for the row to delete

repaint - true if the table should be redrawn after the row is deleted

getCell

public tableCell getCell(java.lang.Object key,
                int col)

Gets a cell based on hashkey

Parameters:

key - A hashtable key for the row of the cell

col - Column number, range 0..# of columns - 1

setCellText

public final void setCellText(java.lang.Object key,
               int col,
               java.lang.String cellText,
               boolean repaint)

Sets the contents of a cell in the table.

Parameters:

key - key to the row of the cell to be changed

col - column of the cell to be changed

cellText - the text to place into cell

repaint - true if the table should be redrawn after changing cell

setCellText

public final void setCellText(java.lang.Object key,
               int col,
               java.lang.String cellText,
               java.lang.Object data,
               boolean repaint)

Sets the contents of a cell in the table.

Parameters:

key - key to the row of the cell to be changed

col - column of the cell to be changed

cellText - the text to place into cell

data - A piece of data to be held with this cell, will be used for sorting

repaint - true if the table should be redrawn after changing cell

getCellText

public final java.lang.String getCellText(java.lang.Object key,
                           int col)

Gets the contents of a cell in the table.

Parameters:

key - key to the row of the cell

col - column of the cell

setCellAttr

public final void setCellAttr(java.lang.Object key,
               int col,
               tableAttr attr,
               boolean repaint)

Sets the tableAttr of a cell in the table.

Parameters:

key - key to the row of the cell to be changed

col - column of the cell to be changed

attr - the tableAttr to assign to cell

repaint - true if the table should be redrawn after changing cell

getCellAttr

public final tableAttr getCellAttr(java.lang.Object key,
                    int col)

Gets the tableAttr of a cell in the table.

Parameters:

key - key to the row of the cell

col - column of the cell

setCellFont

public final void setCellFont(java.lang.Object key,
               int col,
               java.awt.Font font,
               boolean repaint)

Sets the font of a cell in the table. A font of (Font) null will cause baseTable to revert to using the table or column's default font for this cell.

Parameters:

key - key to the row of the cell

col - column of the cell

font - the Font to assign to cell, may be null to use default

repaint - true if the table should be redrawn after changing cell

setCellJust

public final void setCellJust(java.lang.Object key,
               int col,
               int just,
               boolean repaint)

Sets the justification of a cell in the table. Use tableAttr.JUST_INHERIT to have this cell use default justification

Parameters:

key - key to the row of the cell

col - column of the cell

just - the justification to assign to cell

repaint - true if the table should be redrawn after changing cell

See Also:

tableAttr

setCellColor

public final void setCellColor(java.lang.Object key,
                int col,
                java.awt.Color color,
                boolean repaint)

Sets the foreground color of a cell A color of (Color) null will cause baseTable to revert to using the foreground selected for the column (if defined) or the foreground for the table.

Parameters:

key - key to the row of the cell

col - column of the cell

color - the Color to assign to cell

repaint - true if the table should be redrawn after changing cell

setCellBackColor

public final void setCellBackColor(java.lang.Object key,
                    int col,
                    java.awt.Color color,
                    boolean repaint)

Sets the background color of a cell A color of (Color) null will cause baseTable to revert to using the background selected for the column (if defined) or the background for the table.

Parameters:

key - key to the row of the cell

col - column of the cell

color - the Color to assign to cell

repaint - true if the table should be redrawn after changing cell

containsKey

public boolean containsKey(java.lang.Object key)

Returns true if a key is already in use in the table

Parameters:

key - key to look for in the table

keys

public java.util.Enumeration keys()

Return an enumeration of the keys in the table

actionPerformed

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

Method used to handle the popup menu

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class baseTable

setSortPref

public void setSortPref(java.lang.String sortPref)

Sets the sort preferences for this rowTable from a String encoding suitable for storage in a Java Prefrences object.

getSortPref

public java.lang.String getSortPref()

Gets the sort preferences for this rowTable as a String encoding suitable for storage in a Java Prefrences object.

resort

public void resort(boolean repaint)

Sort by the last two sort columns and sort orders, if set.

resort

public void resort(int column,
          boolean forward,
          boolean repaint)

Do a sort by column and forward direction.

findRow

private rowHandle findRow(int y)