jas.hist
Class JASHist

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              jas.hist.JASHist

All Implemented Interfaces:

JASPlotMouseListener, ImageObserver, MenuContainer, Serializable

public class JASHist
extends JComponent
implements JASPlotMouseListener

JASHist is the main component used for plotting histograms, scatterplots etc. The type of display produced depends on the DataSource hooked to the component. If the data source is observable, then the JASHist will update as it receives notifications from the data source. JASHist supports overlaying of data and fitting of functions (to 1D histograms).

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

static int	BEVEL_IN
static int	BEVEL_OUT
static int	ETCHED
static int	LEGEND_ALWAYS
static int	LEGEND_AUTOMATIC
static int	LEGEND_NEVER
static int	LINE
static int	NONE
static int	SHADOW

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

JASHist()
Create a new JASHist component with no initial data source

Method Summary

JASHistData	addData(DataSource ds) Add a DataSource to the plot.
static void	addFitListener(FitListener fitListener) Add a FitListener that will receive notifications about the status of fits being performed by the plot
void	addNotify() Overrides addNotify in JComponent Starts listening for changes in data
void	copy() Copies the plot to the clipboard
void	deselected()
void	destroy() Removes and detaches all data from the plot, but doesn't set up the plot for further use.
void	fillFunctionMenu(JMenu menu) Fills the appropriate Function menu items into a user provided menu.
void	fillSliceMenu(JMenu menu) Fills the appriate Slice/Projection menu items into a user provided menu.
Enumeration	get1DFunctions() Get the set of Functions currently attached to the plot
boolean	getAllowPopupMenus()
boolean	getAllowUserInteraction() Test if user direct user interaction with the plot is allowed
Color	getBackground() Get the background color.
DataArea	getDataArea()
Border	getDataAreaBorder()
int	getDataAreaBorderType() Get the current data area border type
Color	getDataAreaColor() Return the current data area background color
Enumeration	getDataSources() Get the set of data sources currently attached to the plot.
Legend	getLegend()
int	getNumberOfDataSources() Get the number of data sources attached to the plot
int	getShowLegend() Get the current setting of the showLegend property
boolean	getShowStatistics()
StatisticsBlock	getStats()
String	getTitle() Get the text of the title.
Title	getTitleObject() Actually get the Title object.
JASHistAxis	getXAxis() Gets the X axis
JASHistAxis[]	getYAxes() Get an array containing all of the Y Axes
JASHistAxis	getYAxis() Gets the default Y Axis
JASHistAxis	getYAxis(int index) Gets either Y Axis.
boolean	isChanged()
void	mouseEventNotify(MouseEvent e)
void	removeAllData() Removes and detaches all data and sets up the plot for further use.
void	removeNotify() Overrides removeNotify in JComponent Stops listening for changes in data
void	saveAs() Pops up a dialog asking the user to choose a file/format to save the plot.
void	setAllowPopupMenus(boolean allow)
void	setAllowUserInteraction(boolean allow) Controls whether end users are allowed to directly interact with the plot by way of popup menus or "clicking and dragging".
void	setBackground(Color c) Set the color used to paint the background (but not the data area)
void	setDataAreaBorder(Border b)
void	setDataAreaBorderType(int type) Set the border to place around the data area
void	setDataAreaColor(Color c) Set the color used to paint the background of the data area
void	setForegroundColor(Color c) Sets the current foreground color, used by default as the color for the axis, labels, title, legend etc.
void	setLegend(Legend newLegend)
void	setShowLegend(int legend) Set when the legend will be shown.
void	setShowStatistics(boolean show)
void	setStats(StatisticsBlock newStats)
void	setTitle(String newValue) Set the text of the title
void	setTitleObject(Title newTitle) Actually set the Title object.
void	showProperties() Pops up the Properties dialog box for this plot
void	showProperties(byte axis) Pops up the properties dialog box for this plot with the specified axis tab initially open
boolean	supportsProperties()
void	writeXML(Writer w, boolean snapshot) Writes the histogram, scatterplot etc that we are displaying as XML.

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, 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, 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

Field Detail

NONE

public static final int NONE

See Also:

Constant Field Values

BEVEL_IN

public static final int BEVEL_IN

See Also:

Constant Field Values

