Package | Description |
---|---|
hu.scelightapi |
Scelight external module API.
Some base class and interface is placed in the hu.scelightapibase
package. |
hu.scelightapi.bean.settings.type |
Different setting type interfaces.
|
hu.scelightapi.gui.setting |
Swing GUI interface for settings visualization and edit for the application.
|
hu.scelightapibase.bean.settings |
Settings bean interface.
|
hu.scelightapibase.bean.settings.type |
Different setting type interfaces.
|
hu.scelightapibase.bean.settings.type.viewhints |
View hints interface for settings.
|
Modifier and Type | Method and Description |
---|---|
ISettingsBean |
IModEnv.initSettingsBean(java.lang.String name,
java.util.List<ISetting<?>> validSettingList)
Creates a new
ISettingsBean and initializes it. |
Modifier and Type | Interface and Description |
---|---|
interface |
ITemplateSetting
A name template setting.
|
interface |
IValidatedMultilineStringSetting
A validated multi-line string setting.
|
Modifier and Type | Method and Description |
---|---|
<T extends ISetting<?>> |
ISettingsUtils.newTestBtnFactory(ITestBtnListener<T> listener)
Creates a new
ITestBtnFactory with default text and icon which calls the specified listener when created test buttons are pressed. |
<T extends ISetting<?>> |
ISettingsUtils.newTestBtnFactory(java.lang.String text,
javax.swing.Icon icon,
ITestBtnListener<T> listener)
Creates a new
ITestBtnFactory with default text and icon which calls the specified listener when created test buttons are pressed. |
Modifier and Type | Method and Description |
---|---|
void |
ISettingsGui.checkRegistration(ISetting<?> setting,
javax.swing.JComponent settingComponent)
Checks if editing the specified setting requires registration and if so and registration is not OK, disables the specified setting component and sets a
tool tip to it stating that editing it requires registration.
|
IBoolSetting |
ISettingsUtils.newBoolSetting(java.lang.String id,
ISetting<?> parent,
ISettingsGroup group,
ISkillLevel skillLevel,
java.lang.String name,
IViewHints viewHints,
java.lang.Boolean defaultValue)
Creates a new
IBoolSetting . |
<T extends java.lang.Enum<T>> |
ISettingsUtils.newEnumSetting(java.lang.String id,
ISetting<?> parent,
ISettingsGroup group,
ISkillLevel skillLevel,
java.lang.String name,
IViewHints viewHints,
T defaultValue)
Creates a new
IEnumSetting . |
<T extends java.lang.Enum<T>> |
ISettingsUtils.newFixedEnumValuesSetting(java.lang.String id,
ISetting<?> parent,
ISettingsGroup group,
ISkillLevel skillLevel,
java.lang.String name,
IViewHints viewHints,
T defaultValue,
T... values)
Creates a new
IFixedEnumValuesSetting . |
IFixedIntValuesSetting |
ISettingsUtils.newFixedIntValuesSetting(java.lang.String id,
ISetting<?> parent,
ISettingsGroup group,
ISkillLevel skillLevel,
java.lang.String name,
IViewHints viewHints,
java.lang.Integer defaultValue,
java.lang.Integer... values)
Creates a new
IFixedIntValuesSetting . |
IIntSetting |
ISettingsUtils.newIntSetting(java.lang.String id,
ISetting<?> parent,
ISettingsGroup group,
ISkillLevel skillLevel,
java.lang.String name,
IViewHints viewHints,
java.lang.Integer defaultValue,
java.lang.Integer minValue,
java.lang.Integer maxValue)
Creates a new
IIntSetting . |
IMultilineStringSetting |
ISettingsUtils.newMultilineStringSetting(java.lang.String id,
ISetting<?> parent,
ISettingsGroup group,
ISkillLevel skillLevel,
java.lang.String name,
IViewHints viewHints,
java.lang.String defaultValue)
Creates a new
IMultilineStringSetting . |
INodeSetting |
ISettingsUtils.newNodeSetting(java.lang.String id,
ISetting<?> parent,
java.lang.String name,
IRIcon ricon)
Creates a new
INodeSetting . |
IPathSetting |
ISettingsUtils.newPathSetting(java.lang.String id,
ISetting<?> parent,
ISettingsGroup group,
ISkillLevel skillLevel,
java.lang.String name,
IViewHints viewHints,
java.nio.file.Path defaultValue)
Creates a new
IPathSetting . |
IStringSetting |
ISettingsUtils.newStringSetting(java.lang.String id,
ISetting<?> parent,
ISettingsGroup group,
ISkillLevel skillLevel,
java.lang.String name,
IViewHints viewHints,
java.lang.String defaultValue)
Creates a new
IStringSetting . |
ITemplateSetting |
ISettingsUtils.newTemplateSetting(java.lang.String id,
ISetting<?> parent,
ISettingsGroup group,
ISkillLevel skillLevel,
java.lang.String name,
IViewHints viewHints,
java.lang.String defaultValue)
Creates a new
ITemplateSetting . |
IValidatedMultilineStringSetting |
ISettingsUtils.newValidatedMultilineStringSetting(java.lang.String id,
ISetting<?> parent,
ISettingsGroup group,
ISkillLevel skillLevel,
java.lang.String name,
IViewHints viewHints,
java.lang.String defaultValue)
Creates a new
IValidatedMultilineStringSetting . |
IValidatedStringSetting |
ISettingsUtils.newValidatedStringSetting(java.lang.String id,
ISetting<?> parent,
ISettingsGroup group,
ISkillLevel skillLevel,
java.lang.String name,
IViewHints viewHints,
java.lang.String defaultValue)
Creates a new
IValidatedStringSetting . |
Modifier and Type | Method and Description |
---|---|
void |
ISettingsGui.addBindExecuteScl(ISettingChangeListener scl,
ISettingsBean settings,
java.util.Set<? extends ISetting<?>> settingSet,
javax.swing.JComponent comp)
Adds the specified
ISettingChangeListener to the specified ISettingsBean for the specified settings, and binds it to the specified
component. |
void |
ISettingsGui.bindScl(ISettingChangeListener scl,
ISettingsBean settings,
java.util.Set<? extends ISetting<?>> settingSet,
javax.swing.JComponent comp)
Binds the specified
ISettingChangeListener to the specified component. |
IViewHints |
ISettingsUtils.newViewHints(IRIcon ricon,
java.lang.String subsequentText,
IRHtml rhtml,
java.lang.String dialogTitle,
ISsCompFactory<ISetting<?>> ssCompFactory,
ICompConfigurer compConfigurer,
boolean editRequiresRegistration,
java.lang.Integer rows,
java.lang.Integer columns)
Creates a new
IViewHints . |
Modifier and Type | Method and Description |
---|---|
java.util.List<ISetting<?>> |
ISettingsBean.getValidSettingList()
Returns the list of valid settings that this settings bean is used for.
|
Modifier and Type | Method and Description |
---|---|
void |
ISettingsBean.addAndExecuteChangeListener(ISetting<?> setting,
ISettingChangeListener listener)
Adds a new setting change listener and executes it.
|
void |
ISettingsBean.addChangeListener(ISetting<?> setting,
ISettingChangeListener listener)
Adds a new setting change listener.
|
boolean |
ISettingChangeEvent.affected(ISetting<?> setting)
Tells if the specified setting is affected by the setting change event.
|
boolean |
ISettingChangeEvent.affectedAny(ISetting<?>... settings)
Tells if any of the specified settings is affected by the setting change event.
|
<T> T |
ISettingsBean.get(ISetting<T> setting)
Returns the value of the specified setting.
|
<T> T |
ISettingChangeEvent.get(ISetting<T> setting)
Returns the value of the specified setting.
|
void |
ISettingsBean.removeChangeListener(ISetting<?> setting,
ISettingChangeListener listener)
Removes a setting change listener.
|
void |
ISettingsBean.reset(ISetting<?> setting)
Resets the value of the specified setting, restores the default value of the specified setting.
A setting is reset by removing its value (in which case when queried, the default value will be returned). |
<T> void |
ISettingsBean.set(ISetting<T> setting,
T value)
Sets the value of a setting.
|
Modifier and Type | Method and Description |
---|---|
void |
ISettingsBean.addAndExecuteChangeListener(java.util.Set<? extends ISetting<?>> settingSet,
ISettingChangeListener listener)
Adds a new setting change listener and executes it.
|
void |
ISettingsBean.addChangeListener(java.util.Set<? extends ISetting<?>> settingSet,
ISettingChangeListener listener)
Adds a new setting change listener.
|
void |
ISettingsBean.removeChangeListener(java.util.Set<? extends ISetting<?>> settingSet,
ISettingChangeListener listener)
Removes a setting change listener.
|
Modifier and Type | Interface and Description |
---|---|
interface |
IBoolSetting
A boolean setting.
|
interface |
IEnumSetting<T extends java.lang.Enum<T>>
Enum setting, the valid values are all the enum constants of the specified type, the value of the setting can only be one of the enum values.
|
interface |
IFixedEnumValuesSetting<T extends java.lang.Enum<T>>
Fixed enum values setting, the value of the setting can only be one of a predefined enum values.
|
interface |
IFixedIntValuesSetting
Fixed int values setting, the value of the setting can only be one of a predefined int values.
|
interface |
IFixedValuesSetting<T>
Fixed values setting, the value of the setting can only be one of a predefined values.
|
interface |
IIntSetting
An integer setting with a valid range.
|
interface |
IMultilineStringSetting
A multi-line string setting.
|
interface |
INodeSetting
A setting which is used only as a node in the navigation tree.
|
interface |
IPathSetting
A path setting.
|
interface |
IStringSetting
A string setting.
|
interface |
IValidatedStringSetting
A validated string setting.
|
Modifier and Type | Method and Description |
---|---|
ISetting<?> |
ISetting.getParent()
Returns the optional parent setting.
|
Modifier and Type | Method and Description |
---|---|
java.util.Set<? extends ISetting<T>> |
ISetting.selfSet()
Returns an unmodifiable set containing only
this . |
Modifier and Type | Method and Description |
---|---|
void |
ISetting.addChild(ISetting<?> setting)
Adds a child setting to this setting.
|
Modifier and Type | Method and Description |
---|---|
void |
ISetting.getSettingPath(java.util.List<ISetting<?>> settingList)
Returns the setting path assembled in the specified list.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ISsCompFactory<T extends ISetting<?>>
Factory interface to create custom subsequent components for settings visualization / edit.
|
interface |
ITestBtnFactory<T extends ISetting<?>>
An
ISsCompFactory extension which creates test IButton subsequent components. |
interface |
ITestBtnListener<T extends ISetting<?>>
A listener which is called when a test button subsequent component created by the
ITestBtnFactory is clicked. |
Modifier and Type | Method and Description |
---|---|
ISsCompFactory<ISetting<?>> |
IViewHints.getSsCompFactory()
Returns the custom subsequent component factory.
|
Modifier and Type | Method and Description |
---|---|
void |
ICompConfigurer.configure(javax.swing.JComponent settingComp,
ISetting<?> setting,
ISettingsBean settings)
Configures the setting component.
|
Modifier and Type | Method and Description |
---|---|
IVHB |
IVHB.ssCompFactory(ISsCompFactory<? extends ISetting<?>> ssCompFactory)
Sets the custom subsequent component factory.
|
This API documentation is public and is intended for / allowed to be used by anyone.
Scelight home page: https://sites.google.com/site/scelight/
Scelight is a trademark of András Belicza. Copyright © András Belicza, 2013-2015. All rights reserved.