Package velox.api.layer1.simplified
Annotation Type Parameter
@Target(FIELD)
@Retention(RUNTIME)
public @interface Parameter
A field annotated with the Parameter annotation can be configured
from Bookmap's GUI ("Configure api plugins" dialog).
Field types accepted:
- Byte, Short, Integer, Long, Float, Double (numeric types);
- String;
- Boolean;
- Color;
Any Parameter field must be initialized in a user's class (custom module).
Numeric types:
A spinner gets created for any numeric field. A user should specify spinner values:
- step;
- minimum value;
- maximum value.
Otherwise, default values will be used:
- step = 1;
- minimum value = 0;
- maximum value = maximal field type value (e.g.Integer.MAX_VALUE if the field is of Integer type).
Non-numeric field types (String, Boolean, Color):
Step, minimum and maximum values for any other field type should not be specified. Even if specified, they will be ignored.
GUI elements generated for non-numeric field types:
- String - text field;
- Boolean - checkbox;
- Color - color interface.
Field types accepted:
- Byte, Short, Integer, Long, Float, Double (numeric types);
- String;
- Boolean;
- Color;
Any Parameter field must be initialized in a user's class (custom module).
Numeric types:
A spinner gets created for any numeric field. A user should specify spinner values:
- step;
- minimum value;
- maximum value.
Otherwise, default values will be used:
- step = 1;
- minimum value = 0;
- maximum value = maximal field type value (e.g.Integer.MAX_VALUE if the field is of Integer type).
Non-numeric field types (String, Boolean, Color):
Step, minimum and maximum values for any other field type should not be specified. Even if specified, they will be ignored.
GUI elements generated for non-numeric field types:
- String - text field;
- Boolean - checkbox;
- Color - color interface.
-
Required Element Summary
Required Elements Modifier and Type Required Element Description java.lang.String
name
name displayed in UI -
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description double
maximum
maximum value for a numeric field type onlydouble
minimum
minimum value for a numeric field type onlyboolean
reloadOnChange
if true, the instrument gets reloaded after the parameter has been changeddouble
step
step value for a numeric field type only
-
Element Details
-
name
java.lang.String namename displayed in UI
-
-
-
step
double stepstep value for a numeric field type only- Default:
- 1.0
-
minimum
double minimumminimum value for a numeric field type only- Default:
- 0.0/0.0
-
maximum
double maximummaximum value for a numeric field type only- Default:
- 0.0/0.0
-
reloadOnChange
boolean reloadOnChangeif true, the instrument gets reloaded after the parameter has been changed- Default:
- true
-