de.slothsoft.charts.common

Class Border

java.lang.Object

de.slothsoft.charts.common.Border

All Implemented Interfaces:

ChartPart, Drawable

public class Border
extends Object
implements ChartPart

A border on a Chart. On default it's only empty space and not visible.

Since:

0.1.0

Author:

Stef Schulz

Constructor Summary

Constructors

Constructor and Description
Border()

Method Summary

Modifier and Type	Method and Description
void	addRefreshListener(RefreshListener listener) Adds a refresh listener that is called whenever this Drawable needs to be redrawn by the GUI.
int	getSpaceOnBottom() Return the border size on the bottom.
int	getSpaceOnLeft() Return the border size on the left.
int	getSpaceOnRight() Return the border size on the right.
int	getSpaceOnTop() Return the border size on the top.
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 Drawable needed to be redrawn by the GUI.
void	setSpace(int space) Sets the border size in all four directions.
void	setSpaceOnBottom(int spaceOnBottom) Sets the border size on the bottom.
void	setSpaceOnLeft(int spaceOnLeft) Sets the border size on the left.
void	setSpaceOnRight(int spaceOnRight) Sets the border size on the right.
void	setSpaceOnTop(int spaceOnTop) Sets the border size on the top.
Area	snipNecessarySpace(Area existingArea) This method removes space from the existing area to make room for this part.
Border	space(int newSpace) Sets the border size in all four directions.
Border	spaceOnBottom(int newSpaceOnBottom) Sets the border size on the bottom.
Border	spaceOnLeft(int newSpaceOnLeft) Sets the border size on the left.
Border	spaceOnRight(int newSpaceOnRight) Sets the border size on the right.
Border	spaceOnTop(int newSpaceOnTop) Sets the border size on the top.

Methods inherited from class java.lang.Object

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

Constructor Detail

Border

public Border()

Method Detail

paintOn

public void paintOn(GraphicContext gc,
                    PaintInstructions instructions)

Description copied from interface: ChartPart

Paints the current content onto the graphic context. Checks the instructions for what to paint. Coordinates are starting from the top left with 0|0 and ending bottom right with something like 800|600.

Specified by:

paintOn in interface ChartPart

Specified by:

paintOn in interface Drawable

Parameters:

gc - graphic context; coordinates are relative to the Chart

instructions - additional instructions like the area to paint on

snipNecessarySpace

public Area snipNecessarySpace(Area existingArea)

Description copied from interface: ChartPart

This method removes space from the existing area to make room for this part. E.g. a part on the left of the graph would increase the x and decrease the width.

Specified by:

snipNecessarySpace in interface ChartPart

Parameters:

existingArea - the area this part could use

Returns:

the area for the next parts

addRefreshListener

public void addRefreshListener(RefreshListener listener)

Description copied from interface: Drawable

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

Specified by:

addRefreshListener in interface Drawable

Parameters:

listener - a listener

removeRefreshListener

public void removeRefreshListener(RefreshListener listener)

Description copied from interface: Drawable

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

Specified by:

removeRefreshListener in interface Drawable

Parameters:

listener - a listener

space

public Border space(int newSpace)

Sets the border size in all four directions.

Parameters:

newSpace - the space

Returns:

this instance

setSpace

public void setSpace(int space)

Sets the border size in all four directions.

Parameters:

space - the space

getSpaceOnBottom

public int getSpaceOnBottom()

Return the border size on the bottom.

Returns:

the space

spaceOnBottom

public Border spaceOnBottom(int newSpaceOnBottom)

Sets the border size on the bottom.

Parameters:

newSpaceOnBottom - the space

Returns:

this instance

setSpaceOnBottom

public void setSpaceOnBottom(int spaceOnBottom)

Sets the border size on the bottom.

Parameters:

spaceOnBottom - the space

getSpaceOnLeft

public int getSpaceOnLeft()

Return the border size on the left.

Returns:

the space

spaceOnLeft

public Border spaceOnLeft(int newSpaceOnLeft)

Sets the border size on the left.

Parameters:

newSpaceOnLeft - the space

Returns:

this instance

setSpaceOnLeft

public void setSpaceOnLeft(int spaceOnLeft)

Sets the border size on the left.

Parameters:

spaceOnLeft - the space

getSpaceOnRight

public int getSpaceOnRight()

Return the border size on the right.

Returns:

the space

spaceOnRight

public Border spaceOnRight(int newSpaceOnRight)

Sets the border size on the right.

Parameters:

newSpaceOnRight - the space

Returns:

this instance

setSpaceOnRight

public void setSpaceOnRight(int spaceOnRight)

Sets the border size on the right.

Parameters:

spaceOnRight - the space

getSpaceOnTop

public int getSpaceOnTop()

Return the border size on the top.

Returns:

the space

spaceOnTop

public Border spaceOnTop(int newSpaceOnTop)

Sets the border size on the top.

Parameters:

newSpaceOnTop - the space

Returns:

this instance

setSpaceOnTop

public void setSpaceOnTop(int spaceOnTop)

Sets the border size on the top.

Parameters:

spaceOnTop - the space