prefuse.visual
Interface AggregateItem<T extends VisualItem<?>,V extends VisualItem<?>>

All Superinterfaces:
Tuple<T>, VisualItem<T>
All Known Implementing Classes:
TableAggregateItem

public interface AggregateItem<T extends VisualItem<?>,V extends VisualItem<?>>
extends VisualItem<T>

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, MINIMUM_DOI, POLYGON, SCHEMA, SHAPEBUILDER, 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(V 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.lang.Iterable<V> items()
          Get an iterator over all the items contained in this aggregate.
 java.lang.Iterable<V> 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, getShapeBuilder, 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, setShapeBuilder, 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, init, invalidate, isValid, revertToDefault, set, set, setBoolean, setBoolean, setDate, setDate, setDouble, setDouble, setFloat, setFloat, setInt, setInt, setLong, setLong, setString, setString
 

Method Detail

getAggregateSize

int getAggregateSize()
Get the size of this AggregateItem, the number of visual items contained in the aggregation.

Returns:
the aggregate size

containsItem

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

void addItem(V item)
Add a VisualItem to this aggregate.

Parameters:
item - the item to add

removeItem

void removeItem(VisualItem<?> item)
Remove a VisualItem from this aggregate.

Parameters:
item - the item to remove

removeAllItems

void removeAllItems()
Remove all items contained in this aggregate.


items

java.lang.Iterable<V> items()
Get an iterator over all the items contained in this aggregate.

Returns:
an iterator over the items in this aggregate

items

java.lang.Iterable<V> 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


Copyright © 2008 Regents of the University of California