Package adams.gui.visualization.stats.histogram

Class Histogram

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.visualization.core.PaintablePanel

adams.gui.visualization.stats.histogram.Histogram

All Implemented Interfaces:

TextSupporter, SpreadSheetSupporter, TextSupplier, PopupMenuCustomizer<MouseEvent>, PaintListener, PaintletManager, PopupMenuCustomizer, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

public class Histogram
extends PaintablePanel
implements PopupMenuCustomizer, TextSupplier, SpreadSheetSupporter

Class that displays a histogram displaying the data provided.

Author:

msf8

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

Modifier and Type	Field	Description
protected Number[]	m_Array	number array to plot.
protected double	m_BinWidth	the bin width.
protected SpreadSheet	m_Data	Data to be plotted
protected String	m_DataName	the name to use for the x-axis.
protected SpreadSheetFileChooser	m_FileChooser	the file chooser for saving a specific sequence.
protected HistogramOptions	m_HistOptions	Options for the histogram
protected int	m_Index	Position of the residuals attribute within the data
protected String	m_Name	the name of the x-axis.
protected HistogramPanel	m_Plot	Panel for displaying the histogram
protected double[][]	m_Plotdata	the data to plot.
protected String[]	m_Ranges	the ranges.
protected HistogramPaintlet	m_Val	Paintlet for plotting the data
protected PaintListener	m_WatermarkListener	the watermark paint listener.

Fields inherited from class adams.gui.visualization.core.PaintablePanel

m_Paintlets

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
Histogram()

Method Summary

Modifier and Type	Method	Description
protected boolean	canPaint(Graphics g)	Returns true if the paintlets can be executed.
void	customizePopupMenu(MouseEvent e, JPopupMenu menu)	Optional customizing of the menu that is about to be popped up.
Number[]	getArray()	Returns the current array.
double	getBinWidth()	Returns the bin width.
String	getCustomSupplyTextMenuItemCaption()	Returns the text for the menu item.
ExtensionFileFilter	getCustomTextFileFilter()	Returns a custom file filter for the file chooser.
SpreadSheet	getData()	Returns the instanecs for the histogram.
String	getDataName()	Returns the name for the x-axis.
int	getIndex()	Returns the currently set index.
HistogramOptions	getOptions()	Returns the option for this histogram.
PlotPanel	getPlot()	Returns the plot panel of the panel, null if no panel present.
double[][]	getPlotdata()	Returns the plot data.
String[]	getRanges()	Returns the ranges.
protected void	initGUI()	For initializing the GUI.
protected void	initialize()	Initializes the members.
void	prepareUpdate()	Prepares the update, i.e., calculations etc.
protected void	save()	Saves the data as spreadsheet.
void	setArray(Number[] value)	Sets the array for this histogram.
void	setData(SpreadSheet value)	Set the data for the histogram
void	setDataName(String value)	Sets the name for the x-axis.
void	setIndex(int val)	Set the index of residuals attribute within the data
void	setOptions(HistogramOptions val)	Set the options for this histogram
protected void	showData()	Displays the data as spreadsheet.
String	supplyText()	Supplies the text.
SpreadSheet	toSpreadSheet()	Returns the content as spreadsheet.

Methods inherited from class adams.gui.visualization.core.PaintablePanel

addPaintlet, canHandleFixedLabels, check, paint, painted, paintlets, performUpdate, postUpdate, printAll, removePaintlet, update

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, finishInit, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initFileChooser, 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, 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, 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, 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, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Data

protected SpreadSheet m_Data

Data to be plotted

m_Array

protected Number[] m_Array

number array to plot.

m_Plot

protected HistogramPanel m_Plot

Panel for displaying the histogram

m_Val

protected HistogramPaintlet m_Val

Paintlet for plotting the data

m_HistOptions

protected HistogramOptions m_HistOptions

Options for the histogram

m_Index

protected int m_Index

Position of the residuals attribute within the data

m_DataName

protected String m_DataName

