csheets.ui.sheet
Class SpreadsheetTable

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JTable
                  csheets.ui.grid.Grid
                      csheets.ui.sheet.SpreadsheetTable

All Implemented Interfaces:

SelectionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, CellEditorListener, ListSelectionListener, TableColumnModelListener, TableModelListener, Scrollable

public class SpreadsheetTable
extends Grid
implements SelectionListener

A customized JTable component, used to visualize a spreadsheet.

Author:

Einar Pehrson

See Also:

Serialized Form

Nested Class Summary

protected class

SpreadsheetTable.ClearSelectionAction An action for clearing the content of the selected cells, without invoking the editor.

Nested classes/interfaces inherited from class csheets.ui.grid.Grid

Grid.ResumeEditAction

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

JTable.AccessibleJTable, JTable.PrintMode

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static String

CLEAR_SELECTION_COMMAND The action command used for the action

Fields inherited from class csheets.ui.grid.Grid

RESUME_EDIT_COMMAND

Fields inherited from class javax.swing.JTable

AUTO_RESIZE_ALL_COLUMNS, AUTO_RESIZE_LAST_COLUMN, AUTO_RESIZE_NEXT_COLUMN, AUTO_RESIZE_OFF, AUTO_RESIZE_SUBSEQUENT_COLUMNS, autoCreateColumnsFromModel, autoResizeMode, cellEditor, cellSelectionEnabled, columnModel, dataModel, defaultEditorsByColumnClass, defaultRenderersByColumnClass, editingColumn, editingRow, editorComp, gridColor, preferredViewportSize, rowHeight, rowMargin, rowSelectionAllowed, selectionBackground, selectionForeground, selectionModel, showHorizontalLines, showVerticalLines, tableHeader

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

SpreadsheetTable(SpreadsheetTableModel tableModel, UIController uiController)
Creates a spreadsheet table for the given spreadsheet table model.

SpreadsheetTable(Spreadsheet spreadsheet, UIController uiController)
Creates a spreadsheet table for the given spreadsheet.

Method Summary

void	changeSelection(int row, int column, boolean toggle, boolean extend) Changes the current selection in the table.
void	clearSelectedCells() Clears the currently selected cells in the table.
Cell	getSelectedCell() Returns the active cell of the spreadsheet table.
Cell[][]	getSelectedCells() Returns the currently selected cells in the spreadsheet table.
Spreadsheet	getSpreadsheet() Returns the spreadsheet that the table displays.
protected void	paintComponent(Graphics g) Overridden to delegate painting to decorators.
void	selectAll() Selects all cells in the spreadsheet table.
void	selectionChanged(SelectionEvent event) Updates the selection in the table when the active cell is changed.
void	setModel(TableModel dataModel) Sets the data model of the table.
void	setRowHeight(int row, int rowHeight) Sets the height for row to rowHeight, revalidates, and repaints.
void	setSpreadsheet(Spreadsheet spreadsheet) Sets the spreadsheet that is displayed by the table.

Methods inherited from class csheets.ui.grid.Grid

configureEnclosingScrollPane, processKeyBinding, unconfigureEnclosingScrollPane

Methods inherited from class javax.swing.JTable

