public interface ConfigConstants
Modifier and Type | Field and Description |
---|---|
static int |
BLOCKWISE_SAVING
Saving is delayed until at least a certain number of
changes is propagated.
|
static java.lang.String |
DESCRIPTION_KEY
Used for localization to retrieve a description text.
|
static java.lang.String |
DISPLAY_MODE
Hint for any config-gui on how to display this group in a
config dialog.
|
static int |
ENTRY_HIDDEN
Hint for config-guis that an entry or group should not be displayed
|
static int |
ENTRY_LOCKED
Signals that the given entry or group should not be
modified by general modification methods.
|
static int |
ENTRY_MODIFIABLE
Hint for config-guis that an entry or group should not be
displayed as editable.
|
static java.lang.String |
EXCLUSIVE
Should be set when using the
ConfigRegistry.exclusiveRangeFilter defined
in ConfigRegistry . |
static java.lang.String |
FILE_TYPE
Used for configuring dialogs for file properties.
|
static java.lang.String |
FOLDER_TYPE
Used for configuring dialogs for file properties.
|
static int |
GROUP_VIRTUAL
Signals that the given group should not be treated
as a regular group when it comes to laying out related
gui components but as an item.
|
static java.lang.String |
HANDLER
Handler object for this entry that is responsible for
providing an UI object.
|
static int |
IMMEDIATE_SAVING
Every change propagated to this storage will trigger
a complete save of the stored data.
|
static java.lang.String |
INDENT
The entry should be displayed indented relative to its neighbors.
|
static java.lang.String |
INLINE
Tells a config-gui to layout this item without
any kind of separation towards its parent.
|
static java.lang.String |
ITEM_TYPE
For list and or map config entries this defines the type of
the elements (list) or values(map).
|
static int |
MANUAL_SAVING
Saving is omitted until manually done via a call to
ConfigStorage#commit() |
static java.lang.String |
MAX_ITEM_COUNT
Upper bound for the number of item in a modifiable
entry of type
EntryType#LIST or EntryType#MAP . |
static java.lang.String |
MAX_LENGTH
Used for items whose value type is
String to
determine the maximum number of characters allowed. |
static java.lang.String |
MAX_VALUE
Used by
ConfigRegistry.ValueFilter objects to
restrict an upper numerical bound. |
static java.lang.String |
MIN_ITEM_COUNT
Lower bound for the number of item in a modifiable
entry of type
EntryType#LIST or EntryType#MAP . |
static java.lang.String |
MIN_VALUE
Used by
ConfigRegistry.ValueFilter objects to
restrict a lower numerical bound. |
static java.lang.String |
MODE_GRID
Children should be layed out in a grid oriented
way, depending on the orientation of this group
(default should be vertical).
|
static java.lang.String |
MODE_LIST
Children should be layed out as a simple list
one after another following the orientation of this
group if any is set (default should be vertical).
|
static java.lang.String |
MODE_TABBED
Arrange children as tabs where every subgroup gets
its own tab and entries of this group be layed out
after (below) the tabs.
|
static java.lang.String |
MODE_TREE
Generate a tree view of this group and all its subgroups.
|
static java.lang.String |
MULTILINE
Used for items whose value type is
String to
signal that a text area or some other kind of multiline
input field should be used. |
static java.lang.String |
NAME_KEY
Used for localization to retrieve the actual string
to be displayed as name of this item.
|
static java.lang.String |
NOTE_KEY
Used for localization to retrieve a note text that should be
displayed next to the given entry or group to signal the user
important facts.
|
static java.lang.String |
OPTIONS
An enumeration of legal values used for CHOICE entries.
|
static java.lang.String |
OPTIONS_KEYS
Contains the objects to be displayed in a config-gui
instead of the values in
OPTIONS . |
static java.lang.String |
ORIENTATION
Layout information, legal values are the constants
SwingConstants#HORIZONTAL and
SwingConstants#VERTICAL (the default). |
static java.lang.String |
PATTERN
Used by
ConfigRegistry.ValueFilter objects that restrict
textual input. |
static java.lang.String |
PATTERN_DESCRIPTION_KEY
This is an optional addition to entries representing text with
a pattern applied to them.
|
static int |
PERIODIC_SAVING
Saving is done on a regular basis with fixed intervals.
|
static java.lang.String |
PRECISION
Hint for config-guis what precision to be used
for e.g.
|
static java.lang.String |
RENDERER
Holds a renderer that should be used to render
JList or
JComboBox entries. |
static java.lang.String |
SEPARATED
Tells a config-gui to place some kind of separator between
this item and the one added right before it.
|
static final int ENTRY_HIDDEN
static final int ENTRY_MODIFIABLE
static final int ENTRY_LOCKED
static final int GROUP_VIRTUAL
static final int MANUAL_SAVING
ConfigStorage#commit()
static final int IMMEDIATE_SAVING
static final int BLOCKWISE_SAVING
static final int PERIODIC_SAVING
static final java.lang.String INLINE
For a virtual group this would mean it should not be
surrounded by a border.
The type of this property's value is Boolean
static final java.lang.String SEPARATED
This property can be ignored if separation would make no sense,
e.g. if the item is the first inside a group or the element
before it already features some kind of visual separator.
The type of this property's value is Boolean
static final java.lang.String MULTILINE
String
to
signal that a text area or some other kind of multiline
input field should be used.
The type of this property's value is Boolean
static final java.lang.String MAX_LENGTH
String
to
determine the maximum number of characters allowed.
The type of this property's value is Integer
static final java.lang.String HANDLER
EntryHandler
or
MapHandler
.static final java.lang.String RENDERER
JList
or
JComboBox
entries.
Note: This practically overrides any attempts made in terms of
optimization regarding the type of components used to display
this entry. If the type of this config item is EntryType.OPTIONS
it would normally be possible to use radio buttons or a JComboBox
as components. With a non-null RENDERER
set there must be used
a JComboBox
!
The type of this property's value is ListCellRenderer
.
static final java.lang.String ORIENTATION
SwingConstants#HORIZONTAL
and
SwingConstants#VERTICAL
(the default).
Any config-gui should lay out the direct children of
the corresponding item in this way!static final java.lang.String MIN_VALUE
ConfigRegistry.ValueFilter
objects to
restrict a lower numerical bound.
The type of this property's value is any subtype of Number
static final java.lang.String PRECISION
Number
static final java.lang.String MAX_VALUE
ConfigRegistry.ValueFilter
objects to
restrict an upper numerical bound.
The type of this property's value is any subtype ofNumber
static final java.lang.String EXCLUSIVE
ConfigRegistry.exclusiveRangeFilter
defined
in ConfigRegistry
. Signals that the upper and lower bounds
are to be excluded from the legal range of values for the given entry.
The type of this property's value is Boolean
static final java.lang.String INDENT
Boolean
static final java.lang.String PATTERN
ConfigRegistry.ValueFilter
objects that restrict
textual input.
The type of this property's value is String
or Pattern
static final java.lang.String ITEM_TYPE
ConfigRegistry.EntryType
static final java.lang.String OPTIONS
List
static final java.lang.String OPTIONS_KEYS
OPTIONS
. Typically
this list holds the localization keys for lookup.
The type of this property's value is List
static final java.lang.String MIN_ITEM_COUNT
EntryType#LIST
or EntryType#MAP
.
A config-gui should disable components related to remove
actions when the actual number of elements in the list
reaches this value.
The type of this property's value is Integer
static final java.lang.String MAX_ITEM_COUNT
EntryType#LIST
or EntryType#MAP
.
A config-gui should disable components related to add/new
actions when the actual number of elements in the list
reaches this value.
The type of this property's value is Integer
static final java.lang.String NAME_KEY
String
static final java.lang.String DESCRIPTION_KEY
String
static final java.lang.String PATTERN_DESCRIPTION_KEY
String
static final java.lang.String NOTE_KEY
String
static final java.lang.String FILE_TYPE
Boolean
static final java.lang.String FOLDER_TYPE
Boolean
static final java.lang.String DISPLAY_MODE
MODE_
.
The type of this property's value is String
static final java.lang.String MODE_TREE
static final java.lang.String MODE_TABBED
static final java.lang.String MODE_LIST
static final java.lang.String MODE_GRID