org.eth.cyril.settings

Interface Setting

All Superinterfaces:

Validator

All Known Implementing Classes:

ColorSetting, CompositeSetting, FontSetting, LanguageSetting, LayoutSetting, SchemaSetting, SelectionSetting, Separator

public interface Setting
extends Validator

Denotes a setting which can be used in a setting dialogue. Settings are typically parts of the configuration, however abstracted to make them more user-friendly when editing.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Setting.DataType The type of data which this setting represents.

Method Summary

Modifier and Type	Method and Description
void	apply(java.lang.Object input) Applies the given input to this setting.
java.lang.Object	getCurrentValue() Gets the initial, current value of this setting.
Setting.DataType	getDataType() The data type which this setting represents.
java.lang.String	getId() The ID of this setting to uniquely identify the setting.
java.lang.String	getName() Gets the name to display this setting with.
default java.lang.String[]	getSelection() Gets the selection of strings that this setting may take.
java.lang.String	getTooltip() Gets the tooltip to offer more information for this setting.
boolean	requiresRestart() Returns whether changing this setting requires a restart to be performed, in order for the setting to become active.

Methods inherited from interface org.eth.cyril.util.configuration.schema.Validator

validate

Method Detail

getId

java.lang.String getId()

The ID of this setting to uniquely identify the setting.

Returns:

Unique ID of the setting.

getDataType

Setting.DataType getDataType()

The data type which this setting represents.

Returns:

The data type represented by this setting.

getCurrentValue

java.lang.Object getCurrentValue()

Gets the initial, current value of this setting. The value must be of the type denoted by the given data type.

Returns:

The initial, current value of this setting.

getName

java.lang.String getName()

Gets the name to display this setting with.

Returns:

The name to display this setting with.

getTooltip

java.lang.String getTooltip()

Gets the tooltip to offer more information for this setting. This method may return null.

Returns:

The tooltip to offer more information, or null.

apply

void apply(java.lang.Object input)

Applies the given input to this setting. The input is ensured to either be the current value, or one that validated successfully for this setting. Setting this input to null removes the setting, and will therefore apply its default value.

Parameters:

input - The input. It is either the current value of the setting, or validated successfully.

getSelection

default java.lang.String[] getSelection()

Gets the selection of strings that this setting may take. This method is only called if the getDataType() returns Setting.DataType.SELECTION. The default implementation therefore returns an empty array.

Returns:

The selection of strings for this setting. Meaningful only if this is a Setting.DataType.SELECTION.

requiresRestart

boolean requiresRestart()

Returns whether changing this setting requires a restart to be performed, in order for the setting to become active.

Returns:

Whether changing this setting requires a restart to be performed.