Title
org.jfree.chart.title

Class Title

    • Field Detail

      • DEFAULT_POSITION

        public static final org.jfree.ui.RectangleEdge DEFAULT_POSITION
        The default title position.
      • DEFAULT_HORIZONTAL_ALIGNMENT

        public static final org.jfree.ui.HorizontalAlignment DEFAULT_HORIZONTAL_ALIGNMENT
        The default horizontal alignment.
      • DEFAULT_VERTICAL_ALIGNMENT

        public static final org.jfree.ui.VerticalAlignment DEFAULT_VERTICAL_ALIGNMENT
        The default vertical alignment.
      • DEFAULT_PADDING

        public static final org.jfree.ui.RectangleInsets DEFAULT_PADDING
        Default title padding.
      • visible

        public boolean visible
        A flag that controls whether or not the title is visible.
    • Method Detail

      • isVisible

        public boolean isVisible()
        Returns a flag that controls whether or not the title should be drawn. The default value is true.
        Returns:
        A boolean.
        See Also:
        setVisible(boolean)
      • setVisible

        public void setVisible(boolean visible)
        Sets a flag that controls whether or not the title should be drawn, and sends a TitleChangeEvent to all registered listeners.
        Parameters:
        visible - the new flag value.
        See Also:
        isVisible()
      • getPosition

        public org.jfree.ui.RectangleEdge getPosition()
        Returns the position of the title.
        Returns:
        The title position (never null).
      • setPosition

        public void setPosition(org.jfree.ui.RectangleEdge position)
        Sets the position for the title and sends a TitleChangeEvent to all registered listeners.
        Parameters:
        position - the position (null not permitted).
      • getHorizontalAlignment

        public org.jfree.ui.HorizontalAlignment getHorizontalAlignment()
        Returns the horizontal alignment of the title.
        Returns:
        The horizontal alignment (never null).
      • setHorizontalAlignment

        public void setHorizontalAlignment(org.jfree.ui.HorizontalAlignment alignment)
        Sets the horizontal alignment for the title and sends a TitleChangeEvent to all registered listeners.
        Parameters:
        alignment - the horizontal alignment (null not permitted).
      • getVerticalAlignment

        public org.jfree.ui.VerticalAlignment getVerticalAlignment()
        Returns the vertical alignment of the title.
        Returns:
        The vertical alignment (never null).
      • setVerticalAlignment

        public void setVerticalAlignment(org.jfree.ui.VerticalAlignment alignment)
        Sets the vertical alignment for the title, and notifies any registered listeners of the change.
        Parameters:
        alignment - the new vertical alignment (TOP, MIDDLE or BOTTOM, null not permitted).
      • getNotify

        public boolean getNotify()
        Returns the flag that indicates whether or not the notification mechanism is enabled.
        Returns:
        The flag.
      • setNotify

        public void setNotify(boolean flag)
        Sets the flag that indicates whether or not the notification mechanism is enabled. There are certain situations (such as cloning) where you want to turn notification off temporarily.
        Parameters:
        flag - the new value of the flag.
      • draw

        public abstract void draw(Graphics2D g2,        Rectangle2D area)
        Draws the title on a Java 2D graphics device (such as the screen or a printer).
        Specified by:
        draw in interface org.jfree.ui.Drawable
        Parameters:
        g2 - the graphics device.
        area - the area allocated for the title (subclasses should not draw outside this area).
      • clone

        public Object clone()             throws CloneNotSupportedException
        Returns a clone of the title.

        One situation when this is useful is when editing the title properties - you can edit a clone, and then it is easier to cancel the changes if necessary.

        Overrides:
        clone in class AbstractBlock
        Returns:
        A clone of the title.
        Throws:
        CloneNotSupportedException - not thrown by this class, but it may be thrown by subclasses.
      • addChangeListener

        public void addChangeListener(TitleChangeListener listener)
        Registers an object for notification of changes to the title.
        Parameters:
        listener - the object that is being registered.
      • removeChangeListener

        public void removeChangeListener(TitleChangeListener listener)
        Unregisters an object for notification of changes to the chart title.
        Parameters:
        listener - the object that is being unregistered.
      • equals

        public boolean equals(Object obj)
        Tests an object for equality with this title.
        Overrides:
        equals in class AbstractBlock
        Parameters:
        obj - the object (null not permitted).
        Returns:
        true or false.
      • hashCode

        public int hashCode()
        Returns a hashcode for the title.
        Overrides:
        hashCode in class Object
        Returns:
        The hashcode.

SCaVis 2.0 © jWork.ORG