org.jfree.chart.title
Class LegendItemBlockContainer

java.lang.Object
  extended byorg.jfree.chart.block.AbstractBlock
      extended byorg.jfree.chart.block.BlockContainer
          extended byorg.jfree.chart.title.LegendItemBlockContainer
All Implemented Interfaces:
Block, java.lang.Cloneable, org.jfree.ui.Drawable, org.jfree.util.PublicCloneable, java.io.Serializable

public class LegendItemBlockContainer
extends BlockContainer

A container that holds all the pieces of a single legend item.

Since:
1.0.2
See Also:
Serialized Form

Constructor Summary
LegendItemBlockContainer(Arrangement arrangement, int dataset, int series)
          Creates a new legend item block.
 
Method Summary
 java.lang.Object draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area, java.lang.Object params)
          Draws the block within the specified area.
 int getDatasetIndex()
          Returns the dataset index.
 int getSeriesIndex()
          Returns the series index.
 java.lang.String getToolTipText()
          Returns the tool tip text.
 java.lang.String getURLText()
          Returns the URL text.
 void setToolTipText(java.lang.String text)
          Sets the tool tip text.
 void setURLText(java.lang.String text)
          Sets the URL text.
 
Methods inherited from class org.jfree.chart.block.BlockContainer
add, add, arrange, clear, clone, draw, equals, getArrangement, getBlocks, isEmpty, setArrangement
 
Methods inherited from class org.jfree.chart.block.AbstractBlock
arrange, calculateTotalHeight, calculateTotalWidth, drawBorder, getBorder, getBounds, getContentXOffset, getContentYOffset, getFrame, getHeight, getID, getMargin, getPadding, getWidth, setBorder, setBorder, setBounds, setFrame, setHeight, setID, setMargin, setMargin, setPadding, setPadding, setWidth, toContentConstraint, trimBorder, trimMargin, trimPadding, trimToContentHeight, trimToContentWidth
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jfree.chart.block.Block
arrange, getBounds, getID, setBounds, setID
 

Constructor Detail

LegendItemBlockContainer

public LegendItemBlockContainer(Arrangement arrangement,
                                int dataset,
                                int series)
Creates a new legend item block.

Parameters:
arrangement -
dataset -
series -
Method Detail

getDatasetIndex

public int getDatasetIndex()
Returns the dataset index.

Returns:
The dataset index.

getSeriesIndex

public int getSeriesIndex()
Returns the series index.

Returns:
The series index.

getToolTipText

public java.lang.String getToolTipText()
Returns the tool tip text.

Returns:
The tool tip text (possibly null).
Since:
1.0.3

setToolTipText

public void setToolTipText(java.lang.String text)
Sets the tool tip text.

Parameters:
text - the text (null permitted).
Since:
1.0.3

getURLText

public java.lang.String getURLText()
Returns the URL text.

Returns:
The URL text (possibly null).
Since:
1.0.3

setURLText

public void setURLText(java.lang.String text)
Sets the URL text.

Parameters:
text - the text (null permitted).
Since:
1.0.3

draw

public java.lang.Object draw(java.awt.Graphics2D g2,
                             java.awt.geom.Rectangle2D area,
                             java.lang.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.