Class ChartPanel

public static final boolean DEFAULT_BUFFER_USED

Default setting for buffer usage.

Field Value:

false

public static final int DEFAULT_HEIGHT

The default panel height.

Field Value:

420

public static final int DEFAULT_MAXIMUM_DRAW_HEIGHT

The default limit below which chart scaling kicks in.

Field Value:

600

public static final int DEFAULT_MAXIMUM_DRAW_WIDTH

The default limit below which chart scaling kicks in.

Field Value:

800

public static final int DEFAULT_MINIMUM_DRAW_HEIGHT

The default limit below which chart scaling kicks in.

Field Value:

200

public static final int DEFAULT_MINIMUM_DRAW_WIDTH

The default limit below which chart scaling kicks in.

Field Value:

300

public static final int DEFAULT_WIDTH

The default panel width.

Field Value:

680

public static final int DEFAULT_ZOOM_TRIGGER_DISTANCE

The minimum size required to perform a zoom on a rectangle

Field Value:

10

public static final String PRINT_COMMAND

Print action command.

public static final String PROPERTIES_COMMAND

Properties action command.

public static final String SAVE_COMMAND

Save action command.

public static final String ZOOM_IN_BOTH_COMMAND

Zoom in (both axes) action command.

public static final String ZOOM_IN_DOMAIN_COMMAND

Zoom in (domain axis only) action command.

public static final String ZOOM_IN_RANGE_COMMAND

Zoom in (range axis only) action command.

public static final String ZOOM_OUT_BOTH_COMMAND

Zoom out (both axes) action command.

public static final String ZOOM_OUT_DOMAIN_COMMAND

Zoom out (domain axis only) action command.

public static final String ZOOM_OUT_RANGE_COMMAND

Zoom out (range axis only) action command.

public static final String ZOOM_RESET_BOTH_COMMAND

Zoom reset (both axes) action command.

public static final String ZOOM_RESET_DOMAIN_COMMAND

Zoom reset (domain axis only) action command.

public static final String ZOOM_RESET_RANGE_COMMAND

Zoom reset (range axis only) action command.

protected static ResourceBundle localizationResources

The resourceBundle for the localization.

public ChartPanel(JFreeChart chart)

Constructs a panel that displays the specified chart.

Parameters:

chart - the chart.

public ChartPanel(JFreeChart chart,
                  boolean useBuffer)

Constructs a panel containing a chart.

Parameters:

chart - the chart.

useBuffer - a flag controlling whether or not an off-screen buffer is used.

public ChartPanel(JFreeChart chart,
                  boolean properties,
                  boolean save,
                  boolean print,
                  boolean zoom,
                  boolean tooltips)

Constructs a JFreeChart panel.

Parameters:

chart - the chart.

properties - a flag indicating whether or not the chart property editor should be available via the popup menu.

save - a flag indicating whether or not save options should be available via the popup menu.

print - a flag indicating whether or not the print option should be available via the popup menu.

zoom - a flag indicating whether or not zoom options should be added to the popup menu.

tooltips - a flag indicating whether or not tooltips should be enabled for the chart.

public ChartPanel(JFreeChart chart,
                  int width,
                  int height,
                  int minimumDrawWidth,
                  int minimumDrawHeight,
                  int maximumDrawWidth,
                  int maximumDrawHeight,
                  boolean useBuffer,
                  boolean properties,
                  boolean save,
                  boolean print,
                  boolean zoom,
                  boolean tooltips)

Constructs a JFreeChart panel.

Parameters:

chart - the chart.

width - the preferred width of the panel.

height - the preferred height of the panel.

minimumDrawWidth - the minimum drawing width.

minimumDrawHeight - the minimum drawing height.

maximumDrawWidth - the maximum drawing width.

maximumDrawHeight - the maximum drawing height.

useBuffer - a flag that indicates whether to use the off-screen buffer to improve performance (at the expense of memory).

properties - a flag indicating whether or not the chart property editor should be available via the popup menu.

save - a flag indicating whether or not save options should be available via the popup menu.

print - a flag indicating whether or not the print option should be available via the popup menu.

