com.jivesoftware.spark.component
Class JiveSortableTable

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JTable
                  extended bycom.jidesoft.grid.JideTable
                      extended bycom.jidesoft.grid.ContextSensitiveTable
                          extended bycom.jidesoft.grid.CellStyleTable
                              extended bycom.jidesoft.grid.CellSpanTable
                                  extended bycom.jidesoft.grid.l
                                      extended bycom.jidesoft.grid.SortableTable
                                          extended bycom.jivesoftware.spark.component.JiveSortableTable
All Implemented Interfaces:
javax.accessibility.Accessible, javax.swing.event.CellEditorListener, java.util.EventListener, java.awt.image.ImageObserver, javax.swing.event.ListSelectionListener, java.awt.MenuContainer, javax.swing.Scrollable, java.io.Serializable, javax.swing.event.TableColumnModelListener, javax.swing.event.TableModelListener

public abstract class JiveSortableTable
extends com.jidesoft.grid.SortableTable

JiveTable class can be used to maintain quality look and feel throughout the product. This is mainly from the rendering capabilities.

Version:
1.0, 03/12/14
See Also:
Serialized Form

Nested Class Summary
 class JiveSortableTable.ComboBoxRenderer
           
 class JiveSortableTable.JButtonRenderer
          A swing renderer used to display Buttons within a table.
static class JiveSortableTable.JiveTableModel
          The internal Table Model.
 class JiveSortableTable.JLabelRenderer
          A swing renderer used to display labels within a table.
 class JiveSortableTable.MyComboBoxEditor
           
 class JiveSortableTable.TextAreaCellRenderer
          A swing renderer to dispaly Textareas within a table.
 
Nested classes inherited from class com.jidesoft.grid.CellSpanTable
com.jidesoft.grid.CellSpanTable.DelegateAction
 
Nested classes inherited from class javax.swing.JTable
javax.swing.JTable.AccessibleJTable
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static java.awt.Color SELECTION_COLOR
          Define the color of row and column selections.
static java.awt.Color TOOLTIP_COLOR
          Define the color used in the tooltips.
 
Fields inherited from class com.jidesoft.grid.SortableTable
DEFAULT_ASCENDING_ICON, DEFAULT_DESCENDING_ICON, MULTICOLUMN_SORTABLE_PROPERTY, SORTABLE_PROPERTY
 
Fields inherited from class com.jidesoft.grid.JideTable
_cellChangeEvent, _columnAutoResizer, _columnResizer, _rowHeights, _rowResizer, PROPERTY_NON_CONTIGUOUS_CELL_SELECTION, PROPERTY_TABLE_SELECTION_MODEL, ROW_AUTO_RESIZES_PROPERTY
 
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
protected JiveSortableTable()
          Empty Constructor.
protected JiveSortableTable(java.lang.String[] headers)
          Creates a table using the specified table headers.
 
Method Summary
 void add(java.util.List list)
          Adds a list to the table model.
 void addObject(int row, java.lang.Object object)
          Associate an object with a row.
 void clearObjectMap()
          Clears all objects from map.
 void clearTable()
          Removes all columns and rows from table.
 void enterPressed()
          Override to handle when enter is pressed.
 javax.swing.table.TableCellRenderer getCellRenderer(int row, int column)
           
 java.lang.Object getObject(int row)
          Returns the associated row object.
 java.lang.Object[] getRowObject(int selectedRow)
          Returns the object[] of a row.
 java.lang.Object[] getSelectedRowObject()
          Get the object array of a row.
 Table.JiveTableModel getTableModel()
          Returns the table model.
 java.lang.String getToolTipText(java.awt.event.MouseEvent e)
           
 
Methods inherited from class com.jidesoft.grid.SortableTable
createDefaultTableHeader, createHeaderRenderer, createSortableTableModel, getActualRowAt, getAscendingIcon, getCategoryCollapsedIcon, getCategoryExpandedIcon, getCollapsedIcon, getDescendingIcon, getDisabledBackground, getDisabledForeground, getExpandedIcon, getMarginBackground, getSortableTableModel, getSortedRowAt, initTable, isAutoResort, isMultiColumnSortable, isOptimized, isPaintMarginBackground, isSortable, isUseCategorizedTableUI, isUseTableRendererForCategoryRow, resort, setAscendingIcon, setAutoResort, setCategoryCollapsedIcon, setCategoryExpandedIcon, setCollapsedIcon, setDescendingIcon, setDisabledBackground, setDisabledForeground, setExpandedIcon, setMarginBackground, setModel, setMultiColumnSortable, setOptimized, setPaintMarginBackground, setSortable, setTableHeaderRenderer, setUseCategorizedTableUI, setUseTableRendererForCategoryRow, sortColumn, sortColumn, unsort, updateUI
 
Methods inherited from class com.jidesoft.grid.CellSpanTable
calculateRowHeight, calculateRowHeights, columnAtPoint, columnSelectionChanged, createDelegateAction, editCellAt, getCellEditor, getCellRect, getGridColor, getRowHeight, getSpanModel, getUIClassID, isCellSelected, isKeepColumnAtPoint, isKeepRowAtPoint, muteDefaultKeyStroke, originalColumnAtPoint, originalGetCellRect, originalRowAtPoint, prepareEditor, prepareRenderer, replaceAction, restoreAction, rowAtPoint, setKeepColumnAtPoint, setKeepRowAtPoint, tableChanged, valueChanged
 