addColumn, addColumnSelectionInterval, addNotify, addRowSelectionInterval, clearSelection, columnAdded, columnAtPoint, columnMarginChanged, columnMoved, columnRemoved, columnSelectionChanged, convertColumnIndexToModel, convertColumnIndexToView, createDefaultColumnModel, createDefaultColumnsFromModel, createDefaultDataModel, createDefaultEditors, createDefaultRenderers, createDefaultSelectionModel, createDefaultTableHeader, createScrollPaneForTable, doLayout, editCellAt, editCellAt, editingCanceled, editingStopped, getAccessibleContext, getAutoCreateColumnsFromModel, getAutoResizeMode, getCellEditor, getCellEditor, getCellRect, getCellRenderer, getCellSelectionEnabled, getColumn, getColumnClass, getColumnCount, getColumnModel, getColumnName, getColumnSelectionAllowed, getDefaultEditor, getDefaultRenderer, getDragEnabled, getEditingColumn, getEditingRow, getEditorComponent, getGridColor, getIntercellSpacing, getModel, getPreferredScrollableViewportSize, getPrintable, getRowCount, getRowHeight, getRowHeight, getRowMargin, getRowSelectionAllowed, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedColumn, getSelectedColumnCount, getSelectedColumns, getSelectedRow, getSelectedRowCount, getSelectedRows, getSelectionBackground, getSelectionForeground, getSelectionModel, getShowHorizontalLines, getShowVerticalLines, getSurrendersFocusOnKeystroke, getTableHeader, getToolTipText, getUI, getUIClassID, getValueAt, initializeLocalVars, isCellEditable, isCellSelected, isColumnSelected, isEditing, isRowSelected, moveColumn, paramString, prepareEditor, prepareRenderer, print, print, print, print, removeColumn, removeColumnSelectionInterval, removeEditor, removeNotify, removeRowSelectionInterval, resizeAndRepaint, rowAtPoint, setAutoCreateColumnsFromModel, setAutoResizeMode, setCellEditor, setCellSelectionEnabled, setColumnModel, setColumnSelectionAllowed, setColumnSelectionInterval, setDefaultEditor, setDefaultRenderer, setDragEnabled, setEditingColumn, setEditingRow, setGridColor, setIntercellSpacing, setPreferredScrollableViewportSize, setRowHeight, setRowMargin, setRowSelectionAllowed, setRowSelectionInterval, setSelectionBackground, setSelectionForeground, setSelectionMode, setSelectionModel, setShowGrid, setShowHorizontalLines, setShowVerticalLines, setSurrendersFocusOnKeystroke, setTableHeader, setUI, setValueAt, sizeColumnsToFit, sizeColumnsToFit, tableChanged, updateUI, valueChanged

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getWidth, getVisibleRect, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, 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

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, 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, 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, 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, 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

Field Detail

CLEAR_SELECTION_COMMAND

public static final String CLEAR_SELECTION_COMMAND

The action command used for the action

See Also:

Constant Field Values

Constructor Detail

SpreadsheetTable

public SpreadsheetTable(Spreadsheet spreadsheet,
                        UIController uiController)

Creates a spreadsheet table for the given spreadsheet.

Parameters:

spreadsheet - the spreadsheet to display in the table

uiController - the user interface controller

SpreadsheetTable

public SpreadsheetTable(SpreadsheetTableModel tableModel,
                        UIController uiController)

Creates a spreadsheet table for the given spreadsheet table model.

Parameters:

tableModel - the spreadsheet table model to display in the table

uiController - the user interface controller

Method Detail

getSpreadsheet

public Spreadsheet getSpreadsheet()

Returns the spreadsheet that the table displays.

Returns:

the spreadsheet that the table displays.

setSpreadsheet

public void setSpreadsheet(Spreadsheet spreadsheet)

Sets the spreadsheet that is displayed by the table.

Parameters:

spreadsheet - the spreadsheet that is displayed by the table

setModel

public void setModel(TableModel dataModel)

Sets the data model of the table. Overridden to only accept instances of the SpreadsheetTableModel class.

Overrides:

setModel in class JTable

Parameters:

dataModel - the new data source for this table, must be a SpreadsheetTableModel

getSelectedCell

public Cell getSelectedCell()

Returns the active cell of the spreadsheet table.

Returns:

the active cell of the spreadsheet table

getSelectedCells

public Cell[][] getSelectedCells()

Returns the currently selected cells in the spreadsheet table.

Returns:

a two-dimensional array of the the currently selected cells in the spreadsheet table

clearSelectedCells

public void clearSelectedCells()

Clears the currently selected cells in the table.

changeSelection

public void changeSelection(int row,
                            int column,
                            boolean toggle,
                            boolean extend)

Changes the current selection in the table. Overridden to update the user interface controller as well.

Overrides:

changeSelection in class Grid

Parameters:

row - the row that was selected

column - the column that was selected

toggle - whether the selection should be toggled

extend - whether the selection should be extended

selectAll

public void selectAll()

Selects all cells in the spreadsheet table.

Overrides:

selectAll in class JTable

selectionChanged

public void selectionChanged(SelectionEvent event)

Updates the selection in the table when the active cell is changed.

Specified by:

selectionChanged in interface SelectionListener

Parameters:

event - the selection event that was fired

paintComponent

protected void paintComponent(Graphics g)

Overridden to delegate painting to decorators.

Overrides:

paintComponent in class JComponent

Parameters:

g - the Graphics object to protect

setRowHeight

public void setRowHeight(int row,
                         int rowHeight)

Sets the height for row to rowHeight, revalidates, and repaints. The height of the cells in this row will be equal to the row height minus the row margin.

Overrides:

setRowHeight in class JTable

Parameters:

row - - the row whose height is being changed

rowHeight - - new row height, in pixels

Throws:

IllegalArgumentException - if rowHeight is less than 1