ISettingsUtils (External Module API 1.5.2 Documentation

```
public interface ISettingsUtils
```
Settings utilities for creating setting interface instances (ISetting.
An instance of ISettingsBean can be acquired by IModEnv.initSettingsBean(String, java.util.List).

Author:

Andras Belicza

See Also:
ISettingsGui, IModEnv.initSettingsBean(String, java.util.List)

Method Summary

Methods
Modifier and Type	Method and Description
`IBoolSetting`	`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>> IEnumSetting<T>`	`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>> IFixedEnumValuesSetting<T>`	`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`	`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`.
`ITestBtnFactory<IStringSetting>`	`newHostCheckTestBtnFactory()` Creates a new `ITestBtnFactory` whose created test buttons check whether the setting value of the `IStringSetting` as a host is reachable.
`IIntSetting`	`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`	`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`	`newNodeSetting(java.lang.String id, ISetting<?> parent, java.lang.String name, IRIcon ricon)` Creates a new `INodeSetting`.
`IPathSetting`	`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`.
`ISettingsGroup`	`newSettingsGroup(java.lang.String name)` Creates a new `ISettingsGroup`.
`ISettingsGroup`	`newSettingsGroup(java.lang.String name, IRHtml helpRhtml)` Creates a new `ISettingsGroup`.
`IStringSetting`	`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`	`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`.
`<T extends ISetting<?>> ITestBtnFactory<T>`	`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<?>> ITestBtnFactory<T>`	`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.
`IValidatedMultilineStringSetting`	`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`	`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`.
`IVHB`	`newVHB()` Creates a new `IVHB`, an `IViewHints` builder class.
`IViewHints`	`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`.

Method Detail

newBoolSetting

IBoolSetting 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.

Parameters:: id - setting id; parent - parent setting to be added to; group - settings group this setting belongs to (within a setting node page); skillLevel - setting skill level; name - setting name; viewHints - optional view hints of the setting; defaultValue - default setting value
Returns:: a new IBoolSetting

newEnumSetting

<T extends java.lang.Enum<T>> IEnumSetting<T> newEnumSetting(java.lang.String id,
                                                           ISetting<?> parent,
                                                           ISettingsGroup group,
                                                           ISkillLevel skillLevel,
                                                           java.lang.String name,
                                                           IViewHints viewHints,
                                                           T defaultValue)

Creates a new IEnumSetting.

Type Parameters:: T - setting value type; it has to be an enum type
Parameters:: id - setting id; parent - parent setting to be added to; group - settings group this setting belongs to (within a setting node page); skillLevel - setting skill level; name - setting name; viewHints - optional view hints of the setting; defaultValue - default setting value
Returns:: a new IEnumSetting

newFixedEnumValuesSetting

<T extends java.lang.Enum<T>> IFixedEnumValuesSetting<T> 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.

Type Parameters:: T - setting value type; it has to be an enum type
Parameters:: id - setting id; parent - parent setting to be added to; group - settings group this setting belongs to (within a setting node page); skillLevel - setting skill level; name - setting name; viewHints - optional view hints of the setting; defaultValue - default setting value; values - valid values of the setting
Returns:: a new IFixedEnumValuesSetting

newFixedIntValuesSetting

IFixedIntValuesSetting 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.

Parameters:: id - setting id; parent - parent setting to be added to; group - settings group this setting belongs to (within a setting node page); skillLevel - setting skill level; name - setting name; viewHints - optional view hints of the setting; defaultValue - default setting value; values - valid values of the setting
Returns:: a new IFixedIntValuesSetting

newIntSetting

IIntSetting 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.

Parameters:: id - setting id; parent - parent setting to be added to; group - settings group this setting belongs to (within a setting node page); skillLevel - setting skill level; name - setting name; viewHints - optional view hints of the setting; defaultValue - default setting value; minValue - valid min value; maxValue - valid max value
Returns:: a new IIntSetting

newMultilineStringSetting

IMultilineStringSetting 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.

Parameters:: id - setting id; parent - parent setting to be added to; group - settings group this setting belongs to (within a setting node page); skillLevel - setting skill level; name - setting name; viewHints - optional view hints of the setting; defaultValue - default setting value
Returns:: a new IMultilineStringSetting

newNodeSetting

INodeSetting newNodeSetting(java.lang.String id,
                          ISetting<?> parent,
                          java.lang.String name,
                          IRIcon ricon)

Creates a new INodeSetting.

Parameters:: id - setting id; parent - parent setting to be added to; name - setting name; ricon - setting ricon
Returns:: a new INodeSetting

newPathSetting

IPathSetting 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.

Parameters:: id - setting id; parent - parent setting to be added to; group - settings group this setting belongs to (within a setting node page); skillLevel - setting skill level; name - setting name; viewHints - optional view hints of the setting; defaultValue - default setting value
Returns:: a new IPathSetting

newStringSetting

IStringSetting 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.

Parameters:: id - setting id; parent - parent setting to be added to; group - settings group this setting belongs to (within a setting node page); skillLevel - setting skill level; name - setting name; viewHints - optional view hints of the setting; defaultValue - default setting value
Returns:: a new IStringSetting

newValidatedStringSetting

IValidatedStringSetting 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.

Parameters:: id - setting id; parent - parent setting to be added to; group - settings group this setting belongs to (within a setting node page); skillLevel - setting skill level; name - setting name; viewHints - optional view hints of the setting; defaultValue - default setting value
Returns:: a new IValidatedStringSetting

newTemplateSetting

ITemplateSetting 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.

Parameters:: id - setting id; parent - parent setting to be added to; group - settings group this setting belongs to (within a setting node page); skillLevel - setting skill level; name - setting name; viewHints - optional view hints of the setting; defaultValue - default setting value
Returns:: a new ITemplateSetting

newValidatedMultilineStringSetting

IValidatedMultilineStringSetting 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.

Parameters:: id - setting id; parent - parent setting to be added to; group - settings group this setting belongs to (within a setting node page); skillLevel - setting skill level; name - setting name; viewHints - optional view hints of the setting; defaultValue - default setting value
Returns:: a new IValidatedMultilineStringSetting
Since:: 1.4

newSettingsGroup
```
ISettingsGroup newSettingsGroup(java.lang.String name)
```
Creates a new ISettingsGroup.

Parameters:
name - name of the settings group

Returns:
a new ISettingsGroup

newSettingsGroup
```
ISettingsGroup newSettingsGroup(java.lang.String name,
                              IRHtml helpRhtml)
```
Creates a new ISettingsGroup.

Parameters:
name - name of the settings group
helpRhtml - help HTML resource of the settings group

Returns:
a new ISettingsGroup

newViewHints
```
IViewHints 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. For easy creation of instances, see the View hints builder class.

Parameters:
ricon - setting ricon
subsequentText - subsequent text of the setting component
rhtml - help HTML resource of the setting
dialogTitle - dialog title
ssCompFactory - custom subsequent component factory
compConfigurer - setting component configurer
editRequiresRegistration - tells if editing the setting requires registration
rows - the rows count to be used for the setting component if supported
columns - the columns count to be used for the setting component if supported

Returns:
a new IViewHints
See Also:
IVHB, newVHB()

newVHB
```
IVHB newVHB()
```
Creates a new IVHB, an IViewHints builder class.

Returns:
a new IVHB, an IViewHints builder class

newTestBtnFactory
```
<T extends ISetting<?>> ITestBtnFactory<T> newTestBtnFactory(ITestBtnListener<T> listener)
```
Creates a new ITestBtnFactory with default text and icon which calls the specified listener when created test buttons are pressed.

Type Parameters:
T - setting type to create custom subsequent components for
Parameters:
listener - ITestBtnListener to be called when the test setting button is pressed

Returns:
a new ITestBtnFactory

newTestBtnFactory
```
<T extends ISetting<?>> ITestBtnFactory<T> 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.

Type Parameters:
T - setting type to create custom subsequent components for
Parameters:
text - optional text of the test button that will be created; defaults to "Test"
icon - optional icon of the test button that will be created
listener - ITestBtnListener to be called when the test setting button is pressed

Returns:
a new ITestBtnFactory

newHostCheckTestBtnFactory
```
ITestBtnFactory<IStringSetting> newHostCheckTestBtnFactory()
```
Creates a new ITestBtnFactory whose created test buttons check whether the setting value of the IStringSetting as a host is reachable.

Returns:
a new ITestBtnFactory

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.

Interface ISettingsUtils