Package org.jungrapht.visualization.selection

Class MultiMutableSelectedState<T>

java.lang.Object

org.jungrapht.visualization.selection.AbstractMutableSelectedState<T>

org.jungrapht.visualization.selection.MultiMutableSelectedState<T>

All Implemented Interfaces:

ItemSelectable, MutableSelectedState<T>, MutableSelectedStateSink<T>, SelectedState<T>

public class MultiMutableSelectedState<T>
extends AbstractMutableSelectedState<T>
implements MutableSelectedStateSink<T>

Maintains the state of what has been 'selected' in the graph. The Sets are constructed so that their iterators will traverse them in the order in which they are selected.

Author:

Tom Nelson

Nested Class Summary

Nested classes/interfaces inherited from interface org.jungrapht.visualization.selection.SelectedState

SelectedState.StateChangeListener<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<T>	selected	the 'selected' items

Fields inherited from class org.jungrapht.visualization.selection.AbstractMutableSelectedState

listenerList

Constructor Summary

Constructors

Constructor	Description
MultiMutableSelectedState()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the "selected" state from all elements.
void	clear(boolean fireEvents)	Clears the "selected" state from all elements.
boolean	deselect(Collection<T> elements)	deselect a collection of elements
boolean	deselect(Collection<T> elements, boolean fireEvents)	deselect a collection of elements
boolean	deselect(T element)	deselect one element
boolean	deselect(T t, boolean fireEvents)	if t is was already selected, remove it
Set<T>	getSelected()
T[]	getSelectedObjects()	for the ItemSelectable interface contract
boolean	isSelected(T t)
boolean	select(Collection<T> elements)	select a collection of elements to be the only selected elements
boolean	select(Collection<T> elements, boolean fireEvents)	select a collection of elements to be the only selected elements
boolean	select(T element)	Select an element
boolean	select(T element, boolean fireEvents)	select one element.

Methods inherited from class org.jungrapht.visualization.selection.AbstractMutableSelectedState

addItemListener, fireItemStateChanged, removeItemListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.awt.ItemSelectable

addItemListener, removeItemListener

Field Detail

selected

protected Set<T> selected

the 'selected' items

Constructor Detail

MultiMutableSelectedState

public MultiMutableSelectedState()

Method Detail

select

public boolean select(T element)

Select an element

Specified by:

select in interface MutableSelectedState<T>

Parameters:

element - the element to select

Returns:

true if the collection of selected changed

select

public boolean select(T element,
                      boolean fireEvents)

Description copied from interface: MutableSelectedStateSink

select one element.

Specified by:

select in interface MutableSelectedState<T>

Specified by:

select in interface MutableSelectedStateSink<T>

Parameters:

element - the element to select

fireEvents - if false, act as a sink, if true, do not fire events

Returns:

true if the collection of selected elements was changed

deselect

public boolean deselect(T t,
                        boolean fireEvents)

if t is was already selected, remove it

Specified by:

deselect in interface MutableSelectedState<T>

Specified by:

deselect in interface MutableSelectedStateSink<T>

Parameters:

t - item to de-select

fireEvents - act as a sink, if true, do not fire events

Returns:

true if the collection of selected things was modified

deselect

public boolean deselect(T element)

Description copied from interface: MutableSelectedState

deselect one element

Specified by:

deselect in interface MutableSelectedState<T>

Parameters:

element - the element to deselect

Returns:

true is the collection of selected elements was changed

select

public boolean select(Collection<T> elements,
                      boolean fireEvents)

Description copied from interface: MutableSelectedStateSink

select a collection of elements to be the only selected elements

Specified by:

select in interface MutableSelectedState<T>

Specified by:

select in interface MutableSelectedStateSink<T>

fireEvents - if false, act as a sink, if true, do not fire events

Returns:

true if the collection of selected elements was changed

select

public boolean select(Collection<T> elements)

Description copied from interface: MutableSelectedState

select a collection of elements to be the only selected elements

Specified by:

select in interface MutableSelectedState<T>

Returns:

true if the collection of selected elements was changed

deselect

public boolean deselect(Collection<T> elements,
                        boolean fireEvents)

Description copied from interface: MutableSelectedStateSink

deselect a collection of elements

Specified by:

deselect in interface MutableSelectedState<T>

Specified by:

deselect in interface MutableSelectedStateSink<T>

Parameters:

elements - the elements to deselect

fireEvents - if false, act as a sink, if true, do not fire events

Returns:

true if the collection of selected elements was changed

deselect

public boolean deselect(Collection<T> elements)

Description copied from interface: MutableSelectedState

deselect a collection of elements

Specified by:

deselect in interface MutableSelectedState<T>

Parameters:

elements - the elements to deselect

Returns:

true if the collection of selected elements was changed

clear

public void clear(boolean fireEvents)

Description copied from interface: MutableSelectedStateSink

Clears the "selected" state from all elements.

Specified by:

clear in interface MutableSelectedState<T>

Specified by:

clear in interface MutableSelectedStateSink<T>

Parameters:

fireEvents - if false, act as a sink, if true, do not fire events

clear

public void clear()

Description copied from interface: MutableSelectedState

Clears the "selected" state from all elements.

Specified by:

clear in interface MutableSelectedState<T>

getSelected

public Set<T> getSelected()

Specified by:

getSelected in interface SelectedState<T>

Returns:

all selected elements.

isSelected

public boolean isSelected(T t)

Specified by:

isSelected in interface SelectedState<T>

getSelectedObjects

public T[] getSelectedObjects()

for the ItemSelectable interface contract

Specified by:

getSelectedObjects in interface ItemSelectable