Package quadbase.util

Interface ITextString

All Superinterfaces:
Cloneable, IText
All Known Implementing Classes:
TextString, TextString

public interface ITextString extends IText
This function is used to set/get the different properties associated with the text strings drawn in a chart.
See Also:
  • Method Details

    • getValue

      String getValue()
      This function returns the value of the string.
      Returns:
      The value of the string as a String object.
    • setValue

      void setValue(String value)
      This function sets the value of the string.
      Parameters:
      value - The string value to set.
    • getPosition

      Position getPosition()
      Returns the position of the text string in the canvas
      Returns:
      The position object containing the x and y coordinates.
    • setPosition

      void setPosition(Position pos)
      Sets the position of the string in the canvas.
      Parameters:
      pos - The position object.
       Note that the x and y values in the position object should be
       between 0 and 1.
       
      See Also:
    • getOffset

      Dimension getOffset()
      Gets the relative offsets (horizontal and vertical) of the text string
      Returns:
      The offset as a Dimension object.
    • setOffset

      void setOffset(Dimension offset)
      Sets the offset values of the text string.
      Parameters:
      offset - The Dimension object containing the horizontal and vertical offsets.
    • equals

      boolean equals(Object textString)
      Returns true if the given object equals this one.
      Overrides:
      equals in class Object
      Parameters:
      textString - an object of type ITextString
      Returns:
      true if the given ITextString object is identical to this object, false otherwise.