zoom - a flag indicating whether or not zoom options should be added to the popup menu.

tooltips - a flag indicating whether or not tooltips should be enabled for the chart.

public void actionPerformed(ActionEvent event)

Handles action events generated by the popup menu.

Parameters:

event - the event.

public void addChartMouseListener(ChartMouseListener listener)

Adds a listener to the list of objects listening for chart mouse events.

Parameters:

listener - the listener (null not permitted).

public void chartChanged(ChartChangeEvent event)

Receives notification of changes to the chart, and redraws the chart.

Specified by:

chartChanged in interface ChartChangeListener

Parameters:

event - details of the chart change event.

public void chartProgress(ChartProgressEvent event)

Receives notification of a chart progress event.

Specified by:

chartProgress in interface ChartProgressListener

Parameters:

event - the event.

public void createChartPrintJob()

Creates a print job for the chart.

protected JPopupMenu createPopupMenu(boolean properties,
                                     boolean save,
                                     boolean print,
                                     boolean zoom)

Creates a popup menu for the panel.

Parameters:

properties - include a menu item for the chart property editor.

save - include a menu item for saving the chart.

print - include a menu item for printing the chart.

zoom - include menu items for zooming.

Returns:

The popup menu.

protected void displayPopupMenu(int x,
                                int y)

The idea is to modify the zooming options depending on the type of chart being displayed by the panel.

Parameters:

x - horizontal position of the popup.

y - vertical position of the popup.

public void doEditChartProperties()

Displays a dialog that allows the user to edit the properties for the current chart.

Since:

1.0.3

public void doSaveAs()
            throws IOException

Opens a file chooser and gives the user an opportunity to save the chart in PNG format.

public Point2D getAnchor()

Returns the anchor point.

Returns:

The anchor point (possibly null).

public JFreeChart getChart()

Returns the chart contained in the panel.

Returns:

The chart (possibly null).

public ChartRenderingInfo getChartRenderingInfo()

Returns the chart rendering info from the most recent chart redraw.

Returns:

The chart rendering info.

public int getDismissDelay()

Returns the dismissal tooltip delay value used inside this chart panel.

Returns:

An integer representing the dismissal delay value, in milliseconds.

See Also:

javax.swing.ToolTipManager.getDismissDelay()

public ChartEntity getEntityForPoint(int viewX,
                                     int viewY)

Returns the chart entity at a given point.

This method will return null if there is (a) no entity at the given point, or (b) no entity collection has been generated.

Parameters:

viewX - the x-coordinate.

viewY - the y-coordinate.

Returns:

The chart entity (possibly null).

public boolean getFillZoomRectangle()

Returns the flag that controls whether or not the zoom rectangle is filled when drawn.

Returns:

A boolean.

public boolean getHorizontalAxisTrace()

Returns the flag that controls whether or not a horizontal axis trace line is drawn over the plot area at the current mouse location.

Returns:

A boolean.

protected Line2D getHorizontalTraceLine()

Returns the horizontal trace line.

Returns:

The horizontal trace line (possibly null).

public int getInitialDelay()

Returns the initial tooltip delay value used inside this chart panel.

Returns:

An integer representing the initial delay value, in milliseconds.

See Also:

javax.swing.ToolTipManager.getInitialDelay()

public EventListener[] getListeners(Class listenerType)

Returns an array of the listeners of the given type registered with the panel.

Parameters:

listenerType - the listener type.

Returns:

An array of listeners.

public int getMaximumDrawHeight()

Returns the maximum drawing height for charts.

If the height available on the panel is greater than this, then the chart is drawn at the maximum height then scaled up to fit.

Returns:

The maximum drawing height.

public int getMaximumDrawWidth()

Returns the maximum drawing width for charts.

If the width available on the panel is greater than this, then the chart is drawn at the maximum width then scaled up to fit.

Returns:

The maximum drawing width.

public int getMinimumDrawHeight()

Returns the minimum drawing height for charts.

If the height available on the panel is less than this, then the chart is drawn at the minimum height then scaled down to fit.

Returns:

The minimum drawing height.

