desmoj.extensions.experimentation.ui

Class Chart

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

desmoj.extensions.experimentation.ui.Chart

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener

public class Chart
extends javax.swing.JComponent
implements java.awt.event.ActionListener

A GUI component (inherited from java.awt.Canvas) which displays a chart. It includes two labeled and auto-scaled axes. There a methods (drawLine, drawRect, fillRect) to paint on the chart without taking care about transforming or scaling the dimensions. You have to add this class to a panel or a frame. You also have to implement the method which should draw the data (e.g. a histogram or a mathematical function) in a class which is inherited from the interface ChartOwner.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Philip Joschko Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

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

Constructors

Constructor and Description
Chart(ChartOwner chartOwner, java.lang.String x_label, java.lang.String y_label) Constructor of the chart.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Event handler for this class.
int	calculateXPosition(double x) Calculates the x coordinate in pixels for the given x data value.
int	calculateYPosition(double y) Calculates the y coordinate in pixels for the given y data value.
void	drawLine(java.awt.Color color, double x1, double y1, double x2, double y2) Draws a line into the chart.
void	drawLine(java.awt.Graphics g, double x1, double y1, double x2, double y2) Draws a line into the chart.
void	drawRect(java.awt.Graphics g, double x1, double y1, double x2, double y2) Draws an unfilled rectangle into the chart.
void	fillRect(java.awt.Graphics g, double x1, double y1, double x2, double y2) Draws a filled rectangle into the chart.
void	paint(java.awt.Graphics g) This method is called automatically if the canvas has to be repaint.
void	paintBackground(java.awt.Graphics g) Draws the chart basics.
void	processMouseEvent(java.awt.event.MouseEvent e) Event handler for right-mouse-clicks onto the chart.
void	setMax_x(double max_x) Sets the maximum x value which appears in the data.
void	setMax_y(double max_y) Sets the maximum y value which appears in the data.
void	setMin_x(double min_x) Sets the minimum x value which appears in the data.
void	setMin_y(double min_y) Sets the minimum y value which appears in the data.
void	setX_label(java.lang.String x_label) Resets the legend (labeling) for the x axis.
void	setY_label(java.lang.String y_label) Resets the legend (labeling) for the y axis.
boolean	testValue(double x, double y) Tests a new pair of values which appears in the data.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, 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, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Chart

public Chart(ChartOwner chartOwner,
             java.lang.String x_label,
             java.lang.String y_label)

Constructor of the chart. Saves the given labels for x- and y-axis and calls the constructor of java.awt.Canvas

Parameters:

chartOwner - The object which implements the drawChart() method.

x_label - The legend for the x axis.

y_label - The legend for the y axis.

Method Detail

paint

public void paint(java.awt.Graphics g)

This method is called automatically if the canvas has to be repaint. You don`t have to do this! It overrides the paint(Graphics) method from java.awt.Canvas. If size of the chart is big enough, it calls paintBackground() (for painting the chart background).

Overrides:

paint in class javax.swing.JComponent

Parameters:

g - The specified Graphics context.

paintBackground

public void paintBackground(java.awt.Graphics g)

Draws the chart basics. Calculates the best fitting intervalls for the axes. Paints a white backgorund, the axes, the labels and a grey grid for easier metering. At last it tansforms (not scales!) the coordinate system. Thus the methods drawLine, drawRect and fillRect must not take care about transforming: The root of the coordinate system will be (0,0), and the value y will be autoscaled to -y, so a higher data value will be painted above a lower y value, unlike the coordinate system of a canvas. ATTENTION: The value "1" still represents a pixel, because if we would scale "1" to interval_x (or rather interval_y) a new line would be very fat (that is not want we want). The "scaling" will be done by the methods calculateXPosition() and calculateYPosition() of this class, which will be automatically invoked if you use drawLine(), drawRect() or fillRect().

Parameters:

g - The specified Graphics context.

calculateXPosition

public int calculateXPosition(double x)

Calculates the x coordinate in pixels for the given x data value.

Parameters:

x - The x data value.

Returns:

The x position in pixels, where the data value should be painted.

calculateYPosition

public int calculateYPosition(double y)

Calculates the y coordinate in pixels for the given y data value.

Parameters:

y - The y data value.

Returns:

The y position in pixels, where the data value should be painted.

drawLine

public void drawLine(java.awt.Graphics g,
                     double x1,
                     double y1,
                     double x2,
                     double y2)

Draws a line into the chart. This method automatically calls the methods calculateXPosition() and calculateYPosition() so you don`t have to take care about any scaling or transforming.

