com.zavtech.morpheus.viz.jfree

Class JFChartBase<P>

java.lang.Object

com.zavtech.morpheus.viz.jfree.JFChartBase<P>

Type Parameters:

P - the plot type

All Implemented Interfaces:

Chart<P>, EventListener, org.jfree.chart.ChartMouseListener

Direct Known Subclasses:

JFCatChart, JFPieChart, JFXyChart

abstract class JFChartBase<P>
extends Object
implements Chart<P>, org.jfree.chart.ChartMouseListener

A convenience base class for building various types of chart types

Author:

Xavier Witdouck

This is open source software released under the Apache 2.0 License

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	JFChartBase.LegendAdapter A JFreeChart adapter to manage the chart legend
private class	JFChartBase.ThemeAdapter The ChartTheme adapter
private class	JFChartBase.TitleAdapter A JFreeChart ChartLabel adapter for the chart title

Field Summary

Fields

Modifier and Type	Field and Description
private org.jfree.chart.ChartPanel	chartPanel
private org.jfree.chart.JFreeChart	freeChart
private ChartOptions	options
private P	plot

Fields inherited from interface com.zavtech.morpheus.viz.chart.Chart

factory

Constructor Summary

Constructors

Constructor and Description
JFChartBase(P plot, boolean legend) Constructor

Method Summary

Modifier and Type	Method and Description
void	accept(JsCode jsCode, String functionName, String divId) Writes a Javascript function with the name specified that will render this chart
(package private) org.jfree.chart.ChartPanel	chartPanel() Returns a reference to the chart panel
(package private) org.jfree.chart.JFreeChart	freeChart() Returns the JFreeChart reference for this chart
ChartLegend	legend() Returns the chart legend control for this chart
ChartOptions	options() Returns the options interface for this chart
P	plot() Returns the plot interface for this chart
Chart	show() Shows this chart on an appropriate output device
Chart	show(int width, int height) Shows this chart on an appropriate output device
ChartLabel	subtitle() Returns the chart subtitle interface
ChartTheme	theme() Returns the theme interface for this chart
ChartLabel	title() Returns the chart title interface
(package private) String	toBase64Image() Returns a base64 encoded string of a PNG image generated from this chart
private org.jfree.chart.plot.Plot	underlying(P plot) Returns the JFreeChart plot object from the Morpheus Plot adapter
Chart	writerPng(File file, int width, int height, boolean transparent) Writes a PNH image of the chart to the output stream
Chart	writerPng(OutputStream os, int width, int height, boolean transparent) Writes a PNH image of the chart to the output stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.zavtech.morpheus.viz.chart.Chart

create, show, show

Methods inherited from interface org.jfree.chart.ChartMouseListener

chartMouseClicked, chartMouseMoved

Field Detail

plot

private P plot

freeChart

private org.jfree.chart.JFreeChart freeChart

chartPanel

private org.jfree.chart.ChartPanel chartPanel

options

private ChartOptions options

Constructor Detail

JFChartBase

JFChartBase(P plot,
            boolean legend)

Constructor

Parameters:

plot - the plot for this chart

legend - true to enable legend

Method Detail

underlying

private org.jfree.chart.plot.Plot underlying(P plot)

Returns the JFreeChart plot object from the Morpheus Plot adapter

Parameters:

plot - the Morpheus plot adapter

Returns:

the JFreeChart plot

chartPanel

org.jfree.chart.ChartPanel chartPanel()

Returns a reference to the chart panel

Returns:

the JFreeChart chart panel

freeChart

org.jfree.chart.JFreeChart freeChart()

Returns the JFreeChart reference for this chart

Returns:

the JFreeChart reference

plot

public P plot()

Description copied from interface: Chart

Returns the plot interface for this chart

Specified by:

plot in interface Chart<P>

Returns:

the plot interface for this chart

title

public ChartLabel title()

Description copied from interface: Chart

Returns the chart title interface

Specified by:

title in interface Chart<P>

Returns:

chart title interface

subtitle

public ChartLabel subtitle()

Description copied from interface: Chart

Returns the chart subtitle interface

Specified by:

subtitle in interface Chart<P>

Returns:

chart subtitle interface

legend

public ChartLegend legend()

Description copied from interface: Chart

Returns the chart legend control for this chart

Specified by:

legend in interface Chart<P>

Returns:

the legend control interface

options

public ChartOptions options()

Description copied from interface: Chart

Returns the options interface for this chart

Specified by:

options in interface Chart<P>

Returns:

additional chart options

theme

public ChartTheme theme()

Description copied from interface: Chart

Returns the theme interface for this chart

Specified by:

theme in interface Chart<P>

Returns:

the theme interface

show

public Chart show()

Description copied from interface: Chart

Shows this chart on an appropriate output device

Specified by:

show in interface Chart<P>

Returns:

this chart

show

public Chart show(int width,
                  int height)

Description copied from interface: Chart

Shows this chart on an appropriate output device

Specified by:

show in interface Chart<P>

Parameters:

width - the width for chart

height - the height for chart

Returns:

this chart

writerPng

public Chart writerPng(File file,
                       int width,
                       int height,
                       boolean transparent)

Description copied from interface: Chart

Writes a PNH image of the chart to the output stream

Specified by:

writerPng in interface Chart<P>

Parameters:

file - the file reference

width - the image width

height - the image height

transparent - true for a transparent background

Returns:

this chart

writerPng

public Chart writerPng(OutputStream os,
                       int width,
                       int height,
                       boolean transparent)

Description copied from interface: Chart

Writes a PNH image of the chart to the output stream

Specified by:

writerPng in interface Chart<P>

Parameters:

os - the output stream

width - the image width

height - the image height

transparent - true for a transparent background

Returns:

this chart

accept

public void accept(JsCode jsCode,
                   String functionName,
                   String divId)

Description copied from interface: Chart

Writes a Javascript function with the name specified that will render this chart

Specified by:

accept in interface Chart<P>

Parameters:

jsCode - the Javascript code generator

functionName - the function name for this chart's plot instructions

divId - the ID of the div element in which to draw chart

toBase64Image

String toBase64Image()
              throws IOException

Returns a base64 encoded string of a PNG image generated from this chart

Returns:

the base64 encoded image

Throws:

IOException - if there is an I/O exception