BEVEL_OUT

public static final int BEVEL_OUT

See Also:

Constant Field Values

ETCHED

public static final int ETCHED

See Also:

Constant Field Values

LINE

public static final int LINE

See Also:

Constant Field Values

SHADOW

public static final int SHADOW

See Also:

Constant Field Values

LEGEND_NEVER

public static final int LEGEND_NEVER

See Also:

Constant Field Values

LEGEND_AUTOMATIC

public static final int LEGEND_AUTOMATIC

See Also:

Constant Field Values

LEGEND_ALWAYS

public static final int LEGEND_ALWAYS

See Also:

Constant Field Values

Constructor Detail

JASHist

public JASHist()

Create a new JASHist component with no initial data source

Method Detail

getDataArea

public DataArea getDataArea()

supportsProperties

public boolean supportsProperties()

Returns:

true if a call to showProperties can currently be honoured

See Also:

showProperties()

showProperties

public void showProperties()

Pops up the Properties dialog box for this plot

See Also:

showProperties(byte)

showProperties

public void showProperties(byte axis)

Pops up the properties dialog box for this plot with the specified axis tab initially open

Parameters:

axis - The axis tab to opened (defined??)

See Also:

showProperties()

addNotify

public void addNotify()

Overrides addNotify in JComponent Starts listening for changes in data

Overrides:

addNotify in class JComponent

removeNotify

public void removeNotify()

Overrides removeNotify in JComponent Stops listening for changes in data

Overrides:

removeNotify in class JComponent

writeXML

public void writeXML(Writer w,
                     boolean snapshot)

Writes the histogram, scatterplot etc that we are displaying as XML.

Parameters:

pw - A PrintWriter to send the output to

snapshot - A snapshot of the current data is stored if true, otherwise a reference to the datasource

See Also:

XML How To

getAllowUserInteraction

public boolean getAllowUserInteraction()

Test if user direct user interaction with the plot is allowed

Returns:

True if user interaction is currently allowed

See Also:

setAllowUserInteraction(boolean)

setAllowUserInteraction

public void setAllowUserInteraction(boolean allow)

Controls whether end users are allowed to directly interact with the plot by way of popup menus or "clicking and dragging". By default user interaction is allowed. If no

Parameters:

allow - True if user interactions are to be allowed.

getAllowPopupMenus

public boolean getAllowPopupMenus()

setAllowPopupMenus

public void setAllowPopupMenus(boolean allow)

setShowStatistics

public void setShowStatistics(boolean show)

getShowStatistics

public boolean getShowStatistics()

setBackground

public void setBackground(Color c)

Set the color used to paint the background (but not the data area)

Overrides:

setBackground in class JComponent

Parameters:

c - The new Color to use, or null to set the background to be transparent

See Also:

setDataAreaColor(Color), setForegroundColor(Color)

getBackground

public Color getBackground()

Get the background color.

Overrides:

getBackground in class Component

setForegroundColor

public void setForegroundColor(Color c)

Sets the current foreground color, used by default as the color for the axis, labels, title, legend etc. By default the foreground color of the plots container is used

Parameters:

c - The new foreground color

getDataAreaColor

public Color getDataAreaColor()

Return the current data area background color

Returns:

The current data area background color

See Also:

setDataAreaColor(Color)

setDataAreaColor

public void setDataAreaColor(Color c)

Set the color used to paint the background of the data area

Parameters:

