Module platform

Class LegendItemBlockContainer

All Implemented Interfaces:
Serializable, Cloneable, Block, Drawable, PublicCloneable

public class LegendItemBlockContainer extends BlockContainer
A container that holds all the pieces of a single legend item.
See Also:
  • Constructor Details

    • LegendItemBlockContainer

      public LegendItemBlockContainer(Arrangement arrangement, Dataset dataset, Comparable seriesKey)
      Creates a new legend item block.
      Parameters:
      arrangement - the arrangement.
      dataset - the dataset.
      seriesKey - the series key.
  • Method Details

    • getDataset

      public Dataset getDataset()
      Returns a reference to the dataset for the associated legend item.
      Returns:
      A dataset reference.
    • getSeriesKey

      public Comparable getSeriesKey()
      Returns the series key.
      Returns:
      The series key.
    • getSeriesIndex

      public int getSeriesIndex()
      Returns the series index.
      Returns:
      The series index.
    • getToolTipText

      public String getToolTipText()
      Returns the tool tip text.
      Returns:
      The tool tip text (possibly null).
    • setToolTipText

      public void setToolTipText(String text)
      Sets the tool tip text.
      Parameters:
      text - the text (null permitted).
    • getURLText

      public String getURLText()
      Returns the URL text.
      Returns:
      The URL text (possibly null).
    • setURLText

      public void setURLText(String text)
      Sets the URL text.
      Parameters:
      text - the text (null permitted).
    • draw

      public Object draw(Graphics2D g2, Rectangle2D area, Object params)
      Draws the block within the specified area.
      Specified by:
      draw in interface Block
      Overrides:
      draw in class BlockContainer
      Parameters:
      g2 - the graphics device.
      area - the area.
      params - passed on to blocks within the container (null permitted).
      Returns:
      An instance of EntityBlockResult, or null.