no.uib.jsparklines.renderers

Class JSparklinesTableCellRenderer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLabel

no.uib.jsparklines.renderers.JSparklinesTableCellRenderer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants, TableCellRenderer

public class JSparklinesTableCellRenderer
extends JLabel
implements TableCellRenderer

Table cell renderer displaying JSparklines plots consisting of multiple values per data series. Supported input: JSparklinesDataset objects. Other object types are rendered using the DefaultTableCellRenderer.

Author:

Harald Barsnes

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JSparklinesTableCellRenderer.PlotType List of supported plot types.

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

JLabel.AccessibleJLabel

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

labelFor

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
JSparklinesTableCellRenderer(JSparklinesTableCellRenderer.PlotType plotType, org.jfree.chart.plot.PlotOrientation plotOrientation) Creates a new JSparkLinesTableCellRenderer.
JSparklinesTableCellRenderer(JSparklinesTableCellRenderer.PlotType plotType, org.jfree.chart.plot.PlotOrientation plotOrientation, Double maxValue) Creates a new JSparkLinesTableCellRenderer.
JSparklinesTableCellRenderer(JSparklinesTableCellRenderer.PlotType plotType, org.jfree.chart.plot.PlotOrientation plotOrientation, Double minValue, Double maxValue) Creates a new JSparkLinesTableCellRenderer.

Method Summary

Modifier and Type	Method and Description
void	addReferenceArea(ReferenceArea referenceArea) Add a reference area.
void	addReferenceArea(String label, double start, double end, Color areaColor, float alpha) Add a reference area.
void	addReferenceLine(ReferenceLine referenceLine) Add a reference line at a given data value.
void	addReferenceLine(String label, double value, float lineWidth, Color lineColor) Add a reference line at a given data value.
HashMap<String,ReferenceArea>	getAllReferenceAreas() Returns all the references areas as a hashmap, with the labels as the keys.
HashMap<String,ReferenceLine>	getAllReferenceLines() Returns all the references lines as a hashmap, with the labels as the keys.
org.jfree.chart.ChartPanel	getChartPanel() Returns a reference to the chart panel.
Color	getDownColor() Get the color used for the 'down values' in the Up/Down charts and the negative values in the difference plots..
Color	getMaxValueColor() Get the color used to highlight the maximum values in the charts.
Color	getMinValueColor() Get the color used to highlight the minimum values in the charts.
org.jfree.chart.plot.PlotOrientation	getPlotOrientation() Get the current plot orientation.
Component	getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column)
Color	getUpColor() Get the color used for the 'up values' in the Up/Down charts and the positive values in the difference plots..
void	removeAllReferenceAreas() Removes all the reference areas.
void	removeAllReferenceLines() Removes all the reference lines.
void	removeReferenceArea(String label) Removes the reference area with the given label.
void	removeReferenceLine(String label) Removes the reference line with the given label.
void	setBackgroundColor(Color color) Set the background color.
void	setDownColor(Color downColor) Set the color used for the 'down values' in the Up/Down charts and the negative values in the difference plots..
void	setMaxValue(double maxValue) Set the maximum value.
void	setMaxValueColor(Color maxValueColor) Set the color used to highlight the maximum values in the charts.
void	setMinValue(double minValue) Set the minimum value.
void	setMinValueColor(Color minValueColor) Set the color used to highlight the minimum values in the charts and the positive values in the difference plots..
void	setPlotOrientation(org.jfree.chart.plot.PlotOrientation plotOrientation) Set the plot orientation.
void	setPlotType(JSparklinesTableCellRenderer.PlotType plotType) Sets the plot type.
void	setUpColor(Color upColor) Set the color used for the 'up values' in the Up/Down charts.
void	showNumberAndChart(boolean showNumberAndChart, int widthOfLabel) If true the number will be shown together with the bar chart in the cell.
void	showNumberAndChart(boolean showNumberAndChart, int widthOfLabel, DecimalFormat numberFormat) If true the number will be shown together with the bar chart in the cell.
void	showNumberAndChart(boolean showNumberAndChart, int widthOfLabel, Font font, int horizontalAlignement) If true the number will be shown together with the bar chart in the cell.
void	showNumberAndChart(boolean showNumberAndChart, int widthOfLabel, Font font, int horizontalAlignement, DecimalFormat numberFormat) If true the number will be shown together with the bar chart in the cell.
void	showNumbers(boolean showNumbers) Set if the underlying numbers or the bar charts are to be shown.
void	showProteinSequenceReferenceLine(boolean showProteinSequenceReferenceLine) If true, a black reference line is added to the protein sequence plots.
void	showProteinSequenceReferenceLine(boolean showProteinSequenceReferenceLine, double lineWidth, Color color) If true, a black reference line is shown in the middle of the plot.

