org.jfree.chart.title: public class: LegendItemBlockContainer

org.jfree.chart.title
public class: LegendItemBlockContainer [javadoc | source]

java.lang.Object
   org.jfree.chart.block.AbstractBlock
      org.jfree.chart.block.BlockContainer
         org.jfree.chart.title.LegendItemBlockContainer

All Implemented Interfaces:
PublicCloneable, Cloneable, Serializable, Block

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

since: 1.0.2 -

Constructor:

Constructor:
public LegendItemBlockContainer(Arrangement arrangement, int datasetIndex, int series) { super(arrangement); this.datasetIndex = datasetIndex; this.series = series; } Creates a new legend item block. Parameters: `arrangement` - the arrangement. `datasetIndex` - the dataset index. `series` - the series index.
public LegendItemBlockContainer(Arrangement arrangement, Dataset dataset, Comparable seriesKey) { super(arrangement); this.dataset = dataset; this.seriesKey = seriesKey; } Creates a new legend item block. Parameters: `arrangement` - the arrangement. `dataset` - the dataset. `seriesKey` - the series key. since: `1.0.6` -

 public LegendItemBlockContainer(Arrangement arrangement,
    int datasetIndex,
    int series) {
        super(arrangement);
        this.datasetIndex = datasetIndex;
        this.series = series;
}

Creates a new legend item block.

Parameters:

arrangement - the arrangement.

datasetIndex - the dataset index.

series - the series index.

 public LegendItemBlockContainer(Arrangement arrangement,
    Dataset dataset,
    Comparable seriesKey) {
        super(arrangement);
        this.dataset = dataset;
        this.seriesKey = seriesKey;
}

Creates a new legend item block.

Parameters:

arrangement - the arrangement.

dataset - the dataset.

seriesKey - the series key.

since: 1.0.6 -

Method from org.jfree.chart.title.LegendItemBlockContainer Summary:
draw, getDataset, getDatasetIndex, getSeriesIndex, getSeriesKey, getToolTipText, getURLText, setToolTipText, setURLText

Methods from org.jfree.chart.block.BlockContainer:
add, add, arrange, clear, clone, draw, draw, equals, getArrangement, getBlocks, isEmpty, setArrangement

Methods from org.jfree.chart.block.AbstractBlock:
arrange, arrange, calculateTotalHeight, calculateTotalWidth, clone, drawBorder, equals, 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 from org.jfree.chart.block.AbstractBlock:

arrange, arrange, calculateTotalHeight, calculateTotalWidth, clone, drawBorder, equals, 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 from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.jfree.chart.title.LegendItemBlockContainer Detail:
public Object draw(Graphics2D g2, Rectangle2D area, Object params) { // draw the block without collecting entities super.draw(g2, area, null); EntityBlockParams ebp = null; BlockResult r = new BlockResult(); if (params instanceof EntityBlockParams) { ebp = (EntityBlockParams) params; if (ebp.getGenerateEntities()) { EntityCollection ec = new StandardEntityCollection(); LegendItemEntity entity = new LegendItemEntity( (Shape) area.clone()); entity.setSeriesIndex(this.series); entity.setSeriesKey(this.seriesKey); entity.setDataset(this.dataset); entity.setToolTipText(getToolTipText()); entity.setURLText(getURLText()); ec.add(entity); r.setEntityCollection(ec); } } return r; } Draws the block within the specified area.
public Dataset getDataset() { return this.dataset; } Returns a reference to the dataset for the associated legend item.
public int getDatasetIndex() { return this.datasetIndex; } Deprecated! `As` - of 1.0.6, use the #getDataset() method. Returns the dataset index.
public int getSeriesIndex() { return this.series; } Returns the series index.
public Comparable getSeriesKey() { return this.seriesKey; } Returns the series key.
public String getToolTipText() { return this.toolTipText; } Returns the tool tip text.
public String getURLText() { return this.urlText; } Returns the URL text.
public void setToolTipText(String text) { this.toolTipText = text; } Sets the tool tip text.
public void setURLText(String text) { this.urlText = text; } Sets the URL text.

Method from org.jfree.chart.title.LegendItemBlockContainer Detail:

 public Object draw(Graphics2D g2,
    Rectangle2D area,
    Object params) {
        // draw the block without collecting entities
        super.draw(g2, area, null);
        EntityBlockParams ebp = null;
        BlockResult r = new BlockResult();
        if (params instanceof EntityBlockParams) {
            ebp = (EntityBlockParams) params;
            if (ebp.getGenerateEntities()) {
                EntityCollection ec = new StandardEntityCollection();
                LegendItemEntity entity = new LegendItemEntity(
                        (Shape) area.clone());
                entity.setSeriesIndex(this.series);
                entity.setSeriesKey(this.seriesKey);
                entity.setDataset(this.dataset);
                entity.setToolTipText(getToolTipText());
                entity.setURLText(getURLText());
                ec.add(entity);
                r.setEntityCollection(ec);
            }
        }
        return r;
}

Draws the block within the specified area.

 public Dataset getDataset() {
        return this.dataset;
}

Returns a reference to the dataset for the associated legend item.

 public int getDatasetIndex() {
        return this.datasetIndex;
}

Deprecated! As - of 1.0.6, use the #getDataset() method.

Returns the dataset index.

 public int getSeriesIndex() {
        return this.series;
}

Returns the series index.

 public Comparable getSeriesKey() {
        return this.seriesKey;
}

Returns the series key.

 public String getToolTipText() {
        return this.toolTipText;
}

Returns the tool tip text.

 public String getURLText() {
        return this.urlText;
}

Returns the URL text.

 public  void setToolTipText(String text) {
        this.toolTipText = text;
}

Sets the tool tip text.

 public  void setURLText(String text) {
        this.urlText = text;
}

Sets the URL text.