net.sf.sdedit.ui.components.configuration
Annotation Type Adjustable

@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface Adjustable

This annotation is intended for write methods of Bean subclasses. If a write method is annotated, its corresponding property is declared to be "adjustable", i. e., it will be loaded and stored when a Bean object is loaded/stored, and it can be configured by user interaction, when the Bean object is the model of a ConfigurationUI.

Author:

Markus Strauch

Required Element Summary

String	category The name of the category to which a property belongs.
String	info A string that informs about the adjustable property, used by ConfigurationUI in order to describe the property to a user.

Optional Element Summary

String[]	choices An array of possible values for a String property.
String	depends A comma-separated list of name-value-pairs, separated by '=' or '!
int	dflt The default value of a number property.
boolean	editable Flag denoting if the property is editable
boolean	forceComboBox
int	gap
String	key A string used for sorting the properties.
int	max The maximum value of a number property.
int	min The minimum value of a number property.
boolean	openFile Only relevant for File properties, denotes whether the file is to be opened or to be written to.
int	step The value that is added to/taken from a number property when it is increased/decreased.
boolean	stringSelectionProvided Flag denoting if the potential values of the (String) property must be from a list provided by a StringSelectionProvider.
String	tooltip

Element Detail

info

public abstract String info

A string that informs about the adjustable property, used by ConfigurationUI in order to describe the property to a user.

Returns:

a string that informs about the adjustable property

category

public abstract String category

The name of the category to which a property belongs.

Returns:

the name of the category to which a property belongs

min

public abstract int min

The minimum value of a number property.

Returns:

the minimum value of a number property

Default:

-2147483648

step

public abstract int step

The value that is added to/taken from a number property when it is increased/decreased.

Returns:

the value that is added to/taken from a number property when it is increased/decreased

Default:

1

max

public abstract int max

The maximum value of a number property.

Returns:

the maximum value of a number property

Default:

2147483647

dflt

public abstract int dflt

The default value of a number property.

Returns:

the default value of a number property

Default:

0

editable

public abstract boolean editable

Flag denoting if the property is editable

Returns:

flag denoting if the property is editable

Default:

true

choices

public abstract String[] choices

An array of possible values for a String property.

Returns:

an array of possible values for a String property

Default:

{}

stringSelectionProvided

public abstract boolean stringSelectionProvided

Flag denoting if the potential values of the (String) property must be from a list provided by a StringSelectionProvider.

Returns:

flag denoting if the potential values of the (String) property must be from a list provided by a StringSelectionProvider.

Default:

false

depends

public abstract String depends

A comma-separated list of name-value-pairs, separated by '=' or '!=', representing that this adjustable property is enabled if and only if all of the equations are satisfied. The name in an (in-)equation stands for a property, and the value is a boolean (true or false) denoting if the property's configurator is enabled.

Returns:

a comma-separated string consisting of assignments to properties that must hold, otherwise this property is not editable

Default:

""

openFile

public abstract boolean openFile

Only relevant for File properties, denotes whether the file is to be opened or to be written to.

Returns:

a flag denoting if the file to be opened or to be written to

Default:

true

key

public abstract String key

A string used for sorting the properties. If it is empty, the name of the property is used as the key.

Returns:

a string used for sorting the properties

Default:

""

forceComboBox

public abstract boolean forceComboBox

Default:

false

tooltip

public abstract String tooltip

Default:

""

gap

public abstract int gap

Default:

1