Methods inherited from class javax.swing.JLabel

checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition, 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, 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

Constructor Detail

JSparklinesTableCellRenderer

public JSparklinesTableCellRenderer(JSparklinesTableCellRenderer.PlotType plotType,
                                    org.jfree.chart.plot.PlotOrientation plotOrientation)

Creates a new JSparkLinesTableCellRenderer. Use this constructor when creating pie charts where no upper range is used.

Parameters:

plotType - the plot type

plotOrientation - the orientation of the plot

JSparklinesTableCellRenderer

public JSparklinesTableCellRenderer(JSparklinesTableCellRenderer.PlotType plotType,
                                    org.jfree.chart.plot.PlotOrientation plotOrientation,
                                    Double maxValue)

Creates a new JSparkLinesTableCellRenderer. Use this constructor when only positive values are to be plotted.

Parameters:

plotType - the plot type

plotOrientation - the orientation of the plot

maxValue - the maximum value to be plotted, used to make sure that all plots in the same column has the same maximum value and are thus comparable (this is the same as setting the minimum value to 0)

JSparklinesTableCellRenderer

public JSparklinesTableCellRenderer(JSparklinesTableCellRenderer.PlotType plotType,
                                    org.jfree.chart.plot.PlotOrientation plotOrientation,
                                    Double minValue,
                                    Double maxValue)

Creates a new JSparkLinesTableCellRenderer. Use this constructor when positive and negative values are to be plotted.

Parameters:

plotType - the plot type

plotOrientation - the orientation of the plot

minValue - the minimum value to be plotted, used to make sure that all plots in the same column has the same maximum value and are thus comparable

maxValue - the maximum value to be plotted, used to make sure that all plots in the same column has the same maximum value and are thus comparable

Method Detail

showNumberAndChart

public void showNumberAndChart(boolean showNumberAndChart,
                               int widthOfLabel)

If true the number will be shown together with the bar chart in the cell. False only display the chart. This method is currently only supported for the plot type 'stackedBarChartIntegerWithUpperRange' and only displays the first number in the first data series.

Parameters:

showNumberAndChart - if true the number and the chart is shown in the cell

widthOfLabel - the width used to display the label containing the number

showNumberAndChart

public void showNumberAndChart(boolean showNumberAndChart,
                               int widthOfLabel,
                               DecimalFormat numberFormat)

If true the number will be shown together with the bar chart in the cell. False only display the chart. This method is currently only supported for the plot type 'stackedBarChartIntegerWithUpperRange' and only displays the first number in the first data series.

Parameters:

showNumberAndChart - if true the number and the chart is shown in the cell

widthOfLabel - the width used to display the label containing the number

numberFormat - the decimal format to use when showing the numbers

showNumberAndChart

public void showNumberAndChart(boolean showNumberAndChart,
                               int widthOfLabel,
                               Font font,
                               int horizontalAlignement)

If true the number will be shown together with the bar chart in the cell. False only display the chart. This method is currently only supported for the plot type 'stackedBarChartIntegerWithUpperRange' and only displays the first number in the first data series.

Parameters:

showNumberAndChart - if true the number and the chart is shown in the cell

widthOfLabel - the width used to display the label containing the number

font - the font to use for the label

horizontalAlignement - the horizontal alignment of the text in the label: one of the following constants defined in SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING.

showNumberAndChart

public void showNumberAndChart(boolean showNumberAndChart,
                               int widthOfLabel,
                               Font font,
                               int horizontalAlignement,
                               DecimalFormat numberFormat)

If true the number will be shown together with the bar chart in the cell. False only display the chart. This method is currently only supported for the plot type 'stackedBarChartIntegerWithUpperRange' and only displays the first number in the first data series.

Parameters:

showNumberAndChart - if true the number and the chart is shown in the cell

widthOfLabel - the width used to display the label containing the number

font - the font to use for the label

horizontalAlignement - the horizontal alignment of the text in the label: one of the following constants defined in SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING.

numberFormat - the decimal format to use when showing the numbers

showNumbers

public void showNumbers(boolean showNumbers)

Set if the underlying numbers or the bar charts are to be shown. This method is currently only supported for the plot type 'stackedBarChartIntegerWithUpperRange' and only displays the first number in the first data series.

Parameters:

showNumbers - if true the underlying numbers are shown

showProteinSequenceReferenceLine

public void showProteinSequenceReferenceLine(boolean showProteinSequenceReferenceLine)

If true, a black reference line is added to the protein sequence plots. No effect on the other plot types.

Parameters:

showProteinSequenceReferenceLine - if true, a black reference line is added to the protein sequence plots

showProteinSequenceReferenceLine

public void showProteinSequenceReferenceLine(boolean showProteinSequenceReferenceLine,
                                             double lineWidth,
                                             Color color)

