li.netcat.chart.util.tag
Class Tag

java.lang.Object
  li.netcat.chart.util.tag.Tag

public class Tag

extends java.lang.Object

Defines the properties of some sort of label that is used to inscribe parts. The following image shows a possible layout of a tag with some of its properties:

The direction is a unit vector that shows a possible but not obligatory displacement direction.

Author:

Arthur Marxer

Field Summary

float	directionX The x value of the direction unit vector.
float	directionY The y value of the direction unit vector.
float	tagX The x-coordinate of the tag point.
float	tagY The y-coordinate of the tag point.
float	targetX The x-coordinate of the target point.
float	targetY The y-coordinate of the target point.

Constructor Summary

Tag(DeviceString text, TextLook textLook, Pen pen, float targetX, float targetY, int top, int left, int bottom, int right)
Constructs a new tag with the given parameters.

Tag(DeviceString text, TextLook textLook, Pen pen, float targetX, float targetY, int top, int left, int bottom, int right, java.lang.Object perspective)
Constructs a new tag with the given parameters.

Method Summary

int	getBottom() Returns the bottom inset.
int	getLeft() Returns the left inset.
Pen	getPen() Returns the pen that is used to paint the line.
java.lang.Object	getPerspective() Returns the perspective position of this tag.
int	getRight() Returns the right inset.
DeviceString	getText() Returns the text of this tag.
TextLook	getTextLook() Returns the text look of this tag.
int	getTop() Returns the top inset.
void	setInsets(int top, int left, int bottom, int right) Sets the insets of the tag to the given values.
void	setPen(Pen pen) Sets the pen that is used to paint the line.
void	setPerspective(java.lang.Object perspective) Sets the perspective property to this tag.
void	setText(DeviceString text) Sets a new text to this tag.
void	setTextLook(TextLook look) Sets a new text look to this tag.

Methods inherited from class java.lang.Object

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

Field Detail

targetX

public float targetX

The x-coordinate of the target point.

targetY

public float targetY

The y-coordinate of the target point.

tagX

public float tagX

The x-coordinate of the tag point.

tagY

public float tagY

The y-coordinate of the tag point.

directionX

public float directionX

The x value of the direction unit vector.

directionY

public float directionY

The y value of the direction unit vector.

Constructor Detail

Tag

public Tag(DeviceString text,
           TextLook textLook,
           Pen pen,
           float targetX,
           float targetY,
           int top,
           int left,
           int bottom,
           int right)

Constructs a new tag with the given parameters. After this constructor, tag and target point are identical and the direction vector is set to (0, -1).

Parameters:

text - The text of this tag, not null.

textLook - The look of the text of this tag, not null.

pen - The pen that is used to paint the line, can be null.

targetX - The x coordiante of the target point.

targetY - The y coordiante of the target point.

top - The top inset.

left - The left inset.

bottom - The bottom inset.

right - The right inset.

Tag

public Tag(DeviceString text,
           TextLook textLook,
           Pen pen,
           float targetX,
           float targetY,
           int top,
           int left,
           int bottom,
           int right,
           java.lang.Object perspective)

Constructs a new tag with the given parameters. After this constructor, tag and target point are identical and the direction vector is set to (0, -1).

Parameters:

text - The text of this tag, not null.

textLook - The look of the text of this tag, not null.

pen - The pen that is used to paint the line, can be null.

targetX - The x coordiante of the target point.

targetY - The y coordiante of the target point.

top - The top inset.

left - The left inset.

bottom - The bottom inset.

right - The right inset.

perspective - The perspective position of the tag.

See Also:

PerspectivePart

Method Detail

getText

public DeviceString getText()

Returns the text of this tag.

Returns:

The text, never null.

setText

public void setText(DeviceString text)

Sets a new text to this tag.

Parameters:

text - The new text, not null.

getTextLook

public TextLook getTextLook()

Returns the text look of this tag.

Returns:

The text look, never null.

setTextLook

public void setTextLook(TextLook look)

Sets a new text look to this tag.

Parameters:

look - The new text look, not null.

getPen

public Pen getPen()

Returns the pen that is used to paint the line.

Returns:

The pen that is used to paint the line.

setPen

public void setPen(Pen pen)

Sets the pen that is used to paint the line.

Parameters:

pen - The pen that is used to paint the line.

getTop

public int getTop()

Returns the top inset.

Returns:

The top inset.

getLeft

public int getLeft()

Returns the left inset.

Returns:

The left inset.

getBottom

public int getBottom()

Returns the bottom inset.

Returns:

The bottom inset.

getRight

public int getRight()

Returns the right inset.

Returns:

The right inset.

setInsets

public void setInsets(int top,
                      int left,
                      int bottom,
                      int right)

Sets the insets of the tag to the given values.

Parameters:

top - The top inset.

left - The left inset.

bottom - The bottom inset.

right - The right inset.

getPerspective

public java.lang.Object getPerspective()

Returns the perspective position of this tag.

Returns:

The perspective position of this tag.

See Also:

PerspectivePart

setPerspective

public void setPerspective(java.lang.Object perspective)

Sets the perspective property to this tag.

Parameters:

perspective - The new perspective property.

See Also:

PerspectivePart