de.erichseifert.gral.plots.points

Class AbstractPointRenderer

java.lang.Object

de.erichseifert.gral.plots.points.AbstractPointRenderer

All Implemented Interfaces:

PointRenderer, java.io.Serializable

Direct Known Subclasses:

BoxPlot.BoxWhiskerRenderer, DefaultPointRenderer2D, PiePlot.PieSliceRenderer

public abstract class AbstractPointRenderer
extends java.lang.Object
implements PointRenderer, java.io.Serializable

Abstract class implementing functions for the administration of settings.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractPointRenderer() Creates a new AbstractPointRenderer object with default shape and color.

Method Summary

Modifier and Type	Method and Description
ColorMapper	getColor() Returns a mapping that is used to fill the point shapes.
ColorMapper	getErrorColor() Returns the mapping that is used to fill the error indicators.
int	getErrorColumnBottom() Returns the index of the column that contains the lower error value.
int	getErrorColumnTop() Returns the index of the column that contains the upper error value.
java.awt.Shape	getErrorShape() Returns the shape which is used to draw the error indicators.
java.awt.Stroke	getErrorStroke() Returns the stroke which is used to draw the error indicators.
java.awt.Shape	getShape() Returns the shape which is used to draw the point.
double	getValueAlignmentX() Returns the relative horizontal position of the value.
double	getValueAlignmentY() Returns the relative vertical position of the value.
ColorMapper	getValueColor() Returns the mapping that is used to fill the value.
int	getValueColumn() Returns the index of the column that contains the displayed values.
double	getValueDistance() Returns the current distance of values to the point.
java.awt.Font	getValueFont() Returns the font that is used to render the value.
java.text.Format	getValueFormat() Returns the format that is used to render the displayed data values.
Location	getValueLocation() Returns the current positioning of the data value relative to the data point.
double	getValueRotation() Returns the current rotation angle of the value.
boolean	isErrorVisible() Returns whether the error value is displayed.
boolean	isValueVisible() Returns whether the data value of a point is displayed or not.
void	setColor(ColorMapper color) Sets the mapping that will be used to fill the point shapes.
void	setColor(java.awt.Paint color) Sets the paint that will be used to fill the point shapes.
void	setErrorColor(ColorMapper color) Sets the mapping that will be used to fill the error indicators.
void	setErrorColor(java.awt.Paint color) Sets the paint that will be used to fill the error indicators.
void	setErrorColumnBottom(int columnIndex) Sets the index of the column that contains the lower error value.
void	setErrorColumnTop(int columnIndex) Sets the index of the column that contains the upper error value.
void	setErrorShape(java.awt.Shape shape) Sets the shape which will be used to draw the error indicators.
void	setErrorStroke(java.awt.Stroke stroke) Sets the stroke which will be used to draw the error indicators.
void	setErrorVisible(boolean errorVisible) Sets whether the error value will be displayed.
void	setShape(java.awt.Shape shape) Sets the shape which will be used to draw the point.
void	setValueAlignmentX(double alignmentX) Sets the relative horizontal position of the value.
void	setValueAlignmentY(double alignmentY) Sets the relative vertical position of the value.
void	setValueColor(ColorMapper color) Sets the mapping that will be used to fill the value.
void	setValueColor(java.awt.Paint color) Sets the paint that will be used to fill the value.
void	setValueColumn(int columnIndex) Sets the index of the column that contains the displayed values.
void	setValueDistance(double distance) Sets the distance of values to the point.
void	setValueFont(java.awt.Font font) Sets the font that will be used to render the value.
void	setValueFormat(java.text.Format format) Sets the format that will be used to render the displayed data values.
void	setValueLocation(Location location) Sets the positioning of the data value relative to the data point.
void	setValueRotation(double angle) Sets the rotation angle of the value.
void	setValueVisible(boolean valueVisible) Returns whether the data value of a point will be displayed or not.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.erichseifert.gral.plots.points.PointRenderer

getPoint, getPointShape, getValue

Constructor Detail

AbstractPointRenderer

public AbstractPointRenderer()

Creates a new AbstractPointRenderer object with default shape and color.

Method Detail

getShape

public java.awt.Shape getShape()

Description copied from interface: PointRenderer

Returns the shape which is used to draw the point.

Specified by:

getShape in interface PointRenderer

Returns:

Shape instance for the point.

setShape

public void setShape(java.awt.Shape shape)

Description copied from interface: PointRenderer

Sets the shape which will be used to draw the point.

Specified by:

setShape in interface PointRenderer

Parameters:

shape - Shape instance for the point.

getColor

public ColorMapper getColor()

Description copied from interface: PointRenderer

Returns a mapping that is used to fill the point shapes.

Specified by:

getColor in interface PointRenderer

