prefuse.visual
Interface AggregateItem

All Superinterfaces:

Tuple, VisualItem

All Known Implementing Classes:

TableAggregateItem

public interface AggregateItem

extends VisualItem

VisualItem that represents an aggregation of one or more other VisualItems. AggregateItems include methods adding and removing items from the aggregate collection, and are backed by an AggregateTable instance.

Author:

jeffrey heer

Field Summary

Fields inherited from interface prefuse.visual.VisualItem

BOUNDS, DOI, ENDFILLCOLOR, ENDFONT, ENDPOLYGON, ENDSIZE, ENDSTROKECOLOR, ENDTEXTCOLOR, ENDVISIBLE, ENDX, ENDX2, ENDY, ENDY2, EXPANDED, FILLCOLOR, FIXED, FONT, HIGHLIGHT, HOVER, IDX_VALIDATED, INTERACTIVE, LABEL, POLYGON, SCHEMA, SHAPE, SIZE, STARTFILLCOLOR, STARTFONT, STARTPOLYGON, STARTSIZE, STARTSTROKECOLOR, STARTTEXTCOLOR, STARTVISIBLE, STARTX, STARTX2, STARTY, STARTY2, STROKE, STROKECOLOR, TEXTCOLOR, VALIDATED, VALUE, VISIBLE, X, X2, Y, Y2

Method Summary

void	addItem(VisualItem item) Add a VisualItem to this aggregate.
boolean	containsItem(VisualItem item) Indicates is a given VisualItem is contained in the aggregation.
int	getAggregateSize() Get the size of this AggregateItem, the number of visual items contained in the aggregation.
java.util.Iterator	items() Get an iterator over all the items contained in this aggregate.
java.util.Iterator	items(Predicate filter) Get a filtered iterator over all the items contained in this aggregate.
void	removeAllItems() Remove all items contained in this aggregate.
void	removeItem(VisualItem item) Remove a VisualItem from this aggregate.

Methods inherited from interface prefuse.visual.VisualItem

getBounds, getDOI, getEndFillColor, getEndFont, getEndSize, getEndStrokeColor, getEndTextColor, getEndX, getEndY, getFillColor, getFont, getGroup, getRenderer, getShape, getSize, getSourceData, getSourceTuple, getStartFillColor, getStartFont, getStartSize, getStartStrokeColor, getStartTextColor, getStartX, getStartY, getStroke, getStrokeColor, getTextColor, getVisualization, getX, getY, isEndVisible, isExpanded, isFixed, isHighlighted, isHover, isInGroup, isInteractive, isStartVisible, isValidated, isVisible, render, setBounds, setDOI, setEndFillColor, setEndFont, setEndSize, setEndStrokeColor, setEndTextColor, setEndVisible, setEndX, setEndY, setExpanded, setFillColor, setFixed, setFont, setHighlighted, setHover, setInteractive, setShape, setSize, setStartFillColor, setStartFont, setStartSize, setStartStrokeColor, setStartTextColor, setStartVisible, setStartX, setStartY, setStroke, setStrokeColor, setTextColor, setValidated, setVisible, setX, setY, validateBounds

Methods inherited from interface prefuse.data.Tuple

canGet, canGetBoolean, canGetDate, canGetDouble, canGetFloat, canGetInt, canGetLong, canGetString, canSet, canSetBoolean, canSetDate, canSetDouble, canSetFloat, canSetInt, canSetLong, canSetString, get, get, getBoolean, getBoolean, getColumnCount, getColumnIndex, getColumnName, getColumnType, getColumnType, getDate, getDate, getDefault, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getRow, getSchema, getString, getString, getTable, isValid, revertToDefault, set, set, setBoolean, setBoolean, setDate, setDate, setDouble, setDouble, setFloat, setFloat, setInt, setInt, setLong, setLong, setString, setString

Method Detail

getAggregateSize

public int getAggregateSize()

Get the size of this AggregateItem, the number of visual items contained in the aggregation.

Returns:

the aggregate size

containsItem

public boolean containsItem(VisualItem item)

Indicates is a given VisualItem is contained in the aggregation.

Parameters:

item - the VisualItem to check for containment

Returns:

true if the given item is contained in this aggregate, false otherwise.

addItem

public void addItem(VisualItem item)

Add a VisualItem to this aggregate.

Parameters:

item - the item to add

removeItem

public void removeItem(VisualItem item)

Remove a VisualItem from this aggregate.

Parameters:

item - the item to remove

removeAllItems

public void removeAllItems()

Remove all items contained in this aggregate.

items

public java.util.Iterator items()

Get an iterator over all the items contained in this aggregate.

Returns:

an iterator over the items in this aggregate

items

public java.util.Iterator items(Predicate filter)

Get a filtered iterator over all the items contained in this aggregate.

Parameters:

filter - a Predicate instance indicating the filter criteria

Returns:

an iterator over the items in this aggregate