Parameters:

g - The specified Graphics context.

x1 - The x value of the starting coordinates.

y1 - The y value of the starting coordinates.

x2 - The x value of the ending coordinates.

y2 - The x value of the ending coordinates.

drawRect

public void drawRect(java.awt.Graphics g,
                     double x1,
                     double y1,
                     double x2,
                     double y2)

Draws an unfilled rectangle into the chart. This method automatically calls the methods calculateXPosition() and calculateYPosition() so you don`t have to take care about any scaling or transforming.

Parameters:

g - The specified Graphics context.

x1 - The x value of the starting coordinates.

y1 - The y value of the starting coordinates.

x2 - The x value of the ending coordinates.

y2 - The x value of the ending coordinates.

fillRect

public void fillRect(java.awt.Graphics g,
                     double x1,
                     double y1,
                     double x2,
                     double y2)

Draws a filled rectangle into the chart. This method automatically calls the methods calculateXPosition() and calculateYPosition() so you don`t have to take care about any scaling or transforming.

Parameters:

g - The specified Graphics context.

x1 - The x value of the starting coordinates.

y1 - The y value of the starting coordinates.

x2 - The x value of the ending coordinates.

y2 - The x value of the ending coordinates.

drawLine

public void drawLine(java.awt.Color color,
                     double x1,
                     double y1,
                     double x2,
                     double y2)

Draws a line into the chart. This method automatically calls the methods calculateXPosition() and calculateYPosition() so you don`t have to take care about any scaling or transforming. If you have a graphic context (e.g. method shall be invoked via a paint(Graphics g) method you should NOT use this method, but rather drawLine(Graphics, double, double, double, double).

Parameters:

color - The color of the line.

x1 - The x value of the starting coordinates.

y1 - The y value of the starting coordinates.

x2 - The x value of the ending coordinates.

y2 - The x value of the ending coordinates.

testValue

public boolean testValue(double x,
                         double y)

Tests a new pair of values which appears in the data. The pair will NOT be stored, it only will be tested if the values are lower or higher than the existing minimums and maximums. This is needed for scaling the chart automatically.

Parameters:

x - A new x value which shall be tested, if it is the new minmum or maximum.

y - A new y value which shall be tested, if it is the new minmum or maximum.

Returns:

Returns true if the values are higher or smaller than the current axis borders.

setMax_y

public void setMax_y(double max_y)

Sets the maximum y value which appears in the data.

Parameters:

max_y - The maximum y value which appears in the data.

setMax_x

public void setMax_x(double max_x)

Sets the maximum x value which appears in the data.

Parameters:

max_x - The maximum x value which appears in the data.

setMin_x

public void setMin_x(double min_x)

Sets the minimum x value which appears in the data.

Parameters:

min_x - The minimum x value which appears in the data.

setMin_y

public void setMin_y(double min_y)

Sets the minimum y value which appears in the data.

Parameters:

min_y - The minimum y value which appears in the data.

setX_label

public void setX_label(java.lang.String x_label)

Resets the legend (labeling) for the x axis.

Parameters:

x_label - A new title for the x axis.

setY_label

public void setY_label(java.lang.String y_label)

Resets the legend (labeling) for the y axis.

Parameters:

y_label - A new title for the y axis.

processMouseEvent

public void processMouseEvent(java.awt.event.MouseEvent e)

Event handler for right-mouse-clicks onto the chart. The context menu will be shown.

Overrides:

processMouseEvent in class javax.swing.JComponent

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Event handler for this class. Does nothing.

Specified by:

actionPerformed in interface java.awt.event.ActionListener