GraphLabel

java.lang.Object
- jplot.GraphLabel

All Implemented Interfaces:

Serializable
```
public class GraphLabel
extends Object
implements Serializable
```
This class defines a label in terms of the actual text, font, color and position but also stuff like rotation, whether to hide or show etc. Some special treatment for standard X, Y labels and a title. Random labels are considered to be of type OTHER, which places them, by default, in the lower-left corner of the graph. Extends Rectangle, since a label has a rectangular bounding box, used to select, drag and drop the label. Note that the bounding box is defined by the upper-left corner, width (to the right) and height (directed towards the bottom).

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CHECK`
`static int`	`DATA`
`static int`	`KEY`
`static int`	`OTHER`
`static int`	`PIPER_X1`
`static int`	`PIPER_X2`
`static int`	`PIPER_Y1`
`static int`	`PIPER_Y2`
`static int`	`PIPER_Y3`
`static int`	`PIPER_Y4`
`static int`	`STATBOX`
`static int`	`TITLE`
`static int`	`UNKNOWN`
`static int`	`XLABEL`
`static int`	`YLABEL`

Constructor Summary

Constructors
Constructor and Description
`GraphLabel()` Constructor, does nothing but initializing.
`GraphLabel(GraphLabel gl)` Constructor, builds the class with another graph label.
`GraphLabel(int t)` Constructor, sets the ID of the label but no text.
`GraphLabel(int t, Font f, Color c)` Constructor, sets the text of the label.
`GraphLabel(int t, String s)` Constructor, sets the text of the label.
`GraphLabel(int t, String s, Font f, Color c)` Constructor, sets the text of the label.
`GraphLabel(String s)` Constructor, sets the text of the label.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(double x, double y)` Checks whether x,y falls within the bounding box of the current text.
`boolean`	`contains(double x, double y, float scale)`
`void`	`copy(GraphLabel gl)` Constructor, builds the class with another graph label.
`boolean`	`equals(int type)` returns true if the current label corresponds to one of the pre-defined label types (X-label, Y-label etc).
`boolean`	`equals(String name)` returns true if the current label corresponds to one of the pre-defined label types (X-label, Y-label etc).
`AttributedCharacterIterator`	`getCharIterator()` Returns an attributedCharacterIterator instance of the current text.
`Color`	`getColor()`
`File`	`getFile()`
`Font`	`getFont()` Sets the font to a specific value
`double`	`getHeight()` Returns the height of the bounding box of the label
`int`	`getID()`
`Color`	`getKeyColor()`
`float`	`getKeyLineWidth()`
`float`	`getKeySize()`
`float`	`getKeySpace()`
`int`	`getKeyType()`
`int`	`getMultiLines()` Get the multi text of the label
`String[]`	`getMultiText()` Get the multi text of the label
`double`	`getRotation()` Returns the rotation angle.
`void`	`getSettings(XMLWrite xw)` Returns the settings of the current label in a XML instance.
`String`	`getText()`
`double`	`getTextDescent()` Returns the text descent
`double`	`getTextHeight()` Returns the height of the text of the label
`double`	`getTextWidth()` Returns the width of the text of the label
`double`	`getWidth()` Returns the width of the bounding box of the label
`double`	`getX()` Returns the X position of the bounding box.
`double`	`getXPos()` Returns the X position of the text.
`double`	`getY()` Returns the Y position of the bounding box.
`double`	`getYPos()` Returns the Y position of the text.
`boolean`	`hide()`
`void`	`hide(boolean h)` sets the hide attribute of this label
`boolean`	`isActive()`
`void`	`setActive(boolean b)`
`void`	`setColor(Color c)` Sets the color to a specific value
`void`	`setDataLocation(double x, double y)` Sets the location of this label in data coordinates.
`void`	`setDataRotation(double r)` Sets the rotation angle.
`void`	`setFile(File f)` Sets the file to which the label belongs.
`void`	`setFont(Font f)` Sets the font to a specific value
`void`	`setID(int type)` Sets the current identity of the label to some specific value The idientity must be an int and, in principle, something predefined such as GraphLabel.XLABEL).
`void`	`setKey(int key_type, float key_size, Color key_color)` Sets a key
`void`	`setKeyLineWidth(float key_line_width)` Sets a key line width
`void`	`setKeySpace(float key_space)` Sets a space between the key and the text describing the key
`void`	`setLocation(double x, double y)` This function sets the text location of the label text itself, slightly different from the x,y position of the box.
`void`	`setRotation(double r)` Sets the rotation angle.
`void`	`setSize(double w, double h)` Sets the size of the bounding box:
`void`	`setSpace()` add a space
`void`	`setText(String s)` Sets the text of the label to something new.
`void`	`setText(String[] s)` Sets the multi text of the label to something new.
`void`	`setTextSize(double w, double h)` Sets the size of the text-label:
`void`	`setUseDataPosition(boolean b)` Allows the user to used the current x- and y-positions using the data coordinates, will use default positions otherwise
`void`	`setUsePosition(boolean b)` Allows the user to used the current x- and y-positions, will use default positions otherwise.
`String`	`toString()`
`void`	`updateSettings(XMLRead xr)` Update the current label with the settings.
`boolean`	`useDataPosition()`
`boolean`	`usePosition()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNKNOWN
```
public static final int UNKNOWN
```
    See Also:
    
    Constant Field Values
  - XLABEL
```
public static final int XLABEL
```
    See Also:
    
    Constant Field Values
  - YLABEL
```
public static final int YLABEL
```
    See Also:
    
    Constant Field Values
  - TITLE
```
public static final int TITLE
```
    See Also:
    
    Constant Field Values
  - PIPER_X1
```
public static final int PIPER_X1
```
    See Also:
    
    Constant Field Values
  - PIPER_X2
```
public static final int PIPER_X2
```
    See Also:
    
    Constant Field Values
  - PIPER_Y1
```
public static final int PIPER_Y1
```
    See Also:
    
    Constant Field Values
  - PIPER_Y2
```
public static final int PIPER_Y2
```
    See Also:
    
    Constant Field Values
  - PIPER_Y3
```
public static final int PIPER_Y3
```
    See Also:
    
    Constant Field Values
  - PIPER_Y4
```
public static final int PIPER_Y4
```
    See Also:
    
    Constant Field Values
  - DATA
```
public static final int DATA
```
    See Also:
    
    Constant Field Values
  - OTHER
```
public static final int OTHER
```
    See Also:
    
    Constant Field Values
  - CHECK
```
public static final int CHECK
```
    See Also:
    
    Constant Field Values
  - STATBOX
```
public static final int STATBOX
```
    See Also:
    
    Constant Field Values
  - KEY
```
public static final int KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GraphLabel
```
public GraphLabel(int t,
                  String s,
                  Font f,
                  Color c)
```
    Constructor, sets the text of the label.
    
    Parameters:
    
    t - type of this label
    
    s - text of the label
    
    f - font of the label
    
    c - text color of the label
  - GraphLabel
