de.slothsoft.charts

Class Chart

java.lang.Object

de.slothsoft.charts.Chart

Direct Known Subclasses:

AllMethodsChart, BarChart, LineChart, PieChart

public abstract class Chart
extends Object

This is the base class this library is for. It represents an abstract chart of some sort, weather it's a line chart or something entirely different. Classes are connected like this:

Since:

0.1.0

Author:

Stef Schulz

Constructor Summary

Constructors

Constructor and Description
Chart() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addRefreshListener(RefreshListener listener) Adds a refresh listener that is called whenever this Chart needs to be redrawn by the GUI.
Chart	backgroundColor(int newBackgroundColor) Sets the color as ARGB int, e.g.
Area	calculateGraphArea(double width, double height) Calculates the graph area by removing the ChartParts from the entire width and height.
int	getBackgroundColor() Returns the color as ARGB int, e.g.
Border	getBorder() Returns the border this chart has.
Title	getTitle() Returns the title this chart has.
void	paintOn(GraphicContext gc, PaintInstructions instructions) Paints the current content onto the graphic context.
void	removeRefreshListener(RefreshListener listener) Removes a refresh listener that was called whenever this Chart needed to be redrawn by the GUI.
void	setBackgroundColor(int backgroundColor) Sets the color as ARGB int, e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

Chart

public Chart()

Default constructor.

Method Detail

paintOn

public void paintOn(GraphicContext gc,
                    PaintInstructions instructions)

Paints the current content onto the graphic context. Checks the instructions for what to paint. The instructions contain the area in display coordinates, starting from the top left with 0|0 and ending bottom right with something like 800|600.

Parameters:

gc - graphic context; coordinates are relative to the screen

instructions - additional instructions like the area to paint on

calculateGraphArea

public Area calculateGraphArea(double width,
                               double height)

Calculates the graph area by removing the ChartParts from the entire width and height.

Parameters:

width - the entire width

height - the entire height

Returns:

the graph area

addRefreshListener

public void addRefreshListener(RefreshListener listener)

Adds a refresh listener that is called whenever this Chart needs to be redrawn by the GUI.

Parameters:

listener - a listener

removeRefreshListener

public void removeRefreshListener(RefreshListener listener)

Removes a refresh listener that was called whenever this Chart needed to be redrawn by the GUI. Does nothing if the listener was never added.

Parameters:

listener - a listener

getBorder

public Border getBorder()

Returns the border this chart has. The border is supposed to be around everything else like this:

Returns:

the border

getTitle

public Title getTitle()

Returns the title this chart has. The title is supposed to be on the top of everything like this:

Returns:

the border

getBackgroundColor

public int getBackgroundColor()

Returns the color as ARGB int, e.g. red is 0xFFFF0000 and blue is 0xFF0000FF.

Returns:

the color

backgroundColor

public Chart backgroundColor(int newBackgroundColor)

Sets the color as ARGB int, e.g. red is 0xFFFF0000 and blue is 0xFF0000FF.

Parameters:

newBackgroundColor - the color

Returns:

this instance

setBackgroundColor

public void setBackgroundColor(int backgroundColor)

Sets the color as ARGB int, e.g. red is 0xFFFF0000 and blue is 0xFF0000FF.

Parameters:

backgroundColor - the color