public int getMinimumDrawWidth()

Returns the minimum drawing width for charts.

If the width available on the panel is less than this, then the chart is drawn at the minimum width then scaled down to fit.

Returns:

The minimum drawing width.

public JPopupMenu getPopupMenu()

Returns the popup menu.

Returns:

The popup menu.

public boolean getRefreshBuffer()

Returns the flag that controls whether or not the offscreen buffer needs to be refreshed.

Returns:

A boolean.

public int getReshowDelay()

Returns the reshow tooltip delay value used inside this chart panel.

Returns:

An integer representing the reshow delay value, in milliseconds.

See Also:

javax.swing.ToolTipManager.getReshowDelay()

public double getScaleX()

Returns the X scale factor for the chart. This will be 1.0 if no scaling has been used.

Returns:

The scale factor.

public double getScaleY()

Returns the Y scale factory for the chart. This will be 1.0 if no scaling has been used.

Returns:

The scale factor.

public Rectangle2D getScreenDataArea()

Returns the data area for the chart (the area inside the axes) with the current scaling applied (that is, the area as it appears on screen).

Returns:

The scaled data area.

public Rectangle2D getScreenDataArea(int x,
                                     int y)

Returns the data area (the area inside the axes) for the plot or subplot, with the current scaling applied.

Parameters:

x - the x-coordinate (for subplot selection).

y - the y-coordinate (for subplot selection).

Returns:

The scaled data area.

public String getToolTipText(MouseEvent e)

Returns a string for the tooltip.

Parameters:

e - the mouse event.

Returns:

A tool tip or null if no tooltip is available.

public boolean getVerticalAxisTrace()

Returns the flag that controls whether or not a vertical axis trace line is drawn over the plot area at the current mouse location.

Returns:

A boolean.

protected Line2D getVerticalTraceLine()

Returns the vertical trace line.

Returns:

The vertical trace line (possibly null).

public double getZoomInFactor()

Returns the zoom in factor.

Returns:

The zoom in factor.

See Also:

setZoomInFactor(double)

public double getZoomOutFactor()

Returns the zoom out factor.

Returns:

The zoom out factor.

See Also:

setZoomOutFactor(double)

public int getZoomTriggerDistance()

Returns the zoom trigger distance. This controls how far the mouse must move before a zoom action is triggered.

Returns:

The distance (in Java2D units).

public boolean isDomainZoomable()

Returns the flag that determines whether or not zooming is enabled for the domain axis.

Returns:

A boolean.

public boolean isEnforceFileExtensions()

Returns true if file extensions should be enforced, and false otherwise.

Returns:

The flag.

public boolean isRangeZoomable()

Returns the flag that determines whether or not zooming is enabled for the range axis.

Returns:

A boolean.

public void mouseClicked(MouseEvent event)

Receives notification of mouse clicks on the panel. These are translated and passed on to any registered chart mouse click listeners.

Parameters:

event - Information about the mouse event.

public void mouseDragged(MouseEvent e)

Handles a 'mouse dragged' event.

Parameters:

e - the mouse event.

public void mouseEntered(MouseEvent e)

Handles a 'mouse entered' event. This method changes the tooltip delays of ToolTipManager.sharedInstance() to the possibly different values set for this chart panel.

Parameters:

e - the mouse event.

public void mouseExited(MouseEvent e)

Handles a 'mouse exited' event. This method resets the tooltip delays of ToolTipManager.sharedInstance() to their original values in effect before mouseEntered()

Parameters:

e - the mouse event.

public void mouseMoved(MouseEvent e)

Implementation of the MouseMotionListener's method.

Parameters:

e - the event.

public void mousePressed(MouseEvent e)

Handles a 'mouse pressed' event.

This event is the popup trigger on Unix/Linux. For Windows, the popup trigger is the 'mouse released' event.

Parameters:

e - The mouse event.

public void mouseReleased(MouseEvent e)

Handles a 'mouse released' event. On Windows, we need to check if this is a popup trigger, but only if we haven't already been tracking a zoom rectangle.

Parameters:

e - information about the event.

public void paintComponent(Graphics g)