Methods inherited from class com.jidesoft.grid.CellStyleTable
configureEditorComponent, configureRendererComponent, customizeEditorComponent, customizeRendererComponent, getStyleModel
 
Methods inherited from class com.jidesoft.grid.JideTable
addCellEditorListener, addValidator, changeSelection, createDefaultTableSelectionModel, createSortHeaderRenderer, editingCanceled, editingStopped, fireEditingCanceled, fireEditingStarted, fireEditingStarting, fireEditingStopped, fireEditingStopping, getCellEditorListeners, getRowHeight, getRowHeights, getTableSelectionModel, getValidator, isColumnAutoResizable, isColumnResizable, isNestedTableHeader, isNonContiguousCellSelection, isRowAutoResizes, isRowResizable, removeCellEditorListener, removeValidator, setColumnAutoResizable, setColumnResizable, setNestedTableHeader, setNonContiguousCellSelection, setRowAutoResizes, setRowHeight, setRowHeight, setRowHeights, setRowResizable, setSortTableHeaderRenderer, setTableSelectionModel, startCellEditing, validate
 
Methods inherited from class javax.swing.JTable
addColumn, addColumnSelectionInterval, addNotify, addRowSelectionInterval, clearSelection, columnAdded, columnMarginChanged, columnMoved, columnRemoved, configureEnclosingScrollPane, convertColumnIndexToModel, convertColumnIndexToView, createDefaultColumnModel, createDefaultColumnsFromModel, createDefaultDataModel, createDefaultEditors, createDefaultRenderers, createDefaultSelectionModel, createScrollPaneForTable, doLayout, editCellAt, getAccessibleContext, getAutoCreateColumnsFromModel, getAutoResizeMode, getCellEditor, getCellSelectionEnabled, getColumn, getColumnClass, getColumnCount, getColumnModel, getColumnName, getColumnSelectionAllowed, getDefaultEditor, getDefaultRenderer, getDragEnabled, getEditingColumn, getEditingRow, getEditorComponent, getGridColor, getIntercellSpacing, getModel, getPreferredScrollableViewportSize, getRowCount, getRowMargin, getRowSelectionAllowed, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedColumn, getSelectedColumnCount, getSelectedColumns, getSelectedRow, getSelectedRowCount, getSelectedRows, getSelectionBackground, getSelectionForeground, getSelectionModel, getShowHorizontalLines, getShowVerticalLines, getSurrendersFocusOnKeystroke, getTableHeader, getUI, getValueAt, initializeLocalVars, isCellEditable, isColumnSelected, isEditing, isRowSelected, moveColumn, paramString, processKeyBinding, removeColumn, removeColumnSelectionInterval, removeEditor, removeNotify, removeRowSelectionInterval, resizeAndRepaint, selectAll, setAutoCreateColumnsFromModel, setAutoResizeMode, setCellEditor, setCellSelectionEnabled, setColumnModel, setColumnSelectionAllowed, setColumnSelectionInterval, setDefaultEditor, setDefaultRenderer, setDragEnabled, setEditingColumn, setEditingRow, setGridColor, setIntercellSpacing, setPreferredScrollableViewportSize, setRowMargin, setRowSelectionAllowed, setRowSelectionInterval, setSelectionBackground, setSelectionForeground, setSelectionMode, setSelectionModel, setShowGrid, setShowHorizontalLines, setShowVerticalLines, setSurrendersFocusOnKeystroke, setTableHeader, setUI, setValueAt, sizeColumnsToFit, sizeColumnsToFit, unconfigureEnclosingScrollPane
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

SELECTION_COLOR

public static final java.awt.Color SELECTION_COLOR
Define the color of row and column selections.


TOOLTIP_COLOR

public static final java.awt.Color TOOLTIP_COLOR
Define the color used in the tooltips.

Constructor Detail

JiveSortableTable

protected JiveSortableTable()
Empty Constructor.


JiveSortableTable

protected JiveSortableTable(java.lang.String[] headers)
Creates a table using the specified table headers.

Parameters:
headers - the table headers to use.
Method Detail

getToolTipText

public java.lang.String getToolTipText(java.awt.event.MouseEvent e)

getCellRenderer

public javax.swing.table.TableCellRenderer getCellRenderer(int row,
                                                           int column)

add

public void add(java.util.List list)
Adds a list to the table model.

Parameters:
list - the list to add to the model.

getSelectedRowObject

public java.lang.Object[] getSelectedRowObject()
Get the object array of a row.

Returns:
the object array of a row.

getRowObject

public java.lang.Object[] getRowObject(int selectedRow)
Returns the object[] of a row.

Parameters:
selectedRow - the row to retrieve.
Returns:
the object[] of a row.

clearTable

public void clearTable()
Removes all columns and rows from table.


getTableModel

public Table.JiveTableModel getTableModel()
Returns the table model.

Returns:
the table model.

clearObjectMap

public void clearObjectMap()
Clears all objects from map.


addObject

public void addObject(int row,
                      java.lang.Object object)
Associate an object with a row.

Parameters:
row - - the current row
object - - the object to associate with the row.

getObject

public java.lang.Object getObject(int row)
Returns the associated row object.

Parameters:
row - - the row associated with the object.
Returns:
The object associated with the row.

enterPressed

public void enterPressed()
Override to handle when enter is pressed.