desmoj.extensions.experimentation.ui

Class ChartPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

desmoj.extensions.experimentation.ui.ChartPanel

All Implemented Interfaces:

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

public class ChartPanel
extends javax.swing.JPanel
implements java.awt.event.ActionListener

A GUI container (inherited from javax.swing.JPanel) which includes a header, legend items (if needed) and a special Chart object. All functionality of the Chart object which is needed by the user, is encapsulated in this class, so the user doesn`t need to have direct access to the Chart object, he doesn`t need to care about the Chart object at all. This class additionally includes a method saveAs(filename) for saving the chart to an image file. If you are a user of DESMO-J you don`t need to create a object of this kind: Create a HistogramPlotter or a TimeSeriesPlotter instead! This class is needed by the graphical observers HistogramPlotter and TimeSeriesPlotter. If you want to extend DESMO-J you can create new plotter classes inherited from GraphicalObserver which contains this object as a private field "myGUI" and a method drawChart(Graphics) for implementing the drawing of the data.

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
ChartPanel(ChartOwner chartOwner, java.lang.String name, java.lang.String x_label, java.lang.String y_label) Constructor of the chart panel.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Event handler for the items in the context menu.
void	addLegend(java.lang.String text) Adds a new legend item at the bottom of the panel in a new color.
static java.awt.Color	color(int i) Returns the colors used to draw charts.
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) Paints the panel and all of its components.
void	processMouseEvent(java.awt.event.MouseEvent e) Event handler for right-mouse-clicks onto the chart.
void	redrawChart() Forces the chart to repaint.
void	saveAs(java.lang.String title) Saves the chart (including title and legend) as an image file.
void	scale() Rescales the size of the header font.
void	set_xlabel(java.lang.String x_label) Resets the legend (labeling) for the x axis.
void	set_ylabel(java.lang.String y_label) Resets the legend (labeling) for the y axis.
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.
boolean	testValue(double x, double y) Tests a new pair of values which appears in the data.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

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

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

ChartPanel

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

Constructor of the chart panel. If you are a user of Desmo-J you don`t need to create a object of this kind: Create a HistogramPlotter or a TimeSeriesPlotter instead! If you want to extend Desmo-J you can create new plotter classses inherited from GraphicalObserver which contains this object as a private field "myGUI" and a method drawChart(Graphics) for implementing the drawing of the data.

Parameters:

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

name - Title of the chart.

x_label - The labeling for the x axis.

y_label - The labeling for the y axis.

Method Detail

paint

public void paint(java.awt.Graphics g)

Paints the panel and all of its components.

Overrides:

paint in class javax.swing.JComponent

scale

public void scale()

Rescales the size of the header font.

redrawChart

public void redrawChart()

Forces the chart to repaint.

addLegend

public void addLegend(java.lang.String text)

Adds a new legend item at the bottom of the panel in a new color.

Parameters:

text - The labeling of the legend item.

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

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.

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.

set_xlabel

public void set_xlabel(java.lang.String x_label)

Resets the legend (labeling) for the x axis.

Parameters:

x_label - A new title for the x axis.

set_ylabel

public void set_ylabel(java.lang.String y_label)

Resets the legend (labeling) for the y axis.

Parameters:

y_label - A new title for the y axis.

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.

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 the items in the context menu.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

saveAs

public void saveAs(java.lang.String title)

Saves the chart (including title and legend) as an image file. If saving fails, the exception will be catched, but not handled.

Parameters:

title -

color

public static java.awt.Color color(int i)

Returns the colors used to draw charts. You can draw more than one diagram in one chart. If you do so, you have to use colors in the same order, as the legend showcases them. This static method returns different colors, starting with 0=RED and ending with 9=LIGHTGREY. All values higher or smaller than this will return BLACK. This is not implemented as static final array, because of the possibility to draw more charts then colors exists (they will be black).

Parameters:

i - The index number of the color you want.

Returns:

An AWT Color object.