public interface ISettingsUtils
ISetting
.
An instance of ISettingsBean
can be acquired by IModEnv.initSettingsBean(String, java.util.List)
.
ISettingsGui
,
IModEnv.initSettingsBean(String, java.util.List)
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>> |
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>> |
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<?>> |
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<?>> |
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 . |
IBoolSetting newBoolSetting(java.lang.String id, ISetting<?> parent, ISettingsGroup group, ISkillLevel skillLevel, java.lang.String name, IViewHints viewHints, java.lang.Boolean defaultValue)
IBoolSetting
.id
- setting idparent
- parent setting to be added togroup
- settings group this setting belongs to (within a setting node page)skillLevel
- setting skill levelname
- setting nameviewHints
- optional view hints of the settingdefaultValue
- default setting valueIBoolSetting
<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)
IEnumSetting
.T
- setting value type; it has to be an enum typeid
- setting idparent
- parent setting to be added togroup
- settings group this setting belongs to (within a setting node page)skillLevel
- setting skill levelname
- setting nameviewHints
- optional view hints of the settingdefaultValue
- default setting valueIEnumSetting
<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)
IFixedEnumValuesSetting
.T
- setting value type; it has to be an enum typeid
- setting idparent
- parent setting to be added togroup
- settings group this setting belongs to (within a setting node page)skillLevel
- setting skill levelname
- setting nameviewHints
- optional view hints of the settingdefaultValue
- default setting valuevalues
- valid values of the settingIFixedEnumValuesSetting
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)
IFixedIntValuesSetting
.id
- setting idparent
- parent setting to be added togroup
- settings group this setting belongs to (within a setting node page)skillLevel
- setting skill levelname
- setting nameviewHints
- optional view hints of the settingdefaultValue
- default setting valuevalues
- valid values of the settingIFixedIntValuesSetting
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)
IIntSetting
.id
- setting idparent
- parent setting to be added togroup
- settings group this setting belongs to (within a setting node page)skillLevel
- setting skill levelname
- setting nameviewHints
- optional view hints of the settingdefaultValue
- default setting valueminValue
- valid min valuemaxValue
- valid max valueIIntSetting
IMultilineStringSetting newMultilineStringSetting(java.lang.String id, ISetting<?> parent, ISettingsGroup group, ISkillLevel skillLevel, java.lang.String name, IViewHints viewHints, java.lang.String defaultValue)
IMultilineStringSetting
.id
- setting idparent
- parent setting to be added togroup
- settings group this setting belongs to (within a setting node page)skillLevel
- setting skill levelname
- setting nameviewHints
- optional view hints of the settingdefaultValue
- default setting valueIMultilineStringSetting
INodeSetting newNodeSetting(java.lang.String id, ISetting<?> parent, java.lang.String name, IRIcon ricon)
INodeSetting
.id
- setting idparent
- parent setting to be added toname
- setting namericon
- setting riconINodeSetting
IPathSetting newPathSetting(java.lang.String id, ISetting<?> parent, ISettingsGroup group, ISkillLevel skillLevel, java.lang.String name, IViewHints viewHints, java.nio.file.Path defaultValue)
IPathSetting
.id
- setting idparent
- parent setting to be added togroup
- settings group this setting belongs to (within a setting node page)skillLevel
- setting skill levelname
- setting nameviewHints
- optional view hints of the settingdefaultValue
- default setting valueIPathSetting
IStringSetting newStringSetting(java.lang.String id, ISetting<?> parent, ISettingsGroup group, ISkillLevel skillLevel, java.lang.String name, IViewHints viewHints, java.lang.String defaultValue)
IStringSetting
.id
- setting idparent
- parent setting to be added togroup
- settings group this setting belongs to (within a setting node page)skillLevel
- setting skill levelname
- setting nameviewHints
- optional view hints of the settingdefaultValue
- default setting valueIStringSetting
IValidatedStringSetting newValidatedStringSetting(java.lang.String id, ISetting<?> parent, ISettingsGroup group, ISkillLevel skillLevel, java.lang.String name, IViewHints viewHints, java.lang.String defaultValue)
IValidatedStringSetting
.id
- setting idparent
- parent setting to be added togroup
- settings group this setting belongs to (within a setting node page)skillLevel
- setting skill levelname
- setting nameviewHints
- optional view hints of the settingdefaultValue
- default setting valueIValidatedStringSetting
ITemplateSetting newTemplateSetting(java.lang.String id, ISetting<?> parent, ISettingsGroup group, ISkillLevel skillLevel, java.lang.String name, IViewHints viewHints, java.lang.String defaultValue)
ITemplateSetting
.id
- setting idparent
- parent setting to be added togroup
- settings group this setting belongs to (within a setting node page)skillLevel
- setting skill levelname
- setting nameviewHints
- optional view hints of the settingdefaultValue
- default setting valueITemplateSetting
IValidatedMultilineStringSetting newValidatedMultilineStringSetting(java.lang.String id, ISetting<?> parent, ISettingsGroup group, ISkillLevel skillLevel, java.lang.String name, IViewHints viewHints, java.lang.String defaultValue)
IValidatedMultilineStringSetting
.id
- setting idparent
- parent setting to be added togroup
- settings group this setting belongs to (within a setting node page)skillLevel
- setting skill levelname
- setting nameviewHints
- optional view hints of the settingdefaultValue
- default setting valueIValidatedMultilineStringSetting
ISettingsGroup newSettingsGroup(java.lang.String name)
ISettingsGroup
.name
- name of the settings groupISettingsGroup
ISettingsGroup newSettingsGroup(java.lang.String name, IRHtml helpRhtml)
ISettingsGroup
.name
- name of the settings grouphelpRhtml
- help HTML resource of the settings groupISettingsGroup
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)
IViewHints
. For easy creation of instances, see the View hints builder
class.ricon
- setting riconsubsequentText
- subsequent text of the setting componentrhtml
- help HTML resource of the settingdialogTitle
- dialog titlessCompFactory
- custom subsequent component factorycompConfigurer
- setting component configurereditRequiresRegistration
- tells if editing the setting requires registrationrows
- the rows count to be used for the setting component if supportedcolumns
- the columns count to be used for the setting component if supportedIViewHints
IVHB
,
newVHB()
IVHB newVHB()
IVHB
, an IViewHints
builder class.IVHB
, an IViewHints
builder class<T extends ISetting<?>> ITestBtnFactory<T> newTestBtnFactory(ITestBtnListener<T> listener)
ITestBtnFactory
with default text and icon which calls the specified listener when created test buttons are pressed.T
- setting type to create custom subsequent components forlistener
- ITestBtnListener
to be called when the test setting button is pressedITestBtnFactory
<T extends ISetting<?>> ITestBtnFactory<T> newTestBtnFactory(java.lang.String text, javax.swing.Icon icon, ITestBtnListener<T> listener)
ITestBtnFactory
with default text and icon which calls the specified listener when created test buttons are pressed.T
- setting type to create custom subsequent components fortext
- optional text of the test button that will be created; defaults to "Test"
icon
- optional icon of the test button that will be createdlistener
- ITestBtnListener
to be called when the test setting button is pressedITestBtnFactory
ITestBtnFactory<IStringSetting> newHostCheckTestBtnFactory()
ITestBtnFactory
whose created test buttons check whether the setting value of the IStringSetting
as a host is reachable.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.