org.knime.base.node.io.tablecreator.table
Class Spreadsheet

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              org.knime.base.node.io.tablecreator.table.Spreadsheet

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class Spreadsheet
extends JComponent

The spreadsheet component with an input line in the north a spreadsheet table in the center and further controls in the south.

Author:

Heiko Hofer

See Also:

Serialized Form

Nested Class Summary

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

Spreadsheet()
Create a new instance.

Method Summary

void	clearFocusedCell() reset the focused cell.
int[]	getColumnIndices() see getValues();
SortedMap<Integer,ColProperty>	getColumnProperties() Returns a mapping of column index to the {ColProperty} of the column.
boolean	getHightLightOutputTable()
String	getRowIdPrefix()
int	getRowIdStartValue()
String	getRowIdSuffix()
int[]	getRowIndices() see getValues();
String[]	getValues() Use in combination with getRowIndices and getColumnIndices.
boolean	hasParseErrors()
void	setData(SortedMap<Integer,ColProperty> columnProperties, int[] rowIndices, int[] columnIndices, String[] values) Replace the data of the table model by the given settings.
void	setHighlightOutputTable(boolean hightlightOutputTable) Defines if output table should be highlighted or not.
void	setRowIdPrefix(String rowIdPrefix)
void	setRowIdStartValue(int rowIdStartValue)
void	setRowIdSuffix(String rowIdSuffix)
void	stopCellEditing() Use this to stop cell editing from outside of the spreadsheet.

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, 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, 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

Constructor Detail

Spreadsheet

public Spreadsheet()

Create a new instance.

Method Detail

setData

public void setData(SortedMap<Integer,ColProperty> columnProperties,
                    int[] rowIndices,
                    int[] columnIndices,
                    String[] values)

Replace the data of the table model by the given settings.

Parameters:

columnProperties - the properties of column

rowIndices - the row indices

columnIndices - the column indices

values - the values at the given row and column indices

getRowIndices

public int[] getRowIndices()

see getValues();

Returns:

row indices populated with data

getColumnIndices

public int[] getColumnIndices()

see getValues();

Returns:

column indices populated with data

getValues

public String[] getValues()

Use in combination with getRowIndices and getColumnIndices. Together with this method you will three arrays which are a sparse representation of the tables data.

Returns:

the table data.

getColumnProperties

public SortedMap<Integer,ColProperty> getColumnProperties()

Returns a mapping of column index to the {ColProperty} of the column. The mapping must not exist for every column.

Returns:

a mapping of column index to the {ColProperty} of the column

clearFocusedCell

public void clearFocusedCell()

reset the focused cell.

stopCellEditing

public void stopCellEditing()

Use this to stop cell editing from outside of the spreadsheet. Typically needed to commit changes when editor is active.

getRowIdPrefix

public final String getRowIdPrefix()

Returns:

the rowIdPrefix

setRowIdPrefix

public final void setRowIdPrefix(String rowIdPrefix)

Parameters:

rowIdPrefix - the rowIdPrefix to set

getRowIdSuffix

public final String getRowIdSuffix()

Returns:

the rowIdSuffix

setRowIdSuffix

public final void setRowIdSuffix(String rowIdSuffix)

Parameters:

rowIdSuffix - the rowIdSuffix to set

getRowIdStartValue

public final int getRowIdStartValue()

Returns:

the rowIdStartValue

setRowIdStartValue

public final void setRowIdStartValue(int rowIdStartValue)

Parameters:

rowIdStartValue - the rowIdStartValue to set

setHighlightOutputTable

public void setHighlightOutputTable(boolean hightlightOutputTable)

Defines if output table should be highlighted or not.

Parameters:

hightlightOutputTable -

getHightLightOutputTable

public boolean getHightLightOutputTable()

Returns:

the highlight output table property

hasParseErrors

public boolean hasParseErrors()

Returns:

true when not every cell can be parsed