Package repast.simphony.ui.probe
Class ProbeManager
- java.lang.Object
-
- saf.core.ui.event.DockableFrameAdapter
-
- repast.simphony.ui.probe.ProbeManager
-
- All Implemented Interfaces:
ProbeListener
,saf.core.ui.event.DockableFrameListener
public class ProbeManager extends saf.core.ui.event.DockableFrameAdapter implements ProbeListener
Manages the creation, destruction and updating of probes.- Author:
- Nick Collier
-
-
Field Summary
Fields Modifier and Type Field Description static String
PROBED_OBJ_KEY
-
Constructor Summary
Constructors Constructor Description ProbeManager(RSGui gui)
Creates a ProbeManager and associates it with the specified gui.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addLocationProbeProvider(Class<?> projectionClass, LocationProbeProvider provider)
void
addPPUICreator(Class<?> propertyClass, PPUICreatorFactory creator)
Adds a PPUICreator that will be used to create UIs for probed properties.static String
createTitle(Object obj)
void
dockableClosed(saf.core.ui.event.DockableFrameEvent evt)
Removes the probe in the closed view from this ProbeManager.Map<Class<?>,PPUICreatorFactory>
getUiCreatorMap()
boolean
hasLocationProbeProvider(Class<?> projectionClass)
Gets whether or no this ProbeManager has an ProbeLocationProivder registered for the specified projection.boolean
hasUICreatorFactory(Class<?> probedObjectClass)
Gets whether or no this ProbeManager has an PPUICreatorFactory registered for the specified class.void
objectProbed(ProbeEvent evt)
Creates and display a probe for the objects in the ProbeEvent.void
reset()
void
update()
Update all the probes to show the current values of their probed objects.
-
-
-
Field Detail
-
PROBED_OBJ_KEY
public static final String PROBED_OBJ_KEY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ProbeManager
public ProbeManager(RSGui gui)
Creates a ProbeManager and associates it with the specified gui.- Parameters:
gui
- the gui for this app
-
-
Method Detail
-
addPPUICreator
public void addPPUICreator(Class<?> propertyClass, PPUICreatorFactory creator)
Adds a PPUICreator that will be used to create UIs for probed properties.- Parameters:
creator
-
-
addLocationProbeProvider
public void addLocationProbeProvider(Class<?> projectionClass, LocationProbeProvider provider)
-
reset
public void reset()
-
update
public void update()
Update all the probes to show the current values of their probed objects.
-
dockableClosed
public void dockableClosed(saf.core.ui.event.DockableFrameEvent evt)
Removes the probe in the closed view from this ProbeManager.- Specified by:
dockableClosed
in interfacesaf.core.ui.event.DockableFrameListener
- Overrides:
dockableClosed
in classsaf.core.ui.event.DockableFrameAdapter
- Parameters:
evt
- the details of the close event
-
objectProbed
public void objectProbed(ProbeEvent evt)
Creates and display a probe for the objects in the ProbeEvent.- Specified by:
objectProbed
in interfaceProbeListener
- Parameters:
evt
- the details of the probe
-
hasUICreatorFactory
public boolean hasUICreatorFactory(Class<?> probedObjectClass)
Gets whether or no this ProbeManager has an PPUICreatorFactory registered for the specified class.- Parameters:
probedObjectClass
-- Returns:
- true if there is a PPUICreatorFactory otherwise false.
-
hasLocationProbeProvider
public boolean hasLocationProbeProvider(Class<?> projectionClass)
Gets whether or no this ProbeManager has an ProbeLocationProivder registered for the specified projection.- Parameters:
projection
-- Returns:
- true if there is a ProbeLocationProivder otherwise false.
-
getUiCreatorMap
public Map<Class<?>,PPUICreatorFactory> getUiCreatorMap()
-
-