Returns:

ColorMapper that is used to fill the point shapes.

setColor

public void setColor(ColorMapper color)

Description copied from interface: PointRenderer

Sets the mapping that will be used to fill the point shapes.

Specified by:

setColor in interface PointRenderer

Parameters:

color - ColorMapper instance to fill the point shapes.

setColor

public void setColor(java.awt.Paint color)

Description copied from interface: PointRenderer

Sets the paint that will be used to fill the point shapes.

Specified by:

setColor in interface PointRenderer

Parameters:

color - Paint instance to fill the point shapes.

isValueVisible

public boolean isValueVisible()

Description copied from interface: PointRenderer

Returns whether the data value of a point is displayed or not.

Specified by:

isValueVisible in interface PointRenderer

Returns:

true when the value is displayed, otherwise false.

setValueVisible

public void setValueVisible(boolean valueVisible)

Description copied from interface: PointRenderer

Returns whether the data value of a point will be displayed or not.

Specified by:

setValueVisible in interface PointRenderer

Parameters:

valueVisible - true if the value should be displayed, otherwise false.

getValueColumn

public int getValueColumn()

Description copied from interface: PointRenderer

Returns the index of the column that contains the displayed values.

Specified by:

getValueColumn in interface PointRenderer

Returns:

Index of the column that contains the displayed values.

setValueColumn

public void setValueColumn(int columnIndex)

Description copied from interface: PointRenderer

Sets the index of the column that contains the displayed values.

Specified by:

setValueColumn in interface PointRenderer

Parameters:

columnIndex - Index of the column that contains the displayed values.

getValueFormat

public java.text.Format getValueFormat()

Description copied from interface: PointRenderer

Returns the format that is used to render the displayed data values.

Specified by:

getValueFormat in interface PointRenderer

Returns:

Format instance that is used to render the displayed data values.

setValueFormat

public void setValueFormat(java.text.Format format)

Description copied from interface: PointRenderer

Sets the format that will be used to render the displayed data values.

Specified by:

setValueFormat in interface PointRenderer

Parameters:

format - Format instance that will be used to render the displayed data values.

getValueLocation

public Location getValueLocation()

Description copied from interface: PointRenderer

Returns the current positioning of the data value relative to the data point.

Specified by:

getValueLocation in interface PointRenderer

Returns:

Current positioning of the data value relative to the data point.

setValueLocation

public void setValueLocation(Location location)

Description copied from interface: PointRenderer

Sets the positioning of the data value relative to the data point.

Specified by:

setValueLocation in interface PointRenderer

Parameters:

location - Positioning of the data value relative to the data point.

getValueAlignmentX

public double getValueAlignmentX()

Description copied from interface: PointRenderer

Returns the relative horizontal position of the value. The position will be between 0 and 1.

Specified by:

getValueAlignmentX in interface PointRenderer

Returns:

Relative horizontal position of the value.

setValueAlignmentX

public void setValueAlignmentX(double alignmentX)

Description copied from interface: PointRenderer

Sets the relative horizontal position of the value. The position can be specified between 0 and 1.

Specified by:

setValueAlignmentX in interface PointRenderer

Parameters:

alignmentX - Relative horizontal position of the value.

getValueAlignmentY

public double getValueAlignmentY()

Description copied from interface: PointRenderer

Returns the relative vertical position of the value. The position will be between 0 and 1.

Specified by:

getValueAlignmentY in interface PointRenderer

Returns:

Relative vertical position of the value.

setValueAlignmentY

public void setValueAlignmentY(double alignmentY)

Description copied from interface: PointRenderer

Sets the relative vertical position of the value. The position can be specified between 0 and 1.

Specified by:

setValueAlignmentY in interface PointRenderer

Parameters:

alignmentY - Relative vertical position of the value.

getValueRotation

public double getValueRotation()

Description copied from interface: PointRenderer

Returns the current rotation angle of the value.

Specified by:

getValueRotation in interface PointRenderer

Returns:

Rotation angle in degrees.

setValueRotation

public void setValueRotation(double angle)

Description copied from interface: PointRenderer

Sets the rotation angle of the value.

Specified by:

setValueRotation in interface PointRenderer

Parameters:

angle - Rotation angle in degrees.

getValueDistance

public double getValueDistance()

Description copied from interface: PointRenderer

Returns the current distance of values to the point. The distance is specified relative to the font height.

Specified by:

getValueDistance in interface PointRenderer

Returns:

Distance relative to the font height.

setValueDistance

public void setValueDistance(double distance)

Description copied from interface: PointRenderer

Sets the distance of values to the point. The distance is specified relative to the font height.

Specified by:

setValueDistance in interface PointRenderer

Parameters:

distance - Distance relative to the font height.