If true, a black reference line is shown in the middle of the plot.

Parameters:

showProteinSequenceReferenceLine - if true, a black reference line is shown in the middle of the plot

lineWidth - the line width

color - the color

getTableCellRendererComponent

public Component getTableCellRendererComponent(JTable table,
                                               Object value,
                                               boolean isSelected,
                                               boolean hasFocus,
                                               int row,
                                               int column)

Specified by:

getTableCellRendererComponent in interface TableCellRenderer

addReferenceLine

public void addReferenceLine(String label,
                             double value,
                             float lineWidth,
                             Color lineColor)

Add a reference line at a given data value.

Parameters:

label - the label for the reference

value - the reference line value

lineWidth - the line width, has to non-negative

lineColor - the line color

addReferenceLine

public void addReferenceLine(ReferenceLine referenceLine)

Add a reference line at a given data value.

Parameters:

referenceLine - the reference line

removeReferenceLine

public void removeReferenceLine(String label)

Removes the reference line with the given label. Does nothing if no reference with the given label is found.

Parameters:

label - the reference to remove

removeAllReferenceLines

public void removeAllReferenceLines()

Removes all the reference lines.

getAllReferenceLines

public HashMap<String,ReferenceLine> getAllReferenceLines()

Returns all the references lines as a hashmap, with the labels as the keys.

Returns:

hashmap of all reference lines

addReferenceArea

public void addReferenceArea(String label,
                             double start,
                             double end,
                             Color areaColor,
                             float alpha)

Add a reference area.

Parameters:

label - the label for the reference area

start - the start of the reference area

end - the end of the reference area

areaColor - the color of the reference area

alpha - the alpha level of the reference area, range: 0.0 to 1.0

addReferenceArea

public void addReferenceArea(ReferenceArea referenceArea)

Add a reference area.

Parameters:

referenceArea - the reference area

removeReferenceArea

public void removeReferenceArea(String label)

Removes the reference area with the given label. Does nothing if no reference with the given label is found.

Parameters:

label - the reference to remove

removeAllReferenceAreas

public void removeAllReferenceAreas()

Removes all the reference areas.

getAllReferenceAreas

public HashMap<String,ReferenceArea> getAllReferenceAreas()

Returns all the references areas as a hashmap, with the labels as the keys.

Returns:

hashmap of all reference areas

setMaxValue

public void setMaxValue(double maxValue)

Set the maximum value.

Parameters:

maxValue - the maximum value

setMinValue

public void setMinValue(double minValue)

Set the minimum value.

Parameters:

minValue - the minimum value

setPlotType

public void setPlotType(JSparklinesTableCellRenderer.PlotType plotType)

Sets the plot type.

Parameters:

plotType - the plotType to set

getMaxValueColor

public Color getMaxValueColor()

Get the color used to highlight the maximum values in the charts.

Returns:

the color used to highlight the maximum values in the charts

setMaxValueColor

public void setMaxValueColor(Color maxValueColor)

Set the color used to highlight the maximum values in the charts.

Parameters:

maxValueColor - the color to set

getMinValueColor

public Color getMinValueColor()

Get the color used to highlight the minimum values in the charts.

Returns:

the color used to highlight the minimum values in the charts

setMinValueColor

public void setMinValueColor(Color minValueColor)

Set the color used to highlight the minimum values in the charts and the positive values in the difference plots..

Parameters:

minValueColor - the color to set

getUpColor

public Color getUpColor()

Get the color used for the 'up values' in the Up/Down charts and the positive values in the difference plots..

Returns:

the color used for the 'up values' in the Up/Down charts

setUpColor

public void setUpColor(Color upColor)

Set the color used for the 'up values' in the Up/Down charts.

Parameters:

upColor - the color for the 'up values' in the Up/Down charts

getDownColor

public Color getDownColor()

Get the color used for the 'down values' in the Up/Down charts and the negative values in the difference plots..

Returns:

the color used for the 'down values' in the Up/Down charts

setDownColor

public void setDownColor(Color downColor)

Set the color used for the 'down values' in the Up/Down charts and the negative values in the difference plots..

Parameters:

downColor - the color for the 'down values' in the Up/Down charts

getPlotOrientation

public org.jfree.chart.plot.PlotOrientation getPlotOrientation()

Get the current plot orientation.

Returns:

the current plot orientation

setPlotOrientation

public void setPlotOrientation(org.jfree.chart.plot.PlotOrientation plotOrientation)

Set the plot orientation.

Parameters:

plotOrientation - the new plot orientation

getChartPanel

public org.jfree.chart.ChartPanel getChartPanel()

Returns a reference to the chart panel.

Returns:

the chart panel.

setBackgroundColor

public void setBackgroundColor(Color color)

Set the background color. If not set the background color of the given row will be used.

Parameters:

color - the new background color