LegendItem
org.jfree.chart

Class LegendItem

    • Constructor Detail

      • LegendItem

        public LegendItem(String label)
        Creates a legend item with the specified label. The remaining attributes take default values.
        Parameters:
        label - the label (null not permitted).
      • LegendItem

        public LegendItem(String label,          Paint paint)
        Creates a legend item with the specified label and fill paint. The remaining attributes take default values.
        Parameters:
        label - the label (null not permitted).
        paint - the paint (null not permitted).
      • LegendItem

        public LegendItem(String label,          String description,          String toolTipText,          String urlText,          Shape shape,          Paint fillPaint)
        Creates a legend item with a filled shape. The shape is not outlined, and no line is visible.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shape - the shape (null not permitted).
        fillPaint - the paint used to fill the shape (null not permitted).
      • LegendItem

        public LegendItem(String label,          String description,          String toolTipText,          String urlText,          Shape shape,          Paint fillPaint,          Stroke outlineStroke,          Paint outlinePaint)
        Creates a legend item with a filled and outlined shape.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shape - the shape (null not permitted).
        fillPaint - the paint used to fill the shape (null not permitted).
        outlineStroke - the outline stroke (null not permitted).
        outlinePaint - the outline paint (null not permitted).
      • LegendItem

        public LegendItem(String label,          String description,          String toolTipText,          String urlText,          Shape line,          Stroke lineStroke,          Paint linePaint)
        Creates a legend item using a line.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        line - the line (null not permitted).
        lineStroke - the line stroke (null not permitted).
        linePaint - the line paint (null not permitted).
      • LegendItem

        public LegendItem(String label,          String description,          String toolTipText,          String urlText,          boolean shapeVisible,          Shape shape,          boolean shapeFilled,          Paint fillPaint,          boolean shapeOutlineVisible,          Paint outlinePaint,          Stroke outlineStroke,          boolean lineVisible,          Shape line,          Stroke lineStroke,          Paint linePaint)
        Creates a new legend item.
        Parameters:
        label - the label (null not permitted).
        description - the description (not currently used, null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shapeVisible - a flag that controls whether or not the shape is displayed.
        shape - the shape (null permitted).
        shapeFilled - a flag that controls whether or not the shape is filled.
        fillPaint - the fill paint (null not permitted).
        shapeOutlineVisible - a flag that controls whether or not the shape is outlined.
        outlinePaint - the outline paint (null not permitted).
        outlineStroke - the outline stroke (null not permitted).
        lineVisible - a flag that controls whether or not the line is visible.
        line - the line.
        lineStroke - the stroke (null not permitted).
        linePaint - the line paint (null not permitted).
      • LegendItem

        public LegendItem(AttributedString label,          String description,          String toolTipText,          String urlText,          Shape shape,          Paint fillPaint)
        Creates a legend item with a filled shape. The shape is not outlined, and no line is visible.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shape - the shape (null not permitted).
        fillPaint - the paint used to fill the shape (null not permitted).
      • LegendItem

        public LegendItem(AttributedString label,          String description,          String toolTipText,          String urlText,          Shape shape,          Paint fillPaint,          Stroke outlineStroke,          Paint outlinePaint)
        Creates a legend item with a filled and outlined shape.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shape - the shape (null not permitted).
        fillPaint - the paint used to fill the shape (null not permitted).
        outlineStroke - the outline stroke (null not permitted).
        outlinePaint - the outline paint (null not permitted).
      • LegendItem

        public LegendItem(AttributedString label,          String description,          String toolTipText,          String urlText,          Shape line,          Stroke lineStroke,          Paint linePaint)
        Creates a legend item using a line.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        line - the line (null not permitted).
        lineStroke - the line stroke (null not permitted).
        linePaint - the line paint (null not permitted).
      • LegendItem

        public LegendItem(AttributedString label,          String description,          String toolTipText,          String urlText,          boolean shapeVisible,          Shape shape,          boolean shapeFilled,          Paint fillPaint,          boolean shapeOutlineVisible,          Paint outlinePaint,          Stroke outlineStroke,          boolean lineVisible,          Shape line,          Stroke lineStroke,          Paint linePaint)
        Creates a new legend item.
        Parameters:
        label - the label (null not permitted).
        description - the description (not currently used, null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shapeVisible - a flag that controls whether or not the shape is displayed.
        shape - the shape (null permitted).
        shapeFilled - a flag that controls whether or not the shape is filled.
        fillPaint - the fill paint (null not permitted).
        shapeOutlineVisible - a flag that controls whether or not the shape is outlined.
        outlinePaint - the outline paint (null not permitted).
        outlineStroke - the outline stroke (null not permitted).
        lineVisible - a flag that controls whether or not the line is visible.
        line - the line (null not permitted).
        lineStroke - the stroke (null not permitted).
        linePaint - the line paint (null not permitted).
    • Method Detail

      • setDataset

        public void setDataset(Dataset dataset)
        Sets the dataset.
        Parameters:
        dataset - the dataset.
      • getDatasetIndex

        public int getDatasetIndex()
        Returns the dataset index for this legend item.
        Returns:
        The dataset index.
        See Also:
        setDatasetIndex(int), getDataset()
      • setDatasetIndex

        public void setDatasetIndex(int index)
        Sets the dataset index for this legend item.
        Parameters:
        index - the index.
        See Also:
        getDatasetIndex()
      • setSeriesKey

        public void setSeriesKey(Comparable key)
        Sets the series key.
        Parameters:
        key - the series key.
      • getSeriesIndex

        public int getSeriesIndex()
        Returns the series index for this legend item.
        Returns:
        The series index.
      • setSeriesIndex

        public void setSeriesIndex(int index)
        Sets the series index for this legend item.
        Parameters:
        index - the index.
      • getLabel

        public String getLabel()
        Returns the label.
        Returns:
        The label (never null).
      • getLabelFont

        public Font getLabelFont()
        Returns the label font.
        Returns:
        The label font (possibly null).
      • setLabelFont

        public void setLabelFont(Font font)
        Sets the label font.
        Parameters:
        font - the font (null permitted).
      • getLabelPaint

        public Paint getLabelPaint()
        Returns the paint used to draw the label.
        Returns:
        The paint (possibly null).
      • setLabelPaint

        public void setLabelPaint(Paint paint)
        Sets the paint used to draw the label.
        Parameters:
        paint - the paint (null permitted).
      • getAttributedLabel

        public AttributedString getAttributedLabel()
        Returns the attributed label.
        Returns:
        The attributed label (possibly null).
      • setDescription

        public void setDescription(String text)
        Sets the description for this legend item.
        Parameters:
        text - the description (null permitted).
        See Also:
        getDescription()
      • setToolTipText

        public void setToolTipText(String text)
        Sets the tool tip text for this legend item.
        Parameters:
        text - the text (null permitted).
        See Also:
        getToolTipText()
      • setURLText

        public void setURLText(String text)
        Sets the URL text.
        Parameters:
        text - the text (null permitted).
        See Also:
        getURLText()
      • isShapeVisible

        public boolean isShapeVisible()
        Returns a flag that indicates whether or not the shape is visible.
        Returns:
        A boolean.
        See Also:
        setShapeVisible(boolean)
      • setShapeVisible

        public void setShapeVisible(boolean visible)
        Sets the flag that controls whether or not the shape is visible.
        Parameters:
        visible - the new flag value.
        See Also:
        isShapeVisible(), isLineVisible()
      • getShape

        public Shape getShape()
        Returns the shape used to label the series represented by this legend item.
        Returns:
        The shape (never null).
        See Also:
        setShape(java.awt.Shape)
      • setShape

        public void setShape(Shape shape)
        Sets the shape for the legend item.
        Parameters:
        shape - the shape (null not permitted).
        See Also:
        getShape()
      • isShapeFilled

        public boolean isShapeFilled()
        Returns a flag that controls whether or not the shape is filled.
        Returns:
        A boolean.
      • getFillPaint

        public Paint getFillPaint()
        Returns the fill paint.
        Returns:
        The fill paint (never null).
      • setFillPaint

        public void setFillPaint(Paint paint)
        Sets the fill paint.
        Parameters:
        paint - the paint (null not permitted).
      • isShapeOutlineVisible

        public boolean isShapeOutlineVisible()
        Returns the flag that controls whether or not the shape outline is visible.
        Returns:
        A boolean.
      • getLineStroke

        public Stroke getLineStroke()
        Returns the line stroke for the series.
        Returns:
        The stroke (never null).
      • setLineStroke

        public void setLineStroke(Stroke stroke)
        Sets the line stroke.
        Parameters:
        stroke - the stroke (null not permitted).
      • getLinePaint

        public Paint getLinePaint()
        Returns the paint used for lines.
        Returns:
        The paint (never null).
      • setLinePaint

        public void setLinePaint(Paint paint)
        Sets the line paint.
        Parameters:
        paint - the paint (null not permitted).
      • getOutlinePaint

        public Paint getOutlinePaint()
        Returns the outline paint.
        Returns:
        The outline paint (never null).
      • setOutlinePaint

        public void setOutlinePaint(Paint paint)
        Sets the outline paint.
        Parameters:
        paint - the paint (null not permitted).
      • setOutlineStroke

        public void setOutlineStroke(Stroke stroke)
        Sets the outline stroke.
        Parameters:
        stroke - the stroke (null not permitted).
        See Also:
        getOutlineStroke()
      • isLineVisible

        public boolean isLineVisible()
        Returns a flag that indicates whether or not the line is visible.
        Returns:
        A boolean.
        See Also:
        setLineVisible(boolean)
      • setLineVisible

        public void setLineVisible(boolean visible)
        Sets the flag that controls whether or not the line shape is visible for this legend item.
        Parameters:
        visible - the new flag value.
        See Also:
        isLineVisible()
      • setLine

        public void setLine(Shape line)
        Sets the line.
        Parameters:
        line - the line (null not permitted).
        See Also:
        getLine()
      • getFillPaintTransformer

        public org.jfree.ui.GradientPaintTransformer getFillPaintTransformer()
        Returns the transformer used when the fill paint is an instance of GradientPaint.
        Returns:
        The transformer (never null).
        See Also:
        setFillPaintTransformer(GradientPaintTransformer)
      • setFillPaintTransformer

        public void setFillPaintTransformer(org.jfree.ui.GradientPaintTransformer transformer)
        Sets the transformer used when the fill paint is an instance of GradientPaint.
        Parameters:
        transformer - the transformer (null not permitted).
        See Also:
        getFillPaintTransformer()
      • equals

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

SCaVis 2.0 © jWork.ORG