edu.uci.ics.jung.visualization.picking

Interface PickedState<T>

All Superinterfaces:

ItemSelectable, PickedInfo<T>

All Known Implementing Classes:

AbstractPickedState, MultiPickedState

public interface PickedState<T>
extends PickedInfo<T>, ItemSelectable

An interface for classes that keep track of the "picked" state of edges or vertices.

Author:

Tom Nelson, Joshua O'Madadhain

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the "picked" state from all elements.
Set<T>	getPicked()
boolean	isPicked(T v)
boolean	pick(T v, boolean b) Marks v as "picked" if b == true, and unmarks v as picked if b == false.

Methods inherited from interface java.awt.ItemSelectable

addItemListener, getSelectedObjects, removeItemListener

Method Detail

pick

boolean pick(T v,
             boolean b)

Marks v as "picked" if b == true, and unmarks v as picked if b == false.

Parameters:

v - the element to be picked/unpicked

b - true if v is to be marked as picked, false if to be marked as unpicked

Returns:

the "picked" state of v prior to this call

clear

void clear()

Clears the "picked" state from all elements.

getPicked

Set<T> getPicked()

Returns:

all "picked" elements.

isPicked

boolean isPicked(T v)

Specified by:

isPicked in interface PickedInfo<T>

Returns:

true if v is currently "picked".