Package adams.gui.core
Class SpreadSheetTableWithButtons
-
- All Implemented Interfaces:
SpreadSheetSupporter
,JTableSupporter<BaseTable>
,ImageObserver
,MenuContainer
,Serializable
,Accessible
- Direct Known Subclasses:
SpreadSheetTableWithSearch
public class SpreadSheetTableWithButtons extends BaseTableWithButtons
Graphical component that consists of a SpreadSheetTable with buttons on the right-hand side.- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
-
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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
-
Field Summary
-
Fields inherited from class adams.gui.core.BaseTableWithButtons
m_CountModelListener
-
Fields inherited from class adams.gui.core.AbstractDoubleClickableComponentWithButtons
m_DoubleClickAction, m_DoubleClickButton
-
Fields inherited from class adams.gui.core.AbstractComponentWithButtons
m_Component, m_LabelInfo, m_PanelAll, m_PanelInfo, m_ScrollPane
-
Fields inherited from class adams.gui.core.BasePanelWithButtons
m_LayoutButtons, m_PanelButtons
-
Fields inherited from class adams.gui.core.BasePanel
m_FileChooser
-
Fields inherited from class javax.swing.JComponent
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
accessibleContext, 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 Description SpreadSheetTableWithButtons()
The default constructor.SpreadSheetTableWithButtons(SpreadSheetTableModel model)
Initializes the table with the specified model.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected BaseTable
createComponent()
Creates the component to use in the panel.PopupMenuCustomizer
getCellPopupMenuCustomizer()
Returns the current popup menu customizer (for the cells).CellRenderingCustomizer
getCellRenderingCustomizer()
Returns the renderer.BaseTable.ColumnWidthApproach
getColumnWidthApproach()
Returns the strategy for setting optimal column widths.PopupMenuCustomizer
getHeaderPopupMenuCustomizer()
Returns the current popup menu customizer (for the header).SpreadSheetTableModel
getModel()
Returns the underlying table model.String
getSeachString()
Returns the current search string.boolean
getShowCellTypes()
Returns whether to show the cell types rather than the cell values.boolean
getShowFormulas()
Returns whether to display the formulas or their calculated values.boolean
getShowRowColumn()
Returns whether the column with the row numbers is displayed.boolean
getUseSimpleHeader()
Returns whether to display a simple header or an HTML one with the column indices.boolean
isModified()
Returns whether the table has been modified.boolean
isReadOnly()
Returns whether the table is read-only.boolean
isRegExpSearch()
Returns whether the last search was a regular expression based one.void
search(String searchString, boolean regexp)
Performs a search for the given string.void
setCellPopupMenuCustomizer(PopupMenuCustomizer value)
Sets the popup menu customizer to use (for the cells).void
setCellRenderingCustomizer(CellRenderingCustomizer value)
Sets the renderer.void
setColumnWidthApproach(BaseTable.ColumnWidthApproach value)
Sets the strategy for setting optimal column widths.void
setHeaderPopupMenuCustomizer(PopupMenuCustomizer value)
Sets the popup menu customizer to use (for the header).void
setModel(TableModel dataModel)
Sets the data model for this table tonewModel
and registers with it for listener notifications from the new data model.void
setModified(boolean value)
Sets whether the table has been modified.void
setReadOnly(boolean value)
Sets whether the table is read-only.void
setShowCellTypes(boolean value)
Sets whether to show the cell types rather than the cell values.void
setShowFormulas(boolean value)
Sets whether to display the formulas or their calculated values.void
setShowRowColumn(boolean value)
Whether to display the column with the row numbers.void
setUseSimpleHeader(boolean value)
Whether to display a simple header or an HTML one with the column indices.void
sort(RowComparator comparator)
Sorts the spreadsheet with the given comparator.SpreadSheet
toSpreadSheet()
Returns the underlying sheet.SpreadSheet
toSpreadSheet(TableRowRange range)
Returns the underlying sheet.SpreadSheet
toSpreadSheet(TableRowRange range, boolean view)
Returns the underlying sheet.-
Methods inherited from class adams.gui.core.BaseTableWithButtons
addCellPopupMenuListener, addHeaderPopupMenuListener, addRemoveItemsListener, canMoveDown, canMoveUp, getAutoResizeMode, getColumnClass, getColumnCount, getColumnModel, getColumnName, getColumnWidths, getRowCount, getRowHeight, getSelectedColumn, getSelectedColumnCount, getSelectedColumns, getSelectedRow, getSelectedRowCount, getSelectedRows, getSelectionModel, getShowSimpleCellPopupMenu, getShowSimpleHeaderPopupMenu, getTable, getValueAt, isCellEditable, isCellSelected, isColumnSelected, isRowSelected, isValidDoubleClick, moveBottom, moveDown, moveTop, moveUp, removeCellPopupMenuListener, removeHeaderPopupMenuListener, removeRemoveItemsListener, requiresScrollPane, rowAtPoint, scrollColumnToVisible, scrollRowToVisible, setAutoResizeMode, setColumnModel, setColumnWidths, setInfoVisible, setOptimalColumnWidth, setOptimalColumnWidth, setOptimalColumnWidthBounded, setOptimalColumnWidthBounded, setRowHeight, setSelectedRow, setSelectedRows, setSelectionMode, setSelectionModel, setShowSimpleCellPopupMenu, setShowSimpleHeaderPopupMenu, setShowSimplePopupMenus, setValueAt, showCell, supportsMovingRows, updateCounts, updateCountsModelListener
-
Methods inherited from class adams.gui.core.AbstractDoubleClickableComponentWithButtons
getDoubleClickAction, getDoubleClickButton, initGUI, setDoubleClickAction, setDoubleClickButton
-
Methods inherited from class adams.gui.core.AbstractComponentWithButtons
addKeyListener, getComponent, getScrollPane, isInfoVisible, removeKeyListener, updateInfo
-
Methods inherited from class adams.gui.core.BasePanelWithButtons
addToButtonsPanel, clearButtonsPanel, removeFromButtonsPanel
-
Methods inherited from class adams.gui.core.BasePanel
afterHide, afterShow, beforeHide, beforeShow, closeParent, finishInit, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initFileChooser, initialize, main, printErrorMessage, printException, saveComponent, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible
-
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
-
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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, unregisterKeyboardAction, update
-
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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Constructor Detail
-
SpreadSheetTableWithButtons
public SpreadSheetTableWithButtons()
The default constructor.
-
SpreadSheetTableWithButtons
public SpreadSheetTableWithButtons(SpreadSheetTableModel model)
Initializes the table with the specified model.- Parameters:
model
- the model to use
-
-
Method Detail
-
createComponent
protected BaseTable createComponent()
Creates the component to use in the panel. If a- Overrides:
createComponent
in classBaseTableWithButtons
- Returns:
- the component
-
setModel
public void setModel(TableModel dataModel)
Sets the data model for this table tonewModel
and registers with it for listener notifications from the new data model.- Overrides:
setModel
in classBaseTableWithButtons
- Parameters:
dataModel
- the new data source for this table- See Also:
getModel()
-
getModel
public SpreadSheetTableModel getModel()
Returns the underlying table model.- Overrides:
getModel
in classBaseTableWithButtons
- Returns:
- the underlying table model
-
setHeaderPopupMenuCustomizer
public void setHeaderPopupMenuCustomizer(PopupMenuCustomizer value)
Sets the popup menu customizer to use (for the header).- Parameters:
value
- the customizer, null to remove it
-
getHeaderPopupMenuCustomizer
public PopupMenuCustomizer getHeaderPopupMenuCustomizer()
Returns the current popup menu customizer (for the header).- Returns:
- the customizer, null if none set
-
setCellPopupMenuCustomizer
public void setCellPopupMenuCustomizer(PopupMenuCustomizer value)
Sets the popup menu customizer to use (for the cells).- Parameters:
value
- the customizer, null to remove it
-
getCellPopupMenuCustomizer
public PopupMenuCustomizer getCellPopupMenuCustomizer()
Returns the current popup menu customizer (for the cells).- Returns:
- the customizer, null if none set
-
setCellRenderingCustomizer
public void setCellRenderingCustomizer(CellRenderingCustomizer value)
Sets the renderer.- Parameters:
value
- the renderer
-
getCellRenderingCustomizer
public CellRenderingCustomizer getCellRenderingCustomizer()
Returns the renderer.- Returns:
- the renderer
-
setShowFormulas
public void setShowFormulas(boolean value)
Sets whether to display the formulas or their calculated values.- Parameters:
value
- true if to display the formulas rather than the calculated values
-
getShowFormulas
public boolean getShowFormulas()
Returns whether to display the formulas or their calculated values.- Returns:
- true if to display the formulas rather than the calculated values
-
setShowRowColumn
public void setShowRowColumn(boolean value)
Whether to display the column with the row numbers.- Parameters:
value
- true if to display column
-
getShowRowColumn
public boolean getShowRowColumn()
Returns whether the column with the row numbers is displayed.- Returns:
- true if column displayed
-
setUseSimpleHeader
public void setUseSimpleHeader(boolean value)
Whether to display a simple header or an HTML one with the column indices.- Parameters:
value
- true if to display simple header
-
getUseSimpleHeader
public boolean getUseSimpleHeader()
Returns whether to display a simple header or an HTML one with the column indices.- Returns:
- true if simple header displayed
-
setReadOnly
public void setReadOnly(boolean value)
Sets whether the table is read-only.- Parameters:
value
- true if read-only
-
isReadOnly
public boolean isReadOnly()
Returns whether the table is read-only.- Returns:
- true if read-only
-
setModified
public void setModified(boolean value)
Sets whether the table has been modified.- Parameters:
value
- true if modified
-
isModified
public boolean isModified()
Returns whether the table has been modified.- Returns:
- true if modified
-
setShowCellTypes
public void setShowCellTypes(boolean value)
Sets whether to show the cell types rather than the cell values.- Parameters:
value
- true if to show cell types
-
getShowCellTypes
public boolean getShowCellTypes()
Returns whether to show the cell types rather than the cell values.- Returns:
- true if showing the cell types
-
sort
public void sort(RowComparator comparator)
Sorts the spreadsheet with the given comparator.- Parameters:
comparator
- the row comparator to use
-
search
public void search(String searchString, boolean regexp)
Performs a search for the given string. Limits the display of rows to ones containing the search string.- Parameters:
searchString
- the string to search forregexp
- whether to perform regular expression matching or just plain string comparison
-
getSeachString
public String getSeachString()
Returns the current search string.- Returns:
- the search string, null if not filtered
-
isRegExpSearch
public boolean isRegExpSearch()
Returns whether the last search was a regular expression based one.- Returns:
- true if last search was a reg exp one
-
toSpreadSheet
public SpreadSheet toSpreadSheet()
Returns the underlying sheet.- Specified by:
toSpreadSheet
in interfaceSpreadSheetSupporter
- Overrides:
toSpreadSheet
in classBaseTableWithButtons
- Returns:
- the spread sheet
-
toSpreadSheet
public SpreadSheet toSpreadSheet(TableRowRange range)
Returns the underlying sheet.- Parameters:
range
- the type of rows to return- Returns:
- the spread sheet
-
toSpreadSheet
public SpreadSheet toSpreadSheet(TableRowRange range, boolean view)
Returns the underlying sheet.- Parameters:
range
- the type of rows to returnview
- whether to return only a view (ignored ifTableRowRange.ALL
)- Returns:
- the spread sheet
-
setColumnWidthApproach
public void setColumnWidthApproach(BaseTable.ColumnWidthApproach value)
Sets the strategy for setting optimal column widths.- Parameters:
value
- the strategy
-
getColumnWidthApproach
public BaseTable.ColumnWidthApproach getColumnWidthApproach()
Returns the strategy for setting optimal column widths. Default implementation is initialized with "NONE".- Returns:
- the strategy
-
-