org.esa.snap.rcp.preferences

Annotation Type Preference

@Documented
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface Preference

Annotation for user preferences. Use is mandatory if preferences are supplied via a bean, see DefaultConfigController.createPropertySet() and DefaultConfigController.createPropertySet(Object).

See Also:

DefaultConfigController

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	key
String	label

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	config
String	description Description text (used for tooltips).
String	interval Gets the valid interval for numeric parameters, e.g.
Class<? extends Validator>	validatorClass
String[]	valueSet

Element Detail

label

public abstract String label

Returns:

The label of the property. Must not be empty.

key

public abstract String key

Returns:

The property key. Must not be empty.

config

public abstract String config

Returns:

The configuration name. If not set, the NetBeans preferences are used, otherwise preferences from a named configuration are used (Config.instance(config).preferences()).

Default:

""

valueSet

public abstract String[] valueSet

Returns:

The set of allowed values.

Default:

{}

interval

public abstract String interval

Gets the valid interval for numeric parameters, e.g. "[10,20)": in the range 10 (inclusive) to 20 (exclusive).

Returns:

The valid interval. Defaults to empty string (= not set).

Default:

""

description

public abstract String description

Description text (used for tooltips).

Default:

""

validatorClass

public abstract Class<? extends Validator> validatorClass

Returns:

The validator class.

Default:

org.esa.snap.rcp.preferences.Preference.NullValidator.class