getValueColor

public ColorMapper getValueColor()

Description copied from interface: PointRenderer

Returns the mapping that is used to fill the value.

Specified by:

getValueColor in interface PointRenderer

Returns:

ColorMapper instance that is used to fill the value.

setValueColor

public void setValueColor(ColorMapper color)

Description copied from interface: PointRenderer

Sets the mapping that will be used to fill the value.

Specified by:

setValueColor in interface PointRenderer

Parameters:

color - ColorMapper instance that will be used to fill the value.

setValueColor

public void setValueColor(java.awt.Paint color)

Description copied from interface: PointRenderer

Sets the paint that will be used to fill the value.

Specified by:

setValueColor in interface PointRenderer

Parameters:

color - Paint instance that will be used to fill the value.

getValueFont

public java.awt.Font getValueFont()

Description copied from interface: PointRenderer

Returns the font that is used to render the value.

Specified by:

getValueFont in interface PointRenderer

Returns:

Font that is used to render the value.

setValueFont

public void setValueFont(java.awt.Font font)

Description copied from interface: PointRenderer

Sets the font that will be used to render the value.

Specified by:

setValueFont in interface PointRenderer

Parameters:

font - Font that will be used to render the value.

isErrorVisible

public boolean isErrorVisible()

Description copied from interface: PointRenderer

Returns whether the error value is displayed.

Specified by:

isErrorVisible in interface PointRenderer

Returns:

true if the error value is displayed, otherwise false.

setErrorVisible

public void setErrorVisible(boolean errorVisible)

Description copied from interface: PointRenderer

Sets whether the error value will be displayed.

Specified by:

setErrorVisible in interface PointRenderer

Parameters:

errorVisible - true if the error value should be displayed, otherwise false.

getErrorColumnTop

public int getErrorColumnTop()

Description copied from interface: PointRenderer

Returns the index of the column that contains the upper error value.

Specified by:

getErrorColumnTop in interface PointRenderer

Returns:

Index of the column that contains the upper error value.

setErrorColumnTop

public void setErrorColumnTop(int columnIndex)

Description copied from interface: PointRenderer

Sets the index of the column that contains the upper error value.

Specified by:

setErrorColumnTop in interface PointRenderer

Parameters:

columnIndex - Index of the column that contains the upper error value.

getErrorColumnBottom

public int getErrorColumnBottom()

Description copied from interface: PointRenderer

Returns the index of the column that contains the lower error value.

Specified by:

getErrorColumnBottom in interface PointRenderer

Returns:

Index of the column that contains the lower error value.

setErrorColumnBottom

public void setErrorColumnBottom(int columnIndex)

Description copied from interface: PointRenderer

Sets the index of the column that contains the lower error value.

Specified by:

setErrorColumnBottom in interface PointRenderer

Parameters:

columnIndex - Index of the column that contains the lower error value.

getErrorColor

public ColorMapper getErrorColor()

Description copied from interface: PointRenderer

Returns the mapping that is used to fill the error indicators.

Specified by:

getErrorColor in interface PointRenderer

Returns:

ColorMapper instance that is used to fill the error indicators.

setErrorColor

public void setErrorColor(ColorMapper color)

Description copied from interface: PointRenderer

Sets the mapping that will be used to fill the error indicators.

Specified by:

setErrorColor in interface PointRenderer

Parameters:

color - ColorMapper instance that will be used to fill the error indicators.

setErrorColor

public void setErrorColor(java.awt.Paint color)

Description copied from interface: PointRenderer

Sets the paint that will be used to fill the error indicators.

Specified by:

setErrorColor in interface PointRenderer

Parameters:

color - Paint instance that will be used to fill the error indicators.

getErrorShape

public java.awt.Shape getErrorShape()

Description copied from interface: PointRenderer

Returns the shape which is used to draw the error indicators.

Specified by:

getErrorShape in interface PointRenderer

Returns:

Shape instance of the error indicators.

setErrorShape

public void setErrorShape(java.awt.Shape shape)

Description copied from interface: PointRenderer

Sets the shape which will be used to draw the error indicators.

Specified by:

setErrorShape in interface PointRenderer

Parameters:

shape - Shape instance for the error indicators.

getErrorStroke

public java.awt.Stroke getErrorStroke()

Description copied from interface: PointRenderer

Returns the stroke which is used to draw the error indicators.

Specified by:

getErrorStroke in interface PointRenderer

Returns:

Current stroke of the error indicators.

setErrorStroke

public void setErrorStroke(java.awt.Stroke stroke)

Description copied from interface: PointRenderer

Sets the stroke which will be used to draw the error indicators.

Specified by:

setErrorStroke in interface PointRenderer

Parameters:

stroke - Stroke of the error indicators.