Paints the component by drawing the chart to fill the entire component, but allowing for the insets (which will be non-zero if a border has been set for this component). To increase performance (at the expense of memory), an off-screen buffer image can be used.

Parameters:

g - the graphics device for drawing on.

public int print(Graphics g,
                 PageFormat pf,
                 int pageIndex)

Prints the chart on a single page.

Parameters:

g - the graphics context.

pf - the page format to use.

pageIndex - the index of the page. If not 0, nothing gets print.

Returns:

The result of printing.

public void removeChartMouseListener(ChartMouseListener listener)

Removes a listener from the list of objects listening for chart mouse events.

Parameters:

listener - the listener.

public void restoreAutoBounds()

Restores the auto-range calculation on both axes.

public void restoreAutoDomainBounds()

Restores the auto-range calculation on the domain axis.

public void restoreAutoRangeBounds()

Restores the auto-range calculation on the range axis.

public Rectangle2D scale(Rectangle2D rect)

Applies any scaling that is in effect for the chart drawing to the given rectangle.

Parameters:

rect - the rectangle.

Returns:

A new scaled rectangle.

protected void setAnchor(Point2D anchor)

Sets the anchor point. This method is provided for the use of subclasses, not end users.

Parameters:

anchor - the anchor point (null permitted).

public void setChart(JFreeChart chart)

Sets the chart that is displayed in the panel.

Parameters:

chart - the chart (null permitted).

public void setDismissDelay(int delay)

Specifies the dismissal delay value for this chart panel.

Parameters:

delay - the number of milliseconds to delay before taking away the tooltip

See Also:

javax.swing.ToolTipManager.setDismissDelay(int)

public void setDisplayToolTips(boolean flag)

Switches the display of tooltips for the panel on or off. Note that tooltips can only be displayed if the chart has been configured to generate tooltip items.

Parameters:

flag - true to enable tooltips, false to disable tooltips.

public void setDomainZoomable(boolean flag)

Sets the flag that controls whether or not zooming is enable for the domain axis. A check is made to ensure that the current plot supports zooming for the domain values.

Parameters:

flag - true enables zooming if possible.

public void setEnforceFileExtensions(boolean enforce)

Sets a flag that controls whether or not file extensions are enforced.

Parameters:

enforce - the new flag value.

public void setFillZoomRectangle(boolean flag)

A flag that controls how the zoom rectangle is drawn.

Parameters:

flag - true instructs to fill the rectangle on zoom, otherwise it will be outlined.

public void setHorizontalAxisTrace(boolean flag)

A flag that controls trace lines on the horizontal axis.

Parameters:

flag - true enables trace lines for the mouse pointer on the horizontal axis.

protected void setHorizontalTraceLine(Line2D line)

Sets the horizontal trace line.

Parameters:

line - the line (null permitted).

public void setInitialDelay(int delay)

Specifies the initial delay value for this chart panel.

Parameters:

delay - the number of milliseconds to delay (after the cursor has paused) before displaying.

See Also:

javax.swing.ToolTipManager.setInitialDelay(int)

public void setMaximumDrawHeight(int height)

Sets the maximum drawing height for the chart on this panel.

At the time the chart is drawn on the panel, if the available height is greater than this amount, the chart will be drawn using the maximum height then scaled up to fit the available space.

Parameters:

height - The height.

public void setMaximumDrawWidth(int width)

Sets the maximum drawing width for the chart on this panel.

At the time the chart is drawn on the panel, if the available width is greater than this amount, the chart will be drawn using the maximum width then scaled up to fit the available space.

Parameters:

width - The width.

public void setMinimumDrawHeight(int height)

Sets the minimum drawing height for the chart on this panel.

At the time the chart is drawn on the panel, if the available height is less than this amount, the chart will be drawn using the minimum height then scaled down to fit the available space.

Parameters:

height - The height.

public void setMinimumDrawWidth(int width)

Sets the minimum drawing width for the chart on this panel.

At the time the chart is drawn on the panel, if the available width is less than this amount, the chart will be drawn using the minimum width then scaled down to fit the available space.

