org.netbeans.spi.java.hints

Annotation Type IntegerOption

@Retention(value=SOURCE)
 @Target(value=FIELD)
 @Documented
public @interface IntegerOption

Declares an int-value option that affects hint processing. If the Hint mixes integer and boolean options, the integer options come first, boolean second in the UI.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	displayName

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	defaultValue
int	maxValue Maximum value for the option.
int	minValue Minimum value for the option.
int	step If non-zero, a spinner will be created with the specified step.
String	tooltip

Element Detail

displayName

public abstract String displayName

Returns:

Display name of the option

tooltip

public abstract String tooltip

Returns:

tooltip for mouse hover over the option

Default:

""

defaultValue

public abstract int defaultValue

Returns:

default value for the option

Default:

0

minValue

public abstract int minValue

Minimum value for the option. If Integer.MIN_VALUE (the default), no minimum will be enforced.

Returns:

minimum value.

Default:

0

maxValue

public abstract int maxValue

Maximum value for the option. If Integer.MAX_VALUE (the default), no maximum will be enforced. Please do choose a reasonable maximum value, as the UI may size the input box to accommodate all digits of the maximum permitted value, and the input box may seem unreasonably large.

Returns:

maximum value

Default:

2147483647

step

public abstract int step

If non-zero, a spinner will be created with the specified step. If zero (the default), a plain input will be presented. Negative values are not accepted at the moment and are reserved.

Default:

0