intellij-randomness / com.fwdekker.randomness / SettingsConfigurable

SettingsConfigurable

abstract class SettingsConfigurable<S : Settings<S>> : Configurable

A configurable to change settings of type S.

Allows the settings to be displayed in IntelliJ's settings window.

Parameters

S - the type of settings the configurable changes.

Constructors

<init>

SettingsConfigurable()

A configurable to change settings of type S.

Properties

component

abstract val component: SettingsComponent<S>

The user interface for changing the settings.

Functions

apply

open fun apply(): Unit

Saves the changes in the settings component to the default settings object.

createComponent

open fun createComponent(): JComponent?

Returns the root pane of the settings component.

getDisplayName

abstract fun getDisplayName(): String

Returns the name of the configurable as displayed in the settings window.

isModified

open fun isModified(): Boolean

Returns true if the settings were modified since they were loaded.

reset

open fun reset(): Unit

Discards unsaved changes in the settings component.

Inheritors

ArraySettingsConfigurable

class ArraySettingsConfigurable : SettingsConfigurable<ArraySettings>

The configurable for array settings.

DecimalSettingsConfigurable

class DecimalSettingsConfigurable : SettingsConfigurable<DecimalSettings>

The configurable for decimal settings.

IntegerSettingsConfigurable

class IntegerSettingsConfigurable : SettingsConfigurable<IntegerSettings>

The configurable for integer settings.

StringSettingsConfigurable

class StringSettingsConfigurable : SettingsConfigurable<StringSettings>

The configurable for string settings.

UuidSettingsConfigurable

class UuidSettingsConfigurable : SettingsConfigurable<UuidSettings>

The configurable for UUID settings.

WordSettingsConfigurable

class WordSettingsConfigurable : SettingsConfigurable<WordSettings>

The configurable for word settings.