io.jbotsim.ui

Class JViewer

java.lang.Object

io.jbotsim.ui.JViewer

All Implemented Interfaces:

CommandListener, PropertyListener, EventListener, ChangeListener

public class JViewer
extends Object
implements CommandListener, ChangeListener, PropertyListener

The JViewer includes a central JTopology which will draw the attached topology and offer interaction, as well as contextual commands to add or remove a communication range or sensing range tuners (slider bars), or to pause/resume the system clock.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JViewer.AccelerationFunctionExp The JViewer.AccelerationFunctionExp class implements the following function in [0:JViewer.AccelerationFunctionExp.ZERO_AT]: 5.0 * Math.exp(-x / 15.0) - 3.0 Two methods are provided: JViewer.AccelerationFunctionExp.of(double): computes the function; JViewer.AccelerationFunctionExp.inverseOf(double): computes the inverse of the function.
protected static class	JViewer.BarType

Field Summary

Fields

Modifier and Type	Field and Description
protected JTopology	jtp
protected JSlider	slideBar
protected JViewer.BarType	slideBarType
protected TopologySerializerFilenameMatcher	topologySerializerFilenameMatcher
protected JFrame	window

Constructor Summary

Constructors

Constructor and Description
JViewer(JTopology jtopo) Creates a windowed viewer encapsulating the specified jtopology.
JViewer(JTopology jtopo, boolean windowed) Creates a viewer encapsulating the specified jtopology.
JViewer(Topology topo) Creates a windowed viewer for the specified topology.
JViewer(Topology topo, boolean selfContained) Creates a viewer for the specified topology.

Method Summary

Modifier and Type	Method and Description
void	addSlideBar(JViewer.BarType type, int value) Adds a slide bar at the top of the topology.
void	addTopologySerializer(String regexp, TopologySerializer topologySerializer) Records and links the provided TopologySerializer to a specific regular expression.
protected static double	computeClockSpeed(double maxValue, double value)
protected static double	computeSliderPosition(double maxValue, double value)
JTopology	getJTopology() Returns the jtopology attached to this viewer.
void	onCommand(String command) Provides a way to react upon command selection.
void	onPropertyChanged(Properties o, String p) Notifies that a property of this object has changed.
void	removeSlideBar() Removes the slide bar, if any.
void	setSize(int width, int height) Sets the size of the inner jtopology to the specified dimension.
void	setTitle(String title) Sets the title of the corresponding window
void	stateChanged(ChangeEvent e)

Methods inherited from class java.lang.Object

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

Field Detail

jtp

protected JTopology jtp

slideBar

protected JSlider slideBar

topologySerializerFilenameMatcher

protected TopologySerializerFilenameMatcher topologySerializerFilenameMatcher

slideBarType

protected JViewer.BarType slideBarType

window

protected JFrame window

Constructor Detail

JViewer

public JViewer(Topology topo)

Creates a windowed viewer for the specified topology.

Parameters:

topo - The topology to be drawn and/or manipulated.

JViewer

public JViewer(Topology topo,
               boolean selfContained)

Creates a viewer for the specified topology. If selfContained is true, a new window will be created to contain the viewer (similarly to JViewer(Topology)). If it is false, no window will be created and the viewer can be subsequently integrated to another swing container (e.g. another JFrame or a JApplet).

Parameters:

topo - The topology to be drawn and/or manipulated.

selfContained - Set this to false to avoid creating a JFrame (e.g. for embedding the JViewer in your own frame).

JViewer

public JViewer(JTopology jtopo)

Creates a windowed viewer encapsulating the specified jtopology.

Parameters:

jtopo - The jtopology to be encapsulated.

JViewer

public JViewer(JTopology jtopo,
               boolean windowed)

Creates a viewer encapsulating the specified jtopology. If selfContained is true, a new window will be created to contain the viewer (similarly to JViewer(Topology)). If it is false, no window will be created and the viewer can be subsequently integrated to another swing container (e.g. another JFrame or a JApplet).

Parameters:

jtopo - The JTopology to be encapsulated.

windowed - Set this to false to avoid creating a JFrame (e.g. for embedding the JViewer in your own frame).

Method Detail

getJTopology

public JTopology getJTopology()

Returns the jtopology attached to this viewer. Obtaining the reference can be useful for example to add or remove action commands or action listeners to the jtopology.

Returns:

The jtopology reference.

setSize

public void setSize(int width,
                    int height)

Sets the size of the inner jtopology to the specified dimension.

Parameters:

width - The desired width, in pixels.

height - The desired height, in pixels.

setTitle

public void setTitle(String title)

Sets the title of the corresponding window

Parameters:

title - the new title, as a String.

addSlideBar

public void addSlideBar(JViewer.BarType type,
                        int value)

Adds a slide bar at the top of the topology.

Parameters:

type - the JViewer.BarType to add.

value - the value for the slide bar, as an integer.

removeSlideBar

public void removeSlideBar()

Removes the slide bar, if any.

onCommand

public void onCommand(String command)

Description copied from interface: CommandListener

Provides a way to react upon command selection.

Specified by:

onCommand in interface CommandListener

Parameters:

command - the command which has risen.

addTopologySerializer

public void addTopologySerializer(String regexp,
                                  TopologySerializer topologySerializer)

Records and links the provided TopologySerializer to a specific regular expression.

This couple will be used during Topology import/export. If the file's name matches the provided regular expression, the linked TopologySerializer will be used for (de)serialization.

Parameters:

regexp - a regular expression matching the file names

topologySerializer - the TopologySerializer to be recorded

onPropertyChanged

public void onPropertyChanged(Properties o,
                              String p)

Description copied from interface: PropertyListener

Notifies that a property of this object has changed.

Specified by:

onPropertyChanged in interface PropertyListener

Parameters:

o - The object.

p - The name of the changed property.

stateChanged

public void stateChanged(ChangeEvent e)

Specified by:

stateChanged in interface ChangeListener

computeClockSpeed

protected static double computeClockSpeed(double maxValue,
                                          double value)

computeSliderPosition

protected static double computeSliderPosition(double maxValue,
                                              double value)