Documentation of 'jhplot.HMLabel' Java class.
HMLabel
jhplot

Class HMLabel

  • All Implemented Interfaces:
    java.io.Serializable


    public class HMLabel
    extends java.lang.Object
    implements java.io.Serializable
    An interactive multi-line label in the USER or NDC coordinates for HPlot canvas. The label can be defined in the NDC (normalized coordinate system) or the user coordinate For more labels look at the shape package
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      HMLabel(java.lang.String[] s)
      Make a multitext label with default attributes.
      HMLabel(java.lang.String[] s, double x, double y)
      Make a label with specific coordinated in the data system
      HMLabel(java.lang.String[] s, double x, double y, java.lang.String howToSet)
      Make a label with specific coordinates.
      HMLabel(java.lang.String[] s, java.awt.Font f)
      Make a multitext label (black color is used).
      HMLabel(java.lang.String[] s, java.awt.Font f, java.awt.Color c)
      Make a multitext label
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void doc()
      Show online documentation.
      java.awt.Color getColor()
      Get color of the label.
      java.awt.Font getFont()
      Get the text 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()
      Get text of the label.
      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.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • HMLabel

        public HMLabel(java.lang.String[] s,
                       java.awt.Font f,
                       java.awt.Color c)
        Make a multitext label
        Parameters:
        s - Lines of a text
        f - Font
        c - Color
      • HMLabel

        public HMLabel(java.lang.String[] s,
                       java.awt.Font f)
        Make a multitext label (black color is used).
        Parameters:
        s - Text
        f - Font
      • HMLabel

        public HMLabel(java.lang.String[] s)
        Make a multitext label with default attributes.
        Parameters:
        s - lines of the text
      • HMLabel

        public HMLabel(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
      • HMLabel

        public HMLabel(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 normalized 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.
        Parameters:
        s - new text for the label
      • getText

        public java.lang.String[] getText()
        Get text of the label.
        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()
        Get color of the label.
        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 text 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 defined 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
      • doc

        public void doc()
        Show online documentation.

DMelt 3.0 © DataMelt by jWork.ORG