```
public GraphLabel(int t,
                  Font f,
                  Color c)
```
    Constructor, sets the text of the label.
    
    Parameters:
    
    t - type of this label
    
    f - font of the label
    
    c - text color of the label
  - GraphLabel
```
public GraphLabel(int t,
                  String s)
```
    Constructor, sets the text of the label.
    
    Parameters:
    
    s - new text of the label
  - GraphLabel
```
public GraphLabel(String s)
```
    Constructor, sets the text of the label.
    
    Parameters:
    
    s - new text of the label
  - GraphLabel
```
public GraphLabel(int t)
```
    Constructor, sets the ID of the label but no text.
    
    Parameters:
    
    t - ID of the label
  - GraphLabel
```
public GraphLabel()
```
    Constructor, does nothing but initializing.
  - GraphLabel
```
public GraphLabel(GraphLabel gl)
```
    Constructor, builds the class with another graph label.
- Method Detail
  - setKey
```
public void setKey(int key_type,
                   float key_size,
                   Color key_color)
```
    Sets a key
    
    Parameters:
    
    key_type - type of the key. 0 means a box
    
    key_size - size (i.e. length) a key in terms of character width
    
    key_color - color of the key
  - setKeyLineWidth
```
public void setKeyLineWidth(float key_line_width)
```
    Sets a key line width
    
    Parameters:
    
    key_line_width - line width to draw the key
  - getKeyColor
