@Retention(value=SOURCE) @Target(value=FIELD) public @interface BooleanOption
static final String
compile-time constant can be marked with this
annotation. The value of the constant will be used as the key to the hint's Preferences
.
For hints that consist of a class, all options that are directly enclosed in the class
will be used in their source order.
For hints that consist of a single method, use UseOptions
to specify which options
from the enclosing class should be used. The order of the options will be the order in which
they appear in the source code of the enclosing class.
The customizer will be generated automatically when BooleanOption
is used.
Two keys need to be defined in the corresponding Bundle.properties
:
LBL_<class-fqn>.<field_name>
, which will be used as the display name of
the corresponding checkbox in the customizer, and TP_<class-fqn>.<field_name>
which will be used as the tooltip of the checkbox.Modifier and Type | Required Element and Description |
---|---|
boolean |
defaultValue
The default value of the option.
|
String |
displayName
The options' display name.
|
String |
tooltip
The tooltip of the checkbox in the customizer.
|