SettingsComponent

abstract class SettingsComponent<S : Settings<S, T>, T : Scheme<T>>(settings: S) : SettingsManager<S>

A component that allows the user to edit settings and its corresponding schemes.

Subclasses MUST call loadSettings in their constructor.

There are multiple settings S instances at any time. The settings given in the constructor is read when the component is created and is written to when the user saves its changes. The currently-selected scheme is loaded into the component's inputs. When the user selects a different scheme of which to change its values, the values in the input fields are stored in a copy of settings. This way, the local changes are not lost when switching between schemes, and the user can still revert all unsaved changes if desired.

Parameters

the type of settings to manage

the type of scheme to manage

settings

the settings to manage

Constructors

SettingsComponent

fun <S : Settings<S, T>> SettingsComponent(settings: S)

the type of settings to manage

Functions

doValidate

abstract fun doValidate(): ValidationInfo?

Validates all input fields.

isModified

fun isModified(): Boolean

Returns true if this component contains unsaved changes.

open fun isModified(settings: S): Boolean

Returns true if this component contains unsaved changes.

loadScheme

abstract fun loadScheme(scheme: T)

Loads the given scheme into the component's state.

loadSettings

override fun loadSettings()

Loads the default settings object.

override fun loadSettings(settings: S)

Loads settings.

reset

fun reset()

Discards unsaved changes.

saveScheme

abstract fun saveScheme(scheme: T)

Saves the component's state into the given scheme.

saveSettings

override fun saveSettings()

Saves settings to the default settings object.

override fun saveSettings(settings: S)

Saves settings to settings.

Properties

rootPane

abstract val rootPane: JPanel?

The panel containing the settings.

schemesPanel

abstract val schemesPanel: SchemesPanel<T>

The panel containing the dropdown box of schemes and action buttons to rename, delete, etc.

unsavedSettings

abstract val unsavedSettings: S

The local copy that represents the currently-unsaved settings that are being edited by the user.

Inheritors

ArraySettingsComponent

DecimalSettingsComponent

IntegerSettingsComponent

StringSettingsComponent

UuidSettingsComponent

WordSettingsComponent

Sources

jvm source