```
public Color getKeyColor()
```
  - getKeySize
```
public float getKeySize()
```
  - getKeyLineWidth
```
public float getKeyLineWidth()
```
  - getKeyType
```
public int getKeyType()
```
  - getKeySpace
```
public float getKeySpace()
```
  - setKeySpace
```
public void setKeySpace(float key_space)
```
    Sets a space between the key and the text describing the key
    
    Parameters:
    
    key_space - key space in terms of character width
  - copy
```
public void copy(GraphLabel gl)
```
    Constructor, builds the class with another graph label.
  - setSpace
```
public void setSpace()
```
    add a space
    
    Parameters:
    
    s - new text for the label
  - setText
```
public void setText(String s)
```
    Sets the text of the label to something new.
    
    Parameters:
    
    s - new text for the label
  - setText
```
public void setText(String[] s)
```
    Sets the multi text of the label to something new.
    
    Parameters:
    
    s - [] new text for the label
  - getMultiText
```
public String[] getMultiText()
```
    Get the multi text of the label
  - getMultiLines
```
public int getMultiLines()
```
    Get the multi text of the label
  - getText
```
public String getText()
```
    Returns:
    
    the current text of the label
  - getCharIterator
```
public AttributedCharacterIterator getCharIterator()
```
    Returns an attributedCharacterIterator instance of the current text.
    
    Returns:
    
    an attributedCharacterIterator instance of the current text
  - setColor
```
public void setColor(Color c)
```
    Sets the color to a specific value
    
    Parameters:
    
    c - color used to draw the label
  - getColor
```
public Color getColor()
```
    Returns:
    
    the color used to draw the label
  - setFont
```
public void setFont(Font f)
```
    Sets the font to a specific value
    
    Parameters:
    
    f - font used to draw the label
  - getFont
```
public Font getFont()
```
    Sets the font to a specific value
    
    Returns:
    
    the font used to draw the label
  - setActive
```
public void setActive(boolean b)
```
    Parameters:
    
    b - true if the user starts to draw the label
  - isActive
```
public boolean isActive()
```
    Returns:
    
    true if the label is actually being drawn by the mouse
  - setUsePosition
```
public void setUsePosition(boolean b)
```
    Allows the user to used the current x- and y-positions, will use default positions otherwise. This uses positions in picxel coordinates
    
    Parameters:
    
    b - true if the positions should be used
  - setUseDataPosition
```
public void setUseDataPosition(boolean b)
```
    Allows the user to used the current x- and y-positions using the data coordinates, will use default positions otherwise
    
    Parameters:
    
    b - true if the positions should be used
  - usePosition
```
public boolean usePosition()
```
    Returns:
    
    true if the positions should be used
  - useDataPosition
```
public boolean useDataPosition()
```
    Returns:
    
    true if the data positions should be used
  - hide
```
public boolean hide()
```
    Returns:
    
    true if we should hide this label (do not show)
  - hide
```
public void hide(boolean h)
```
    sets the hide attribute of this label
    
    Parameters:
    
    h - flag, true if the label should'nt show
  - equals
```
public boolean equals(int type)
```
    returns true if the current label corresponds to one of the pre-defined label types (X-label, Y-label etc).
    
    Parameters:
    
    type - type to compare with (must be an int)
    
    Returns:
    
    true if 'type' corresponds to the current 'whoAmI'
  - equals
```
public boolean equals(String name)
```
    returns true if the current label corresponds to one of the pre-defined label types (X-label, Y-label etc).
    
    Parameters:
    
    name - name to compare with (must be a string)
    
    Returns:
    
    true if 'name' corresponds to the current label text
  - setID
```
public void setID(int type)
```
    Sets the current identity of the label to some specific value The idientity must be an int and, in principle, something predefined such as GraphLabel.XLABEL).
    
    Parameters:
    
    type - type of the current label
  - getID
```
public int getID()
```
    Returns:
    
    the current identity of the label to some specific value.
  - setDataRotation
