Package de.fraunhofer.iosb.ilt.configurable.editor

Class EditorBoolean

java.lang.Object

de.fraunhofer.iosb.ilt.configurable.editor.EditorDefault<Boolean>

de.fraunhofer.iosb.ilt.configurable.editor.EditorBoolean

All Implemented Interfaces:

ConfigEditor<Boolean>

public final class EditorBoolean
extends EditorDefault<Boolean>

An editor for boolean values.

Author:

Hylke van der Schaaf

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EditorBoolean.EdOptsBool

Field Summary

Fields

Modifier and Type	Field	Description
Set<String>	profilesEdit

Fields inherited from interface de.fraunhofer.iosb.ilt.configurable.ConfigEditor

DEFAULT_PROFILE_NAME

Constructor Summary

Constructors

Constructor	Description
EditorBoolean()
EditorBoolean(boolean deflt)
EditorBoolean(boolean deflt, String label, String description)

Method Summary

Modifier and Type	Method	Description
boolean	canEdit()	True if the component is editable in the current profile.
com.google.gson.JsonElement	getConfig()	Get the current (edited) state of the configuration.
GuiFactoryFx	getGuiFactoryFx()	Get a factory that can generate a JavaFX-based gui for this editor.
GuiFactorySwing	getGuiFactorySwing()	Get a factory that can generate a swing-based gui for this editor.
SchemaItem	getJsonSchema(RootSchema rootSchema)	Get the JSON Schema for this editor, using the given rootSchema for shared $defs.
Boolean	getRawValue()
Boolean	getValue()	Get the value configured in the editor.
void	initFor(Field field)	Initialise the editor for the given Field, using the Field name and type and any annotations present on the Field.
boolean	isDefault()
void	setConfig(com.google.gson.JsonElement config)	Load the given configuration into this editor.
void	setProfile(String profile)	Sets the currently active profile.
void	setProfilesEdit(String csv)
void	setRawValue(Boolean value)
void	setValue(Boolean value)	Set the value in the editor.

Methods inherited from class de.fraunhofer.iosb.ilt.configurable.editor.EditorDefault

getDescription, getHelpButton, getHelpFrame, getLabel, popupDescription, setDescription, setLabel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.fraunhofer.iosb.ilt.configurable.ConfigEditor

getJsonRootSchema, initFor

Field Detail

profilesEdit

public Set<String> profilesEdit

Constructor Detail

EditorBoolean

public EditorBoolean()

EditorBoolean

public EditorBoolean(boolean deflt)

EditorBoolean

public EditorBoolean(boolean deflt,
                     String label,
                     String description)

Method Detail

initFor

public void initFor(Field field)

Description copied from interface: ConfigEditor

Initialise the editor for the given Field, using the Field name and type and any annotations present on the Field.

Specified by:

initFor in interface ConfigEditor<Boolean>

Overrides:

initFor in class EditorDefault<Boolean>

Parameters:

field - the Field to initialise the editor for.

setConfig

public void setConfig(com.google.gson.JsonElement config)

Description copied from interface: ConfigEditor

Load the given configuration into this editor.

Parameters:

config - the configuration to load into this editor.

getJsonSchema

public SchemaItem getJsonSchema(RootSchema rootSchema)

Description copied from interface: ConfigEditor

Get the JSON Schema for this editor, using the given rootSchema for shared $defs.

Parameters:

rootSchema - the root schema to use for $defs. If null, the return value must be a root schema.

Returns:

the schema for this editor.

getGuiFactorySwing

public GuiFactorySwing getGuiFactorySwing()

Description copied from interface: ConfigEditor

Get a factory that can generate a swing-based gui for this editor.

Returns:

A factory that can generate a swing-based gui for this editor.

getGuiFactoryFx

public GuiFactoryFx getGuiFactoryFx()

Description copied from interface: ConfigEditor

Get a factory that can generate a JavaFX-based gui for this editor.

Returns:

A factory that can generate a JavaFX-based gui for this editor.

getConfig

public com.google.gson.JsonElement getConfig()

Description copied from interface: ConfigEditor

Get the current (edited) state of the configuration.

Returns:

The current (edited) configuration.

getRawValue

public Boolean getRawValue()

setRawValue

public void setRawValue(Boolean value)

getValue

public Boolean getValue()

Description copied from interface: ConfigEditor

Get the value configured in the editor.

Returns:

the value configured in the editor.

setValue

public void setValue(Boolean value)

Description copied from interface: ConfigEditor

Set the value in the editor. Used for saving an (externally) updated configuration.

Parameters:

value - the value in the editor.

setProfile

public void setProfile(String profile)

Description copied from interface: ConfigEditor

Sets the currently active profile.

Parameters:

profile - the currently active profile.

setProfilesEdit

public void setProfilesEdit(String csv)

canEdit

public boolean canEdit()

Description copied from interface: ConfigEditor

True if the component is editable in the current profile.

Returns:

True if the component is editable in the current profile.

isDefault

public boolean isDefault()