Package repast.simphony.ui.probe

Class Probe

java.lang.Object

repast.simphony.ui.probe.Probe

public class Probe
extends Object

Encapsulates the gui representation and the model of a gui probe.S

Version:

$Revision$ $Date$

Author:

Nick Collier

Constructor Summary

Constructors

Constructor	Description
Probe(List<? extends com.jgoodies.binding.PresentationModel<?>> models, JPanel panel, String title)
Probe(List<? extends com.jgoodies.binding.PresentationModel<?>> models, JPanel panel, String title, boolean buffered)

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)	Adds a property change listener to this Probe.
void	commit()	Commit any pending changes to the bean.
void	flush()	Flush any pending changes from the bean.
JPanel	getPanel()	Gets the panel that displays the gui widgets for this probe.
String	getTitle()	Gets the title of this Probe.
boolean	isBuffered()	A probe is buffered if changes to its values are not automatically reflected in the probed object.
void	removePropertyChangeListener(PropertyChangeListener listener)	Removes a property change listener from this Probe.
void	update()	Updates the probe to show the latest values of the probed property.

Methods inherited from class java.lang.Object

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

Constructor Detail

Probe

public Probe(List<? extends com.jgoodies.binding.PresentationModel<?>> models,
             JPanel panel,
             String title)

Probe

public Probe(List<? extends com.jgoodies.binding.PresentationModel<?>> models,
             JPanel panel,
             String title,
             boolean buffered)

Method Detail

getTitle

public String getTitle()

Gets the title of this Probe.

Returns:

the title of this Probe.

isBuffered

public boolean isBuffered()

A probe is buffered if changes to its values are not automatically reflected in the probed object. Calling commit on a buffered probe will commit the changes to the probed object.

Returns:

true if this Probe is buffered, false otherwise.

update

public void update()

Updates the probe to show the latest values of the probed property.

flush

public void flush()

Flush any pending changes from the bean. Note that is only has an effect if this is a buffered probe.

commit

public void commit()

Commit any pending changes to the bean. Note that is only has an effect if this is a buffered probe.

getPanel

public JPanel getPanel()

Gets the panel that displays the gui widgets for this probe.

Returns:

the panel that displays the gui widgets for this probe.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a property change listener to this Probe. This listener will be called when the probed object is updated.

Parameters:

listener -

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a property change listener from this Probe.

Parameters:

listener -