the name to use for the x-axis.

m_Plotdata

protected double[][] m_Plotdata

the data to plot.

m_Ranges

protected String[] m_Ranges

the ranges.

m_BinWidth

protected double m_BinWidth

the bin width.

m_Name

protected String m_Name

the name of the x-axis.

m_FileChooser

protected SpreadSheetFileChooser m_FileChooser

the file chooser for saving a specific sequence.

m_WatermarkListener

protected PaintListener m_WatermarkListener

the watermark paint listener.

Constructor Detail

Histogram

public Histogram()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class PaintablePanel

initGUI

protected void initGUI()

For initializing the GUI.

Overrides:

initGUI in class BasePanel

setOptions

public void setOptions(HistogramOptions val)

Set the options for this histogram

Parameters:

val - Histogramoptions object containing all the options

getOptions

public HistogramOptions getOptions()

Returns the option for this histogram.

Returns:

the options

setData

public void setData(SpreadSheet value)

Set the data for the histogram

Parameters:

value - Data for the histogram plot

getData

public SpreadSheet getData()

Returns the instanecs for the histogram.

Returns:

the data, null if not set

setArray

public void setArray(Number[] value)

Sets the array for this histogram.

Parameters:

value - the array

getArray

public Number[] getArray()

Returns the current array.

Returns:

the array, null if not set

setDataName

public void setDataName(String value)

Sets the name for the x-axis.

Parameters:

value - the name

getDataName

public String getDataName()

Returns the name for the x-axis.

Returns:

the name

getPlot

public PlotPanel getPlot()

Returns the plot panel of the panel, null if no panel present.

Specified by:

getPlot in class PaintablePanel

Returns:

the plot panel

prepareUpdate

public void prepareUpdate()

Prepares the update, i.e., calculations etc.

Specified by:

prepareUpdate in class PaintablePanel

canPaint

protected boolean canPaint(Graphics g)

Returns true if the paintlets can be executed.

Specified by:

canPaint in class PaintablePanel

Parameters:

g - the graphics context

Returns:

true if painting can go ahead

setIndex

public void setIndex(int val)

Set the index of residuals attribute within the data

Parameters:

val - Position of residuals attribute

getIndex

public int getIndex()

Returns the currently set index.

Returns:

the index

getPlotdata

public double[][] getPlotdata()

Returns the plot data.

Returns:

the data

getRanges

public String[] getRanges()

Returns the ranges.

Returns:

the ranges

getBinWidth

public double getBinWidth()

Returns the bin width.

Returns:

the width

save

protected void save()

Saves the data as spreadsheet.

showData

protected void showData()

Displays the data as spreadsheet.

customizePopupMenu

public void customizePopupMenu(MouseEvent e,
                               JPopupMenu menu)

Optional customizing of the menu that is about to be popped up.

Specified by:

customizePopupMenu in interface PopupMenuCustomizer<MouseEvent>

Specified by:

customizePopupMenu in interface PopupMenuCustomizer

Parameters:

e - The mouse event

menu - The menu to customize.

toSpreadSheet

public SpreadSheet toSpreadSheet()

Returns the content as spreadsheet.

Specified by:

toSpreadSheet in interface SpreadSheetSupporter

Returns:

the content

getCustomSupplyTextMenuItemCaption

public String getCustomSupplyTextMenuItemCaption()

Returns the text for the menu item.

Specified by:

getCustomSupplyTextMenuItemCaption in interface TextSupplier

Returns:

the menu item text, null for default

getCustomTextFileFilter

public ExtensionFileFilter getCustomTextFileFilter()

Returns a custom file filter for the file chooser.

Specified by:

getCustomTextFileFilter in interface TextSupplier

Returns:

the file filter, null if to use default one

supplyText

public String supplyText()

Supplies the text. May get called even if actor hasn't been executed yet.

Specified by:

supplyText in interface TextSupplier

Specified by:

supplyText in interface TextSupporter

Returns:

the text, null if none available