Summary: Methods | [Expand All]
public interface

EntityCollection

org.jfree.chart.entity.EntityCollection
Known Indirect Subclasses

Class Overview

This interface defines the methods used to access an ordered list of ChartEntity objects.

Summary

Public Methods
abstract void add(ChartEntity entity)
Adds an entity to the collection.
abstract void addAll(EntityCollection collection)
Adds the entities from another collection to this collection.
abstract void clear()
Clears all entities.
abstract Collection getEntities()
Returns the entities in an unmodifiable collection.
abstract ChartEntity getEntity(int index)
Returns an entity from the collection.
abstract ChartEntity getEntity(double x, double y)
Returns an entity whose area contains the specified point.
abstract int getEntityCount()
Returns the entity count.
abstract Iterator iterator()
Returns an iterator for the entities in the collection.

Public Methods

public abstract void add (ChartEntity entity)

Adds an entity to the collection.

Parameters
entity the entity (null not permitted).

public abstract void addAll (EntityCollection collection)

Adds the entities from another collection to this collection.

Parameters
collection the other collection.

public abstract void clear ()

Clears all entities.

public abstract Collection getEntities ()

Returns the entities in an unmodifiable collection.

Returns
  • The entities.

public abstract ChartEntity getEntity (int index)

Returns an entity from the collection.

Parameters
index the index (zero-based).
Returns
  • An entity.

public abstract ChartEntity getEntity (double x, double y)

Returns an entity whose area contains the specified point.

Parameters
x the x coordinate.
y the y coordinate.
Returns
  • The entity.

public abstract int getEntityCount ()

Returns the entity count.

Returns
  • The entity count.

public abstract Iterator iterator ()

Returns an iterator for the entities in the collection.

Returns
  • An iterator.