jhplot
Class HLabel

java.lang.Object
  extended by jhplot.HLabel

public class HLabel
extends java.lang.Object

Create an interactive Label in the USER or NDC coordinates. The label can be defined in the NDC (normilized coordinate system) or the user coordinate. Onle one line can be shown. Use HMline class to show several lines of the text For more labels look at the shape package


Constructor Summary
HLabel(java.lang.String s)
          Make a label with default attributes
HLabel(java.lang.String s, double x, double y)
          Make a label with specific coordinated in the data system
HLabel(java.lang.String s, double x, double y, java.lang.String howToSet)
          Make a label with specific coordinates.
HLabel(java.lang.String s, java.awt.Font f)
          Make a label (color- black)
HLabel(java.lang.String s, java.awt.Font f, java.awt.Color c)
          Make label
 
Method Summary
 java.awt.Color getColor()
           
 java.awt.Font getFont()
          Get the font
 jplot.GraphLabel getGraphLabel()
          Get a label with default attributes
 int getPositionCoordinate()
          Is the position set?
 double getRotation()
          Returns the rotation angle.
 java.lang.String getText()
           
 double getX()
          Returns the X position of the text.
 double getY()
          Returns the Y position of the text.
 void seLocation(double x, double y)
          Sets the location of this label in data coordinates.
 void setColor(java.awt.Color c)
          Sets the color to a specific value
 void setFont(java.awt.Font f)
          Sets the font to a specific value
 void setRotation(double r)
          Sets the rotation angle.
 void setText(java.lang.String s)
          Sets the text of the label to something new.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HLabel

public HLabel(java.lang.String s,
              java.awt.Font f,
              java.awt.Color c)
Make label

Parameters:
s - Text
f - Font
c - Color

HLabel

public HLabel(java.lang.String s,
              java.awt.Font f)
Make a label (color- black)

Parameters:
s - Text
f - Font

HLabel

public HLabel(java.lang.String s)
Make a label with default attributes

Parameters:
s - text

HLabel

public HLabel(java.lang.String s,
              double x,
              double y)
Make a label with specific coordinated in the data system

Parameters:
s - Text
x - Position in X
y - Position in Y

HLabel

public HLabel(java.lang.String s,
              double x,
              double y,
              java.lang.String howToSet)
Make a label with specific coordinates.

Parameters:
s - Text
x - position in X
y - position in Y
howToSet - set it to "NDC" for normilized coordinates (in the range 0-1). This is a data independent position set it to "USER" for the user coordinates
Method Detail

setText

public void setText(java.lang.String s)
Sets the text of the label to something new.

Parameters:
s - new text for the label

getText

public java.lang.String getText()
Returns:
the current text of the label

setColor

public void setColor(java.awt.Color c)
Sets the color to a specific value

Parameters:
c - color used to draw the label

getColor

public java.awt.Color getColor()
Returns:
the color used to draw the label

setFont

public void setFont(java.awt.Font f)
Sets the font to a specific value

Parameters:
f - font used to draw the label

getFont

public java.awt.Font getFont()
Get the font

Returns:
the font used to draw the label

setRotation

public void setRotation(double r)
Sets the rotation angle. Although all kind of angles (in PI-units) are allowed, internally we only use the interval 0-2pi hence we take care of all other cases.

Parameters:
r - angle for this label

getRotation

public double getRotation()
Returns the rotation angle.

Returns:
angle for this label

seLocation

public void seLocation(double x,
                       double y)
Sets the location of this label in data coordinates. Ones set this way, you cannot plot the label, it must first define the location in pixel-coordinates (setLocation(x,y));

Parameters:
x - x-position of the lower-left corner of the text
y - y-position of the lower-left corner of the text

getPositionCoordinate

public int getPositionCoordinate()
Is the position set?

Returns:
0 if location is not defined 1 if the position is defined in the NDC system 2 if the location is definded in the user coordinates

getX

public double getX()
Returns the X position of the text.

Returns:
the x-position of the text

getY

public double getY()
Returns the Y position of the text.

Returns:
the y-position of the text

getGraphLabel

public jplot.GraphLabel getGraphLabel()
Get a label with default attributes

Returns:
get GraphLabel


jHepWork 1.1 (C) Chekanov