Package repast.simphony.ui.parameters
Interface ParameterBinder
-
- All Known Implementing Classes:
AbstractParameterBinder
,BooleanParameterBinder
,DefaultParameterBinder
,FPRangeParameterBinder
,ListParameterBinder
,RandomSeedParameterBinder
,RangeParameterBinder
,ReadOnlyParameterBinder
public interface ParameterBinder
Interface for classes that can create a JComponent for a particular parameter and "bind" that component to a parameter.- Author:
- Nick Collier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JComponent
getComponent(Parameters params)
Creates a JComponent for a parameter in the parameters.double
getDisplayOrder()
Gets the order of the created component in the display.String
getLabel()
Gets the label for the component created by this CompCreator.String
getName()
Gets the name of the parameter for which this is the binder.void
resetToDefault()
Resets the JComponent to the default value of its parameter.void
setDisplayOrder(double val)
Sets the order of the created component in the display.void
toParameter()
Updates the parameter that this is a binder for with the latest value from the created component.String
toXML()
Gets the parameter xml representation of this ParameterBinder.
-
-
-
Method Detail
-
getName
String getName()
Gets the name of the parameter for which this is the binder.- Returns:
- the name of the parameter for which this is the binder.
-
getComponent
JComponent getComponent(Parameters params)
Creates a JComponent for a parameter in the parameters.- Parameters:
params
-- Returns:
- the created JComponent.
-
getLabel
String getLabel()
Gets the label for the component created by this CompCreator.- Returns:
- the label for the component created by this CompCreator.
-
toParameter
void toParameter()
Updates the parameter that this is a binder for with the latest value from the created component.
-
resetToDefault
void resetToDefault()
Resets the JComponent to the default value of its parameter.
-
toXML
String toXML()
Gets the parameter xml representation of this ParameterBinder.- Returns:
- the parameter xml representation of this ParameterBinder.
-
setDisplayOrder
void setDisplayOrder(double val)
Sets the order of the created component in the display.- Parameters:
val
-
-
getDisplayOrder
double getDisplayOrder()
Gets the order of the created component in the display.
-
-