Parameters:

width - The width.

public void setMouseZoomable(boolean flag)

A convenience method that switches on mouse-based zooming.

Parameters:

flag - true enables zooming and rectangle fill on zoom.

public void setMouseZoomable(boolean flag,
                             boolean fillRectangle)

A convenience method that switches on mouse-based zooming.

Parameters:

flag - true if zooming enabled

fillRectangle - true if zoom rectangle is filled, false if rectangle is shown as outline only.

public void setPopupMenu(JPopupMenu popup)

Sets the popup menu for the panel.

Parameters:

popup - the popup menu (null permitted).

public void setRangeZoomable(boolean flag)

A flag that controls mouse-based zooming on the vertical axis.

Parameters:

flag - true enables zooming.

public void setRefreshBuffer(boolean flag)

Sets the refresh buffer flag. This flag is used to avoid unnecessary redrawing of the chart when the offscreen image buffer is used.

Parameters:

flag - true indicate, that the buffer should be refreshed.

public void setReshowDelay(int delay)

Specifies the amount of time before the user has to wait initialDelay milliseconds before a tooltip will be shown.

Parameters:

delay - time in milliseconds

See Also:

javax.swing.ToolTipManager.setReshowDelay(int)

public void setVerticalAxisTrace(boolean flag)

A flag that controls trace lines on the vertical axis.

Parameters:

flag - true enables trace lines for the mouse pointer on the vertical axis.

protected void setVerticalTraceLine(Line2D line)

Sets the vertical trace line.

Parameters:

line - the line (null permitted).

public void setZoomInFactor(double factor)

Sets the zoom in factor.

Parameters:

factor - the factor.

See Also:

getZoomInFactor()

public void setZoomOutFactor(double factor)

Sets the zoom out factor.

Parameters:

factor - the factor.

See Also:

getZoomOutFactor()

public void setZoomTriggerDistance(int distance)

Sets the zoom trigger distance. This controls how far the mouse must move before a zoom action is triggered.

Parameters:

distance - the distance (in Java2D units).

public Point translateJava2DToScreen(Point2D java2DPoint)

Translates a Java2D point on the chart to a screen location.

Parameters:

java2DPoint - the Java2D point.

Returns:

The screen location.

public Point2D translateScreenToJava2D(Point screenPoint)

Translates a screen location to a Java2D point.

Parameters:

screenPoint - the screen location.

Returns:

The Java2D coordinates.

public void zoom(Rectangle2D selection)

Zooms in on a selected region.

Parameters:

selection - the selected region.

public void zoomInBoth(double x,
                       double y)

Zooms in on an anchor point (specified in screen coordinate space).

Parameters:

x - the x value (in screen coordinates).

y - the y value (in screen coordinates).

public void zoomInDomain(double x,
                         double y)

Decreases the length of the domain axis, centered about the given coordinate on the screen. The length of the domain axis is reduced by the value of getZoomInFactor().

Parameters:

x - the x coordinate (in screen coordinates).

y - the y-coordinate (in screen coordinates).

public void zoomInRange(double x,
                        double y)

Decreases the length of the range axis, centered about the given coordinate on the screen. The length of the range axis is reduced by the value of getZoomInFactor().

Parameters:

x - the x-coordinate (in screen coordinates).

y - the y coordinate (in screen coordinates).

public void zoomOutBoth(double x,
                        double y)

Zooms out on an anchor point (specified in screen coordinate space).

Parameters:

x - the x value (in screen coordinates).

y - the y value (in screen coordinates).

public void zoomOutDomain(double x,
                          double y)

Increases the length of the domain axis, centered about the given coordinate on the screen. The length of the domain axis is increased by the value of getZoomOutFactor().

Parameters:

x - the x coordinate (in screen coordinates).

y - the y-coordinate (in screen coordinates).

public void zoomOutRange(double x,
                         double y)

Increases the length the range axis, centered about the given coordinate on the screen. The length of the range axis is increased by the value of getZoomOutFactor().

Parameters:

x - the x coordinate (in screen coordinates).

y - the y-coordinate (in screen coordinates).