li.netcat.chart.util
Class InscribePart

java.lang.Object
  li.netcat.chart.util.AbstractPart
      li.netcat.chart.util.TextPart
          li.netcat.chart.util.TagPart
              li.netcat.chart.util.InscribePart

All Implemented Interfaces:

Part

Direct Known Subclasses:

CartesianInscribePart, DirectInscribePart, PolarInscribePart

public abstract class InscribePart

extends TagPart

Abstract super class of all parts that inscribe the values of a chart. This part uses the tag concept and is therefore very flexible in its strategy and layout. For more details, see the super class TagPart.

The position of the target point is derived from the value location of each data cell. It can be influenced by a relative and an absolute positioning.

Author:

Arthur Marxer

Field Summary

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

BACKGROUND, FOREGROUND, PERSPECTIVE

Constructor Summary

InscribePart()
Constructs and initializes a new InscribePart.

Method Summary

float	getCrosswisePosition() Returns the crosswise position of the target point. 0.0f refers to the "left" border of the value, 1.0f to its "right".
float	getCrosswiseShift() Returns the crosswise shifting of the target point in pixel.
GraphPart	getGraphPart() Returns the graph part that gets inscribed by this part.
float	getLengthwisePosition() Returns the lengthwise position of the target point. 1.0f refers to the lead of the value location, 0.0f to its tail.
float	getLengthwiseShift() Returns the lengthwise shifting of the target point in pixel.
Tag[]	getTags(java.awt.Graphics g) Subclasses must implement this method to report the list of tags that must be layouted.
void	setGraphPart(GraphPart graphPart) Sets the graph part that gets inscribed by this part.
void	setTargetPosition(float lengthwisePosition, float lengthwiseShift, float crosswisePosition, float crosswiseShift) Sets the positions of the target points.

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

createTag, createTag, createTag, getAdditionalLineLength, getBottom, getLayout, getLeft, getLinePenBox, getPen, getRight, getTagConstraints, getTagManager, getTextPenBox, getTop, setAdditionalLineLength, setInsets, setLinePenBox, setPen, setTagManager, setTextPenBox

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

getTextLook, setTextLook

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

InscribePart

public InscribePart()

Constructs and initializes a new InscribePart.

Method Detail

getGraphPart

public GraphPart getGraphPart()

Returns the graph part that gets inscribed by this part.

Returns:

The graph part that gets inscribed by this part, might be null.

setGraphPart

public void setGraphPart(GraphPart graphPart)

Sets the graph part that gets inscribed by this part.

Parameters:

graphPart - the graph part gets inscribed by this part or null.

getLengthwisePosition

public float getLengthwisePosition()

Returns the lengthwise position of the target point. 1.0f refers to the lead of the value location, 0.0f to its tail. Other values are also possible.

Returns:

The lengthwise position of the target point.

getLengthwiseShift

public float getLengthwiseShift()

Returns the lengthwise shifting of the target point in pixel.

Returns:

The lengthwise shifting of the target point in pixel.

getCrosswisePosition

public float getCrosswisePosition()

Returns the crosswise position of the target point. 0.0f refers to the "left" border of the value, 1.0f to its "right". Lead and trail lie at a crosswise position of 0.5f.

Returns:

The crosswise position of the target point.

getCrosswiseShift

public float getCrosswiseShift()

Returns the crosswise shifting of the target point in pixel.

Returns:

The crosswise shifting of the target point in pixel.

setTargetPosition

public void setTargetPosition(float lengthwisePosition,
                              float lengthwiseShift,
                              float crosswisePosition,
                              float crosswiseShift)

Sets the positions of the target points.

Parameters:

lengthwisePosition - The lengthwise position of the target point. 1.0f refers to the lead of the value location, 0.0f to its tail. Other values are also possible.

lengthwiseShift - The shift in lengthwise direction in pixel.

crosswisePosition - The crosswise position of the target point. 0.0f refers to the "left" border of the value, 1.0f to its "right". Lead and trail lie at the crosswise position of 0.5f.

getTags

public Tag[] getTags(java.awt.Graphics g)

Description copied from class: TagPart

Subclasses must implement this method to report the list of tags that must be layouted.

Specified by:

getTags in class TagPart

Parameters:

g - The relevant graphics object.

Returns:

An array of tags that must be layouted, can also be empty or null, but must not contain null entries.