|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Retention(value=RUNTIME) @Target(value=FIELD) @Documented public @interface Parameter
Annotation definition for operator parameters.
Optional Element Summary | |
---|---|
java.lang.String[] |
choices
Defines the list of possible values (multiple choice text fields only). |
int |
columns
Defines the width of the input field in characters (text field parameters only). |
int |
dataIOOrder
Suggest order if displaying all parameters of a parametrized class e.g. in a GUI |
java.lang.String |
description
Gives a potentially verbose explanation of this field. |
Parameter.Direction |
direction
Defines the direction of this parameter |
java.lang.String |
label
Defines a label for the parameter. |
java.lang.String |
max
Defines the maximum allowed value (numeric parameters only). |
java.lang.String |
min
Defines the minimum allowed value (numeric parameters only). |
Parameter.ExpertMode |
mode
Define the mode of this parameter to be shown for generic execution |
boolean |
output
Defines if the parameter is an output. |
boolean |
persist
Defines whether to remember the most recent value of the parameter. |
java.lang.String |
persistKey
Defines a key to use for saving the value persistently. |
boolean |
required
Defines whether the parameter is required (i.e., no default). |
java.lang.String |
stepSize
Defines the step size to use (numeric parameters only). |
boolean |
supplemental
Is this parameter supplemental, i.e. does not influence the result of the operator. |
Parameter.Type |
type
Defines the type/role of this field. |
public abstract java.lang.String[] choices
public abstract int columns
public abstract int dataIOOrder
public abstract java.lang.String description
public abstract Parameter.Direction direction
public abstract java.lang.String label
public abstract java.lang.String max
public abstract java.lang.String min
public abstract Parameter.ExpertMode mode
public abstract boolean output
public abstract boolean persist
public abstract java.lang.String persistKey
public abstract boolean required
public abstract java.lang.String stepSize
public abstract boolean supplemental
public abstract Parameter.Type type
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |