LegendTitle
org.jfree.chart.title

Class LegendTitle

  • All Implemented Interfaces:
    Serializable, Cloneable, Block, org.jfree.ui.Drawable, org.jfree.util.PublicCloneable


    public class LegendTitleextends Titleimplements Cloneable, org.jfree.util.PublicCloneable, Serializable
    A chart title that displays a legend for the data in the chart.

    The title can be populated with legend items manually, or you can assign a reference to the plot, in which case the legend items will be automatically created to match the dataset(s).

    See Also:
    Serialized Form
    • Field Detail

      • DEFAULT_ITEM_FONT

        public static final Font DEFAULT_ITEM_FONT
        The default item font.
      • DEFAULT_ITEM_PAINT

        public static final Paint DEFAULT_ITEM_PAINT
        The default item paint.
    • Constructor Detail

      • LegendTitle

        public LegendTitle(LegendItemSource source)
        Constructs a new (empty) legend for the specified source.
        Parameters:
        source - the source.
      • LegendTitle

        public LegendTitle(LegendItemSource source,           Arrangement hLayout,           Arrangement vLayout)
        Creates a new legend title with the specified arrangement.
        Parameters:
        source - the source.
        hLayout - the horizontal item arrangement (null not permitted).
        vLayout - the vertical item arrangement (null not permitted).
    • Method Detail

      • getSources

        public LegendItemSource[] getSources()
        Returns the legend item sources.
        Returns:
        The sources.
      • setSources

        public void setSources(LegendItemSource[] sources)
        Sets the legend item sources and sends a TitleChangeEvent to all registered listeners.
        Parameters:
        sources - the sources (null not permitted).
      • getBackgroundPaint

        public Paint getBackgroundPaint()
        Returns the background paint.
        Returns:
        The background paint (possibly null).
      • setBackgroundPaint

        public void setBackgroundPaint(Paint paint)
        Sets the background paint for the legend and sends a TitleChangeEvent to all registered listeners.
        Parameters:
        paint - the paint (null permitted).
      • getLegendItemGraphicEdge

        public org.jfree.ui.RectangleEdge getLegendItemGraphicEdge()
        Returns the location of the shape within each legend item.
        Returns:
        The location (never null).
      • setLegendItemGraphicEdge

        public void setLegendItemGraphicEdge(org.jfree.ui.RectangleEdge edge)
        Sets the location of the shape within each legend item.
        Parameters:
        edge - the edge (null not permitted).
      • getLegendItemGraphicAnchor

        public org.jfree.ui.RectangleAnchor getLegendItemGraphicAnchor()
        Returns the legend item graphic anchor.
        Returns:
        The graphic anchor (never null).
      • setLegendItemGraphicAnchor

        public void setLegendItemGraphicAnchor(org.jfree.ui.RectangleAnchor anchor)
        Sets the anchor point used for the graphic in each legend item.
        Parameters:
        anchor - the anchor point (null not permitted).
      • getLegendItemGraphicLocation

        public org.jfree.ui.RectangleAnchor getLegendItemGraphicLocation()
        Returns the legend item graphic location.
        Returns:
        The location (never null).
      • setLegendItemGraphicLocation

        public void setLegendItemGraphicLocation(org.jfree.ui.RectangleAnchor anchor)
        Sets the legend item graphic location.
        Parameters:
        anchor - the anchor (null not permitted).
      • getLegendItemGraphicPadding

        public org.jfree.ui.RectangleInsets getLegendItemGraphicPadding()
        Returns the padding that will be applied to each item graphic.
        Returns:
        The padding (never null).
      • setLegendItemGraphicPadding

        public void setLegendItemGraphicPadding(org.jfree.ui.RectangleInsets padding)
        Sets the padding that will be applied to each item graphic in the legend and sends a TitleChangeEvent to all registered listeners.
        Parameters:
        padding - the padding (null not permitted).
      • getItemFont

        public Font getItemFont()
        Returns the item font.
        Returns:
        The font (never null).
      • setItemFont

        public void setItemFont(Font font)
        Sets the item font and sends a TitleChangeEvent to all registered listeners.
        Parameters:
        font - the font (null not permitted).
      • getItemPaint

        public Paint getItemPaint()
        Returns the item paint.
        Returns:
        The paint (never null).
      • setItemPaint

        public void setItemPaint(Paint paint)
        Sets the item paint.
        Parameters:
        paint - the paint (null not permitted).
      • getItemLabelPadding

        public org.jfree.ui.RectangleInsets getItemLabelPadding()
        Returns the padding used for the items labels.
        Returns:
        The padding (never null).
      • setItemLabelPadding

        public void setItemLabelPadding(org.jfree.ui.RectangleInsets padding)
        Sets the padding used for the item labels in the legend.
        Parameters:
        padding - the padding (null not permitted).
      • getSortOrder

        public org.jfree.util.SortOrder getSortOrder()
        Gets the order used to display legend items.
        Returns:
        The order (never null).
      • setSortOrder

        public void setSortOrder(org.jfree.util.SortOrder order)
        Sets the order used to display legend items.
        Parameters:
        order - Specifies ascending or descending order (null not permitted).
      • getItemContainer

        public BlockContainer getItemContainer()
        Returns the container that holds the legend items.
        Returns:
        The container for the legend items.
      • arrange

        public org.jfree.ui.Size2D arrange(Graphics2D g2,                          RectangleConstraint constraint)
        Arranges the contents of the block, within the given constraints, and returns the block size.
        Specified by:
        arrange in interface Block
        Overrides:
        arrange in class AbstractBlock
        Parameters:
        g2 - the graphics device.
        constraint - the constraint (null not permitted).
        Returns:
        The block size (in Java2D units, never null).
      • draw

        public 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
        Specified by:
        draw in class Title
        Parameters:
        g2 - the graphics device.
        area - the available area for the title.
      • getWrapper

        public BlockContainer getWrapper()
        Returns the wrapper container, if any.
        Returns:
        The wrapper container (possibly null).
      • setWrapper

        public void setWrapper(BlockContainer wrapper)
        Sets the wrapper container for the legend.
        Parameters:
        wrapper - the wrapper container.
      • equals

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

SCaVis 2.1 © jWork.ORG