DataFrameTable (Morpheus-Viz 0.9.21 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - com.zavtech.morpheus.viz.table.DataFrameTable

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible
```
public class DataFrameTable
extends JPanel
```
A Swing GUI component that displays a DataFrame in a standard JTable with additional functionality.

Author:

Xavier Witdouck
This is open source software released under the Apache 2.0 License

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class DataFrameTable.CustomAction
Convenience class to ofInts actions
- 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

Nested Classes
Modifier and Type	Class and Description
`private static class`	`DataFrameTable.CustomAction` Convenience class to ofInts actions

Field Summary

Fields
Modifier and Type	Field and Description
`private static Map<Integer,Icon>`	`alignmentIconMap`
`private JMenu`	`alignmentMenu`
`private static Map<Integer,String>`	`alignmentNameMap`
`private Action`	`backgroundAction`
`private Action`	`bestFitAction`
`private com.zavtech.morpheus.index.Index<Object>`	`colIndex`
`private TableColumnModelListener`	`columnModelListener`
`private JMenu`	`dateFormatMenu`
`private int`	`decimalCount`
`private JMenu`	`decimalFormatMenu`
`private Action`	`decreasePrecisionAction`
`private DataFrameCellFormat`	`defaultCellFormat`
`private DataFrameCellEditor`	`editor`
`private Action`	`exportCsvAction`
`private JMenu`	`fontMenu`
`private static Map<Integer,Icon>`	`fontStyleIconMap`
`private static Map<Integer,String>`	`fontStyleNameMap`
`private Action`	`foregroundAction`
`private com.zavtech.morpheus.frame.DataFrame<Object,Object>`	`formatFrame`
`private static Map<Integer,Icon>`	`formatIconMap`
`private Map<Object,DataFrameCellFormat>`	`formatMap`
`private static Map<Integer,String>`	`formatNameMap`
`private Action`	`increasePrecisionAction`
`private JTable`	`leftTable`
`private static Logger`	`LOG`
`private DataFrameTableModel`	`model`
`private MouseListener`	`mouseListener`
`private JPopupMenu`	`popupMenu`
`private DataFrameCellRenderer`	`renderer`
`private JTable`	`rightTable`
`private com.zavtech.morpheus.index.Index<Object>`	`rowIndex`
`private JScrollPane`	`scrollPane`
`private ListSelectionModel`	`selectionModel`
`private TableRowSorter<TableModel>`	`sorter`
`private JMenu`	`styleMenu`

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 and Description

DataFrameTable()
Constructor

DataFrameTable(com.zavtech.morpheus.frame.DataFrame frame)
Constructor

Constructors
Constructor and Description
`DataFrameTable()` Constructor
`DataFrameTable(com.zavtech.morpheus.frame.DataFrame frame)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private Action`	`createAlignmentAction(int alignment)` Returns a new action to change the alignment for selected cells
`private Action`	`createBestFitAction()` Creates a new action to best fit columns
`private Action`	`createClearFormatAction()` Creates a new action to clear the formatting on selected cells
`protected void`	`createColumns(JTable table)` Called to ofInts columns for the target table
`private Action`	`createConditionalFontColorAction()` Creates a new action to change font color of selected cells
`private Action`	`createCsvExportAction()` Creates a new action to export data to excel
`private Action`	`createDateFormatAction(String pattern)` Returns a new action to accept a specific date format to selected cells
`private Action`	`createDecreasePrecisionAction()` Creates a new action to decrease decimal precision
`private Action`	`createFillColorAction()` Creates a new action to change fill color of selected cells
`private Action`	`createFontAction()` Returns a new action to change the font type
`private Action`	`createFontColorAction()` Creates a new action to change font color of selected cells
`private Action`	`createFontStyleAction(int style)` Returns a new action to change the font style for selected cells
`private Action`	`createIncreasePrecisionAction()` Creates a new action to increase decimal precision
`private Action`	`createNumberTypeAction(Integer numberType, String description)` Creates a new action to accept a specific type of formatting to selected cells
`DataFrameCellFormat`	`getCellFormat(int rowIndex, int colIndex, boolean create)` Returns the cell format for the row and column index
`DataFrameCellFormat`	`getCellFormat(Object row, Object column, boolean create)` Returns the cell format for row and column key
`(package private) int`	`getColumnIndex(JTable table, int colIndex)` Returns the column index of the combined table
`<R,C> com.zavtech.morpheus.frame.DataFrame<R,C>`	`getDataFrame()` Returns a reference to the data frame bound to this viewer
`DataFrameCellFormat`	`getDefaultCellFormat()` Returns the default format for cells
`private static ImageIcon`	`getIcon(int size, String name)` Returns a new icon for of the size and name specified
`DataFrameCellFormat`	`getRowHeaderFormat(Object row, boolean create)` Returns the cell format for the row header cell (ie fixed column)
`int[]`	`getSelectedColumns()` Returns the selected column indices in view space
`int[]`	`getSelectedRows()` Returns the selected row indices in view space
`private void`	`initPopupMenu()` Initializes the popup menu for this component
`private void`	`initTable(JTable table)` Initializes a table component for this component
`private void`	`resizeLeftTable()` Called to resize the row header viewport based on the size of the left table
`void`	`setDataFrame(com.zavtech.morpheus.frame.DataFrame frame)` Sets the data frame instance to display in this viewer
`void`	`setDecimalCount(int decimalCount)` Called to set the decimal count for this editor
`void`	`setDefaultCellFormat(DataFrameCellFormat defaultCellFormat)` Sets the default cell format for this table
`private void`	`validateActions()` Called to validate this components actions

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, setVisible, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG
```
private static final Logger LOG
```
  - fontStyleNameMap
```
private static Map<Integer,String> fontStyleNameMap
```
  - fontStyleIconMap
```
private static Map<Integer,Icon> fontStyleIconMap
```
  - alignmentNameMap
```
private static Map<Integer,String> alignmentNameMap
```
  - alignmentIconMap
```
private static Map<Integer,Icon> alignmentIconMap
```
  - formatNameMap
```
private static Map<Integer,String> formatNameMap
```
  - formatIconMap
```
private static Map<Integer,Icon> formatIconMap
```
  - decimalCount
```
private int decimalCount
```
  - scrollPane
```
private JScrollPane scrollPane
```
  - leftTable
```
private JTable leftTable
```
  - rightTable
```
private JTable rightTable
```
  - editor
```
private DataFrameCellEditor editor
```
  - model
```
private DataFrameTableModel model
```
  - renderer
```
private DataFrameCellRenderer renderer
```
  - defaultCellFormat
```
private DataFrameCellFormat defaultCellFormat
```
  - selectionModel
```
private ListSelectionModel selectionModel
```
  - sorter
```
private TableRowSorter<TableModel> sorter
```
  - formatMap
```
private Map<Object,DataFrameCellFormat> formatMap
```
  - rowIndex
```
private com.zavtech.morpheus.index.Index<Object> rowIndex
```
  - colIndex
```
private com.zavtech.morpheus.index.Index<Object> colIndex
```
  - formatFrame
```
private com.zavtech.morpheus.frame.DataFrame<Object,Object> formatFrame
```
  - popupMenu
```
private JPopupMenu popupMenu
```
  - fontMenu
```
private JMenu fontMenu
```
  - styleMenu
```
private JMenu styleMenu
```
  - dateFormatMenu
```
private JMenu dateFormatMenu
```
  - decimalFormatMenu
```
private JMenu decimalFormatMenu
```
  - alignmentMenu
```
private JMenu alignmentMenu
```
  - bestFitAction
```
private Action bestFitAction
```
  - exportCsvAction
```
private Action exportCsvAction
```
  - backgroundAction
```
private Action backgroundAction
```
  - foregroundAction
```
private Action foregroundAction
```
  - increasePrecisionAction
```
private Action increasePrecisionAction
```
  - decreasePrecisionAction
```
private Action decreasePrecisionAction
```
  - columnModelListener
```
private TableColumnModelListener columnModelListener
```
  - mouseListener
```
private MouseListener mouseListener
```
- Constructor Detail
  - DataFrameTable
```
public DataFrameTable()
```
    Constructor
  - DataFrameTable
```
public DataFrameTable(com.zavtech.morpheus.frame.DataFrame frame)
```
    Constructor
    
    Parameters:
    
    frame - the DataFrame for this table
- Method Detail
  - initTable
```
private void initTable(JTable table)
```
    Initializes a table component for this component
    
    Parameters:
    
    table - the table
  - createColumns
```
protected void createColumns(JTable table)
```
    Called to ofInts columns for the target table
    
    Parameters:
    
    table - the table reference
  - initPopupMenu
```
private void initPopupMenu()
```
    Initializes the popup menu for this component
  - getDataFrame
```
public <R,C> com.zavtech.morpheus.frame.DataFrame<R,C> getDataFrame()
```
    Returns a reference to the data frame bound to this viewer
    
    Returns:
    
    the data frame bound to viewer, can be null
  - setDataFrame
```
public void setDataFrame(com.zavtech.morpheus.frame.DataFrame frame)
```
    Sets the data frame instance to display in this viewer
    
    Parameters:
    
    frame - the data frame to display, can be null
  - getDefaultCellFormat
```
public DataFrameCellFormat getDefaultCellFormat()
```
    Returns the default format for cells
    
    Returns:
    
    the default format for cells
  - setDefaultCellFormat
```
public void setDefaultCellFormat(DataFrameCellFormat defaultCellFormat)
```
    Sets the default cell format for this table
    
    Parameters:
    
    defaultCellFormat - the default cell format
  - getRowHeaderFormat
```
public DataFrameCellFormat getRowHeaderFormat(Object row,
                                              boolean create)
```
    Returns the cell format for the row header cell (ie fixed column)
    
    Parameters:
    
    row - the row key
    
    create - if true, ofInts a new cell format if none exists
    
    Returns:
    
    the cell format, null if none exists and ofInts == false
  - getCellFormat
```
public DataFrameCellFormat getCellFormat(Object row,
                                         Object column,
                                         boolean create)
```
    Returns the cell format for row and column key
    
    Parameters:
    
    row - the row key
    
    column - the column key
    
    create - if true, ofInts a new cell format if none exists
    
    Returns:
    
    the cell format, null if none exists and ofInts == false
  - getCellFormat
```
public final DataFrameCellFormat getCellFormat(int rowIndex,
                                               int colIndex,
                                               boolean create)
```
    Returns the cell format for the row and column index
    
    Parameters:
    
    rowIndex - the row index in view space
    
    colIndex - the column index in view space
    
    create - if true, ofInts a new cell format if none exists
    
    Returns:
    
    the cell format, null if none exists and ofInts == false
  - getColumnIndex
```
int getColumnIndex(JTable table,
                   int colIndex)
```
    Returns the column index of the combined table
    
    Parameters:
    
    table - the JTable reference
    
    colIndex - the column index on the JTable
    
    Returns:
    
    the mapped column index
  - setDecimalCount
```
public void setDecimalCount(int decimalCount)
```
    Called to set the decimal count for this editor
    
    Parameters:
    
    decimalCount - the decimal count for editor
  - createAlignmentAction
```
private Action createAlignmentAction(int alignment)
```
    Returns a new action to change the alignment for selected cells
    
    Parameters:
    
    alignment - the alignment as per SwingConstants
    
    Returns:
    
    the newly created action
  - createFontAction
```
private Action createFontAction()
```
    Returns a new action to change the font type
    
    Returns:
    
    the newly created action
  - createFontStyleAction
```
private Action createFontStyleAction(int style)
```
    Returns a new action to change the font style for selected cells
    
    Parameters:
    
    style - the font style
    
    Returns:
    
    the newly created action
  - createDateFormatAction
```
private Action createDateFormatAction(String pattern)
```
    Returns a new action to accept a specific date format to selected cells
    
    Parameters:
    
    pattern - the date format pattern
    
    Returns:
    
    the newly created action
  - createNumberTypeAction
```
private Action createNumberTypeAction(Integer numberType,
                                      String description)
```
    Creates a new action to accept a specific type of formatting to selected cells
    
    Parameters:
    
    numberType - the number type
    
    description - the action description
    
    Returns:
    
    newly created action
  - createIncreasePrecisionAction
```
private Action createIncreasePrecisionAction()
```
    Creates a new action to increase decimal precision
    
    Returns:
    
    newly created action
  - createDecreasePrecisionAction
```
private Action createDecreasePrecisionAction()
```
    Creates a new action to decrease decimal precision
    
    Returns:
    
    newly created action
  - createCsvExportAction
```
private Action createCsvExportAction()
```
    Creates a new action to export data to excel
    
    Returns:
    
    newly created action
  - createBestFitAction
```
private Action createBestFitAction()
```
    Creates a new action to best fit columns
    
    Returns:
    
    newly created action
  - createFillColorAction
```
private Action createFillColorAction()
```
    Creates a new action to change fill color of selected cells
    
    Returns:
    
    newly created action
  - createFontColorAction
```
private Action createFontColorAction()
```
    Creates a new action to change font color of selected cells
    
    Returns:
    
    newly created action
  - createConditionalFontColorAction
```
private Action createConditionalFontColorAction()
```
    Creates a new action to change font color of selected cells
    
    Returns:
    
    newly created action
  - createClearFormatAction
```
private Action createClearFormatAction()
```
    Creates a new action to clear the formatting on selected cells
    
    Returns:
    
    newly created action
  - validateActions
```
private void validateActions()
```
    Called to validate this components actions
  - getSelectedRows
```
public int[] getSelectedRows()
```
    Returns the selected row indices in view space
    
    Returns:
    
    the selected row indices
  - getSelectedColumns
```
public int[] getSelectedColumns()
```
    Returns the selected column indices in view space
    
    Returns:
    
    the selected column indices
  - getIcon
```
private static ImageIcon getIcon(int size,
                                 String name)
```
    Returns a new icon for of the size and name specified
    
    Parameters:
    
    size - the icon size (16 | 32)
    
    name - the icon name
    
    Returns:
    
    the icon, null if gailed to load
  - resizeLeftTable
```
private void resizeLeftTable()
```
    Called to resize the row header viewport based on the size of the left table

Class DataFrameTable

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

LOG

fontStyleNameMap

fontStyleIconMap

alignmentNameMap

alignmentIconMap

formatNameMap

formatIconMap

decimalCount

scrollPane

leftTable

rightTable

editor

model

renderer

defaultCellFormat

selectionModel

sorter

formatMap

rowIndex

colIndex

formatFrame

popupMenu

fontMenu

styleMenu

dateFormatMenu

decimalFormatMenu

alignmentMenu

bestFitAction

exportCsvAction

backgroundAction

foregroundAction

increasePrecisionAction

decreasePrecisionAction

columnModelListener

mouseListener

Constructor Detail

DataFrameTable

DataFrameTable

Method Detail

initTable

createColumns

initPopupMenu

getDataFrame

setDataFrame

getDefaultCellFormat

setDefaultCellFormat

getRowHeaderFormat

getCellFormat

getCellFormat

getColumnIndex

setDecimalCount

createAlignmentAction

createFontAction

createFontStyleAction

createDateFormatAction

createNumberTypeAction

createIncreasePrecisionAction

createDecreasePrecisionAction

createCsvExportAction

createBestFitAction

createFillColorAction

createFontColorAction