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

Class EditorNull

java.lang.Object

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

de.fraunhofer.iosb.ilt.configurable.editor.EditorNull

All Implemented Interfaces:

ConfigEditor<Void>

public class EditorNull
extends EditorDefault<Void>

An editor that does not edit anything. For cases where you want a class to be configurable, but not actually have an editor.

Author:

Hylke van der Schaaf

Field Summary

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

DEFAULT_PROFILE_NAME

Constructor Summary

Constructors

Constructor	Description
EditorNull()
EditorNull(String label, String description)

Method Summary

Modifier and Type	Method	Description
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.
Void	getValue()	Get the value configured in the editor.
void	setConfig(com.google.gson.JsonElement config)	Load the given configuration into this editor.
void	setValue(Void value)	Set the value in the editor.

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

getDescription, getHelpButton, getHelpFrame, getLabel, initFor, 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

canEdit, getJsonRootSchema, initFor, isDefault, setProfile

Constructor Detail

EditorNull

public EditorNull()

EditorNull

public EditorNull(String label,
                  String description)

Method Detail

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.

getValue

public Void getValue()

Description copied from interface: ConfigEditor

Get the value configured in the editor.

Returns:

the value configured in the editor.

setValue

public void setValue(Void 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.