```
public void setDataRotation(double r)
```
    Sets the rotation angle.
    
    Parameters:
    
    r - angle for this 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
  - setLocation
```
public void setLocation(double x,
                        double y)
```
    This function sets the text location of the label text itself, slightly different from the x,y position of the box. Optimize this function since it is used for drag'n drop.
    
    Parameters:
    
    x - x-position of the lower-left corner of the text
    
    y - y-position of the lower-left corner of the text
  - setDataLocation
```
public void setDataLocation(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
  - getXPos
```
public double getXPos()
```
    Returns the X position of the text.
    
    Returns:
    
    the x-position of the text
  - getYPos
```
public double getYPos()
```
    Returns the Y position of the text.
    
    Returns:
    
    the y-position of the text
  - getX
```
public double getX()
```
    Returns the X position of the bounding box.
    
    Returns:
    
    the x-position of the bounding box
  - getY
```
public double getY()
```
    Returns the Y position of the bounding box.
    
    Returns:
    
    the y-position of the bounding box
  - setSize
```
public void setSize(double w,
                    double h)
```
    Sets the size of the bounding box:
    
    Parameters:
    
    w - width of the bb
    
    h - height of the bb
  - setTextSize
```
public void setTextSize(double w,
                        double h)
```
    Sets the size of the text-label:
    
    Parameters:
    
    w - width of the label
    
    h - height of the label
  - getWidth
```
public double getWidth()
```
    Returns the width of the bounding box of the label
    
    Returns:
    
    the width of the bounding box
  - getHeight
```
public double getHeight()
```
    Returns the height of the bounding box of the label
    
    Returns:
    
    the height of the bounding box
  - getTextWidth
```
public double getTextWidth()
```
    Returns the width of the text of the label
    
    Returns:
    
    the width of the text
  - getTextHeight
```
public double getTextHeight()
```
    Returns the height of the text of the label
    
    Returns:
    
    the height of the text
  - getTextDescent
```
public double getTextDescent()
```
    Returns the text descent
    
    Returns:
    
    the textDescent
  - getFile
```
public File getFile()
```
    Returns:
    
    the file to which the label belongs
  - setFile
```
public void setFile(File f)
```
    Sets the file to which the label belongs. Can be null.
    
    Parameters:
    
    f - file to which the label belongs
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this label, the text.
  - contains
```
public boolean contains(double x,
                        double y)
```
    Checks whether x,y falls within the bounding box of the current text.
    
    Parameters:
    
    x - x-position
    
    y - y-position
    
    Returns:
    
    true if the point x,y falls withing the bounding box.
  - contains
```
public boolean contains(double x,
                        double y,
                        float scale)
```
  - getSettings
```
public void getSettings(XMLWrite xw)
```
    Returns the settings of the current label in a XML instance.
    
    Parameters:
    
    xw - instance of the class containing the settings.
  - updateSettings
```
public void updateSettings(XMLRead xr)
```
    Update the current label with the settings. These settings are formatted in XML and stored in an XMLRead instance.
    
    Parameters:
    
    xr - instance of the reader class, containing the settings.

Class GraphLabel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN

XLABEL

YLABEL

TITLE

PIPER_X1

PIPER_X2

PIPER_Y1

PIPER_Y2

PIPER_Y3

PIPER_Y4

DATA

OTHER

CHECK

STATBOX

KEY

Constructor Detail

GraphLabel

GraphLabel

GraphLabel

GraphLabel

GraphLabel

GraphLabel

GraphLabel

Method Detail

setKey

setKeyLineWidth

getKeyColor

getKeySize

getKeyLineWidth

getKeyType

getKeySpace

setKeySpace

copy

setSpace

setText

setText

getMultiText

getMultiLines

getText

getCharIterator

setColor

getColor

setFont

getFont

setActive

isActive

setUsePosition

setUseDataPosition

usePosition

useDataPosition

hide

hide

equals

equals

setID

getID

setDataRotation

setRotation

getRotation

setLocation

setDataLocation

getXPos

getYPos

getX

getY

setSize

setTextSize

getWidth

getHeight

getTextWidth

getTextHeight

getTextDescent

getFile

setFile