li.netcat.chart.util
Class PolarGridPart

java.lang.Object
  li.netcat.chart.util.AbstractPart
      li.netcat.chart.util.GridPart
          li.netcat.chart.util.PolarGridPart

All Implemented Interfaces:

Part

public class PolarGridPart

extends GridPart

Represents a polar grid that looks for example like this:

It is possible to specify, what lines and marks should be painted. The tangential lines of the grid are also called "Rings" and the radial lines are also called "Spokes".

Author:

Arthur Marxer

Field Summary

Fields inherited from class li.netcat.chart.util.AbstractPart

BACKGROUND, FOREGROUND, PERSPECTIVE

Constructor Summary

PolarGridPart(PolarGraphPart polarGraphPart)
Constructs a new PolarGridPart using the given PolarGraphPart.

Method Summary

java.lang.Object	getInnerBorderPerspective() Returns the perspective position of the inner border.
Layout	getLayout(java.awt.Graphics g) Returns an instance of a layout that is able to report the bounds of this part and is able to paint this part.
java.lang.Object	getOuterBorderPerspective() Returns the perspective position of the outer border.
boolean	getPaintInnerBorder() Returns the paint inner border flag.
boolean	getPaintOuterBorder() Returns the paint outer border flag.
boolean	getPaintSpokes() Returns the paint spokes flag.
boolean	getPaintTangentialLines() Returns the paint tangential lines flag.
boolean	getPaintTangentialMarks() Returns the paint tangential marks flag.
PolarGraphPart	getPolarGraphPart() Returns the graph part that defines the dimensions and orientation of this grid.
int	getRingInterval() Returns the ring interval.
Pen	getRingPen() Returns the pen that is used to paint the rings.
PenBox	getRingPenBox() Returns the pen box that is used to paint the rings.
int	getSpokeInterval() Returns the spoke interval.
Pen	getSpokePen() Returns the pen that is used to paint the spokes.
PenBox	getSpokePenBox() Returns the pen box that is used to paint the spokes.
java.lang.Object	getSpokesPerspective() Returns the perspective position of the spokes.
java.lang.Object	getTangentialLinesPerspective() Returns the perspective position of the tangential lines.
java.lang.Object	getTangentialMarksPerspective() Returns the perspective position of the tangential marks.
void	setInnerBorderPerspective(java.lang.Object perspective) Sets the perspective position of the inner border.
void	setOuterBorderPerspective(java.lang.Object perspective) Sets the perspective position of the outer border.
void	setPaintInnerBorder(boolean flag) Sets the paint inner border flag.
void	setPaintOuterBorder(boolean flag) Sets the paint outer border flag.
void	setPaintSpokes(boolean flag) Sets the paint spokes flag.
void	setPaintTangentialLines(boolean flag) Sets the paint tangential lines flag.
void	setPaintTangentialMarks(boolean flag) Sets the paint tangential marks flag.
void	setPolarGraphPart(PolarGraphPart part) Sets the graph part that defines the dimensions and orientation of this grid.
void	setRingInterval(int interval) Sets the ring interval.
void	setRingPen(Pen pen) Sets the pen that is used to paint the rings.
void	setRingPenBox(PenBox penBox) Sets the pen box that is used to paint the rings.
void	setSpokeInterval(int interval) Sets the spoke interval.
void	setSpokePen(Pen pen) Sets the pen that is used to paint the spoke lines.
void	setSpokePenBox(PenBox penBox) Sets the pen box that is used to paint the spoke lines.
void	setSpokesPerspective(java.lang.Object perspective) Sets the perspective position of the spokes.
void	setTangentialLinesPerspective(java.lang.Object perspective) Sets the perspective position of the tangential lines.
void	setTangentialMarksPerspective(java.lang.Object perspective) Sets the perspective position of the tangential marks.

Methods inherited from class li.netcat.chart.util.GridPart

_getGridPen, _getMarkPen, _setGridPen, _setMarkPen, getBackgroundPen, getBackgroundPenAt, getBackgroundPenBox, getBorderPen, getDiscreteGridPen, getDiscreteGridPenAt, getDiscreteGridPenBox, getMarkLineLength, getNumericGridPen, getNumericGridPenAt, getNumericGridPenBox, getPaintBackground, setBackgroundPaint, setBackgroundPen, setBackgroundPenBox, setBorderPen, setDiscreteGridPen, setDiscreteGridPenBox, setMarkLineLength, setNumericGridPen, setNumericGridPenBox, setPaintBackground

Methods inherited from class li.netcat.chart.util.AbstractPart

getChart, getPerspective, invalidate, setChart, setPerspective

Methods inherited from class java.lang.Object

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

Constructor Detail

PolarGridPart

public PolarGridPart(PolarGraphPart polarGraphPart)

Constructs a new PolarGridPart using the given PolarGraphPart.

Parameters:

polarGraphPart - The relevant PolarGraphPart or null if no part is currently available. In that case, this grid part will not be visible.

Method Detail

getPolarGraphPart

public PolarGraphPart getPolarGraphPart()

Returns the graph part that defines the dimensions and orientation of this grid.

Returns:

The graph part that defines the dimensions and orientation of this grid.

setPolarGraphPart

public void setPolarGraphPart(PolarGraphPart part)

Sets the graph part that defines the dimensions and orientation of this grid.

Parameters:

part - The relevant PolarGraphPart or null if no part is currently available. In that case, this grid part will not be visible.

getPaintOuterBorder

public boolean getPaintOuterBorder()

Returns the paint outer border flag.

Returns:

true if the outer border gets painted.

setPaintOuterBorder

public void setPaintOuterBorder(boolean flag)

Sets the paint outer border flag.

Parameters:

flag - Specify true to paint the outer border.