c - The new color to be used to paint the data area background, or null`to set the bacground back to the default value

See Also:

setBackground(Color), JComponent.setForeground(Color)

setDataAreaBorderType

public void setDataAreaBorderType(int type)

Set the border to place around the data area

Parameters:

type - One of NONE,BEVEL_IN,BEVEL_OUT,ETCHED,LINE,SHADOW

getDataAreaBorderType

public int getDataAreaBorderType()

Get the current data area border type

Returns:

One of NONE,BEVEL_IN,BEVEL_OUT,ETCHED,LINE,SHADOW,OTHER

setDataAreaBorder

public void setDataAreaBorder(Border b)

getDataAreaBorder

public Border getDataAreaBorder()

getXAxis

public JASHistAxis getXAxis()

Gets the X axis

Returns:

The current X axis

getYAxis

public JASHistAxis getYAxis()

Gets the default Y Axis

Returns:

The current default Y Axis

See Also:

getYAxis(int)

getYAxis

public JASHistAxis getYAxis(int index)

Gets either Y Axis.

Parameters:

index - The axis to get, 0 = left (default), 1 = right

Returns:

The requested Axis

getYAxes

public JASHistAxis[] getYAxes()

Get an array containing all of the Y Axes

setShowLegend

public void setShowLegend(int legend)

Set when the legend will be shown. By default the option is set to LEGEND_AUTOMATIC, which means that the legend will be shown whenever there is more than one DataSource attached to the plot.

Parameters:

legend - One of LEGEND_NEVER,LEGEND_AUTOMATIC,LEGEND_ALWAYS

getShowLegend

public int getShowLegend()

Get the current setting of the showLegend property

Returns:

The current settign of showLegend

See Also:

setShowLegend(int)

addData

public JASHistData addData(DataSource ds)
                    throws jas.hist.DataManagerException

Add a DataSource to the plot.

Parameters:

ds - The DataSource to add

Throws:

DataManagerException - If the subclass of DataSource is unrecognized or if the new DataSource is incompatible with previously added DataSources.

getDataSources

public Enumeration getDataSources()

Get the set of data sources currently attached to the plot. Note that despite the name of this routine it does not return an Enumeration of DataSources, but rather an Enumeration of JASHistData objects, from which the DataSource can be obtained, for example:

 Enumeration  e = hPlot.getDataSources();
 while (e.hasMoreElements())
 {
    JASHistData data = (JASHistData) e.nextElement();
    DataSource source = data.getDataSource();
 }
 

Returns:

An Enumeration of the JASHistData objects

See Also:

JASHistData, JASHistData.getDataSource()

getNumberOfDataSources

public int getNumberOfDataSources()

Get the number of data sources attached to the plot

get1DFunctions

public Enumeration get1DFunctions()

Get the set of Functions currently attached to the plot

Returns:

An Enumeration of the Functions, or null if the current DataSources do not support functions

destroy

public void destroy()

Removes and detaches all data from the plot, but doesn't set up the plot for further use. Call this method if you aren't going to be using the plot object any more. Call removeAllData() to remove all data and set up the plot for further use.

removeAllData

public void removeAllData()

Removes and detaches all data and sets up the plot for further use. The method destroy() is less expensive and should be used if the plot will not be used any more.

fillFunctionMenu

public void fillFunctionMenu(JMenu menu)

Fills the appropriate Function menu items into a user provided menu. This routine can be used to make a function fitting menu available to an external application without having to rewrite a bunch of code already contained in JASHist

Parameters:

menu - The menu to which the items will be added

fillSliceMenu

public void fillSliceMenu(JMenu menu)

Fills the appriate Slice/Projection menu items into a user provided menu. This routine can be used to make a function fitting menu available to an external application without having to rewrite a bunch of code already contained in JASHist

Parameters:

menu - The menu to which the items will be added

getTitle

public String getTitle()

Get the text of the title.

Returns:

A String containing the text of the title, or null if there is no title at present

See Also:

getTitleObject()

getTitleObject

public Title getTitleObject()

Actually get the Title object.

Returns:

The current title, or null if there is no title

setTitleObject

public void setTitleObject(Title newTitle)

Actually set the Title object.

Parameters:

newTitle - The new title object

setTitle

public void setTitle(String newValue)

Set the text of the title

Parameters:

newValue - pass null to remove the title

isChanged

public boolean isChanged()

addFitListener

public static void addFitListener(FitListener fitListener)

Add a FitListener that will receive notifications about the status of fits being performed by the plot

Parameters:

fitListener - The FitListener to add

mouseEventNotify

public void mouseEventNotify(MouseEvent e)

Specified by:

mouseEventNotify in interface JASPlotMouseListener

deselected

public void deselected()

getStats

public StatisticsBlock getStats()

setStats

public void setStats(StatisticsBlock newStats)

getLegend

public Legend getLegend()

setLegend

public void setLegend(Legend newLegend)

saveAs

public void saveAs()

Pops up a dialog asking the user to choose a file/format to save the plot.

copy

public void copy()

Copies the plot to the clipboard