Package org.jfree.chart.labels

Class ItemLabelPosition

  • All Implemented Interfaces:
    java.io.Serializable
    public class ItemLabelPosition
extends java.lang.Object
implements java.io.Serializable
    The attributes that control the position of the label for each data item on a chart. Instances of this class are immutable.
    See Also:
    Serialized Form

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        For serialization.
        See Also:
        Constant Field Values

      • itemLabelAnchor

        private ItemLabelAnchor itemLabelAnchor
        The item label anchor point.

      • textAnchor

        private TextAnchor textAnchor
        The text anchor.

      • rotationAnchor

        private TextAnchor rotationAnchor
        The rotation anchor.

      • angle

        private double angle
        The rotation angle.

      • itemLabelClip

        private ItemLabelClip itemLabelClip
        The item label clip type.

    • Constructor Detail

      • ItemLabelPosition

        public ItemLabelPosition()
        Creates a new position record with default settings.

      • ItemLabelPosition

        public ItemLabelPosition​(ItemLabelAnchor itemLabelAnchor,
                         TextAnchor textAnchor)
        Creates a new position record (with zero rotation).
        Parameters:
        itemLabelAnchor - the item label anchor (null not permitted).
        textAnchor - the text anchor (null not permitted).

      • ItemLabelPosition

        public ItemLabelPosition​(ItemLabelAnchor itemLabelAnchor,
                         TextAnchor textAnchor,
                         ItemLabelClip itemLabelClip)
        Creates a new position record. The item label anchor is a point relative to the data item (dot, bar or other visual item) on a chart. The item label is aligned by aligning the text anchor with the item label anchor.
        Parameters:
        itemLabelAnchor - the item label anchor (null not permitted).
        textAnchor - the text anchor (null not permitted).
        itemLabelClip - The clip type for the label (null not permitted. Only used when ItemLabelAnchor.isInternal() returns true, if false labelClip is always considered to be ItemLabelClip.NONE)

      • ItemLabelPosition

        public ItemLabelPosition​(ItemLabelAnchor itemLabelAnchor,
                         TextAnchor textAnchor,
                         TextAnchor rotationAnchor,
                         double angle)
        Creates a new position record. The item label anchor is a point relative to the data item (dot, bar or other visual item) on a chart. The item label is aligned by aligning the text anchor with the item label anchor.
        Parameters:
        itemLabelAnchor - the item label anchor (null not permitted).
        textAnchor - the text anchor (null not permitted).
        rotationAnchor - the rotation anchor (null not permitted).
        angle - the rotation angle (in radians).

      • ItemLabelPosition

        public ItemLabelPosition​(ItemLabelAnchor itemLabelAnchor,
                         TextAnchor textAnchor,
                         TextAnchor rotationAnchor,
                         double angle,
                         ItemLabelClip itemLabelClip)
        Creates a new position record. The item label anchor is a point relative to the data item (dot, bar or other visual item) on a chart. The item label is aligned by aligning the text anchor with the item label anchor.
        Parameters:
        itemLabelAnchor - the item label anchor (null not permitted).
        textAnchor - the text anchor (null not permitted).
        rotationAnchor - the rotation anchor (null not permitted).
        angle - the rotation angle (in radians).
        itemLabelClip - The clip type for the label (null not permitted. Only used when ItemLabelAnchor.isInternal() returns true, if false labelClip is always considered to be ItemLabelClip.NONE)

    • Method Detail

      • getItemLabelAnchor

        public ItemLabelAnchor getItemLabelAnchor()
        Returns the item label anchor.
        Returns:
        The item label anchor (never null).

      • getTextAnchor

        public TextAnchor getTextAnchor()
        Returns the text anchor.
        Returns:
        The text anchor (never null).

      • getRotationAnchor

        public TextAnchor getRotationAnchor()
        Returns the rotation anchor point.
        Returns:
        The rotation anchor point (never null).

      • getAngle

        public double getAngle()
        Returns the angle of rotation for the label.
        Returns:
        The angle (in radians).

      • getItemLabelClip

        public ItemLabelClip getItemLabelClip()
        Returns the clip type for the label.
        Returns:
        The clip type for the label.

      • equals

        public boolean equals​(java.lang.Object obj)
        Tests this object for equality with an arbitrary object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object