getPaintInnerBorder

public boolean getPaintInnerBorder()

Returns the paint inner border flag.

setPaintInnerBorder

public void setPaintInnerBorder(boolean flag)

Sets the paint inner border flag.

Parameters:

flag - Specify true to paint the inner border.

getOuterBorderPerspective

public java.lang.Object getOuterBorderPerspective()

Returns the perspective position of the outer border.

Returns:

The perspective position of the outer border.

See Also:

PerspectivePart

setOuterBorderPerspective

public void setOuterBorderPerspective(java.lang.Object perspective)

Sets the perspective position of the outer border.

Parameters:

perspective - The perspective position of the outer border.

See Also:

PerspectivePart

getInnerBorderPerspective

public java.lang.Object getInnerBorderPerspective()

Returns the perspective position of the inner border.

Returns:

The perspective position of the inner border.

See Also:

PerspectivePart

setInnerBorderPerspective

public void setInnerBorderPerspective(java.lang.Object perspective)

Sets the perspective position of the inner border.

Parameters:

perspective - The perspective position of the inner border.

See Also:

PerspectivePart

getPaintSpokes

public boolean getPaintSpokes()

Returns the paint spokes flag.

setPaintSpokes

public void setPaintSpokes(boolean flag)

Sets the paint spokes flag.

Parameters:

flag - Specify true to paint the spokes.

getSpokePen

public Pen getSpokePen()

Returns the pen that is used to paint the spokes.

Returns:

The pen that paints the spoke lines, might be null.

setSpokePen

public void setSpokePen(Pen pen)

Sets the pen that is used to paint the spoke lines.

Parameters:

pen - The pen that paints the spoke lines, might be null.

getSpokePenBox

public PenBox getSpokePenBox()

Returns the pen box that is used to paint the spokes.

Returns:

The pen box that is used to paint the spoke lines, might be null.

setSpokePenBox

public void setSpokePenBox(PenBox penBox)

Sets the pen box that is used to paint the spoke lines.

Parameters:

penBox - The pen that is used to paint the spoke lines, might be null.

getSpokesPerspective

public java.lang.Object getSpokesPerspective()

Returns the perspective position of the spokes.

Returns:

The perspective position of the spokes.

See Also:

PerspectivePart

setSpokesPerspective

public void setSpokesPerspective(java.lang.Object perspective)

Sets the perspective position of the spokes.

Parameters:

perspective - The perspective position of the spokes.

See Also:

PerspectivePart

getRingPen

public Pen getRingPen()

Returns the pen that is used to paint the rings.

Returns:

The pen that paints the ring lines, might be null.

setRingPen

public void setRingPen(Pen pen)

Sets the pen that is used to paint the rings.

Parameters:

pen - The pen that paints the ring lines, might be null.

getRingPenBox

public PenBox getRingPenBox()

Returns the pen box that is used to paint the rings.

Returns:

The pen box used to paint the ring lines, might be null.

setRingPenBox

public void setRingPenBox(PenBox penBox)

Sets the pen box that is used to paint the rings.

Parameters:

penBox - The pen that is used to paint the ring lines, might be null.

getPaintTangentialMarks

public boolean getPaintTangentialMarks()

Returns the paint tangential marks flag.

setPaintTangentialMarks

public void setPaintTangentialMarks(boolean flag)

Sets the paint tangential marks flag.

Parameters:

flag - Specify true to paint the tangential marks.

getTangentialMarksPerspective

public java.lang.Object getTangentialMarksPerspective()

Returns the perspective position of the tangential marks.

Returns:

The perspective position of the tangential marks.

See Also:

PerspectivePart

setTangentialMarksPerspective

public void setTangentialMarksPerspective(java.lang.Object perspective)

Sets the perspective position of the tangential marks.

Parameters:

perspective - The perspective position of the tangential marks.

See Also:

PerspectivePart

getPaintTangentialLines

public boolean getPaintTangentialLines()

Returns the paint tangential lines flag.

setPaintTangentialLines

public void setPaintTangentialLines(boolean flag)

Sets the paint tangential lines flag.

Parameters:

flag - Specify true to paint the tangential lines.

getTangentialLinesPerspective

public java.lang.Object getTangentialLinesPerspective()

Returns the perspective position of the tangential lines.

Returns:

The perspective position of the tangential lines.

See Also:

PerspectivePart

setTangentialLinesPerspective

public void setTangentialLinesPerspective(java.lang.Object perspective)

Sets the perspective position of the tangential lines.

Parameters:

perspective - The perspective position of the tangential lines.

See Also:

PerspectivePart

getSpokeInterval

public int getSpokeInterval()

Returns the spoke interval. If this value is set e.g. to 3, only every third spoke gets painted. The default value is one.

Returns:

The spoke interval.

setSpokeInterval

public void setSpokeInterval(int interval)

Sets the spoke interval. If this value is set e.g. to 3, only every third spoke gets painted. The default value is one.

Parameters:

interval - The new interval, must be >=1.

getRingInterval

public int getRingInterval()

Returns the ring interval. If this value is set e.g. to 3, only every third ring (tangential line or circle or mark) gets painted. The default value is one.

Returns:

The ring interval.

setRingInterval

public void setRingInterval(int interval)

Sets the ring interval. If this value is set e.g. to 3, only every third ring (tangential line or circle or mark) gets painted. The default value is one.

Parameters:

interval - The new interval, must be >=1.

getLayout

public Layout getLayout(java.awt.Graphics g)

Description copied from interface: Part

Returns an instance of a layout that is able to report the bounds of this part and is able to paint this part.

Parameters:

g - The relevant graphics object.

Returns:

A layout that is able to report the bounds of this part and is able to paint this part. This method may also return null.