org.knime.core.quickform
Class AbstractQuickFormConfiguration<V extends AbstractQuickFormValueInConfiguration>

java.lang.Object
  org.knime.core.quickform.AbstractQuickFormConfiguration<V>

public abstract class AbstractQuickFormConfiguration<V extends AbstractQuickFormValueInConfiguration>
extends Object

Abstract configuration, contains fields for label, description and weight.

Author:

Bernd Wiswedel, KNIME.com, Zurich, Switzerland

Constructor Summary

AbstractQuickFormConfiguration()

Method Summary

void	copyValueConfigurationFrom(V reference)
abstract QuickFormConfigurationPanel<V>	createController() Create and return a controller that shows the label and description together with the actual value represented by this quickform configuration.
abstract V	createValueConfiguration()
String	getDescription()
String	getLabel()
V	getValueConfiguration()
String	getVariableName()
int	getWeight()
void	loadSettingsInDialog(NodeSettingsRO settings) Load settings in dialog, init defaults if that fails.
void	loadSettingsInModel(NodeSettingsRO settings) Load config in model.
void	saveSettingsTo(NodeSettingsWO settings) Save config to argument.
void	setDescription(String description)
void	setLabel(String label)
void	setVariableName(String variableName)
void	setWeight(int weight)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractQuickFormConfiguration

public AbstractQuickFormConfiguration()

Method Detail

getLabel

public String getLabel()

Returns:

the label

setLabel

public void setLabel(String label)
              throws InvalidSettingsException

Parameters:

label - the label to set

Throws:

InvalidSettingsException - If label is empty or null.

setWeight

public void setWeight(int weight)

Parameters:

weight - the weight to set

getWeight

public int getWeight()

Returns:

the weight

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getVariableName

public String getVariableName()

Returns:

the variableName

setVariableName

public void setVariableName(String variableName)

Parameters:

variableName - the variableName to set

copyValueConfigurationFrom

public void copyValueConfigurationFrom(V reference)
                                throws InvalidSettingsException

Parameters:

reference - the valueConfiguration to copy from, not null.

Throws:

InvalidSettingsException

getValueConfiguration

public V getValueConfiguration()

Returns:

the valueConfiguration

saveSettingsTo

public void saveSettingsTo(NodeSettingsWO settings)

Save config to argument.

Parameters:

settings - To save to.

loadSettingsInModel

public void loadSettingsInModel(NodeSettingsRO settings)
                         throws InvalidSettingsException

Load config in model.

Parameters:

settings - To load from.

Throws:

InvalidSettingsException - If that fails for any reason.

loadSettingsInDialog

public void loadSettingsInDialog(NodeSettingsRO settings)

Load settings in dialog, init defaults if that fails.

Parameters:

settings - To load from.

createController

public abstract QuickFormConfigurationPanel<V> createController()

Create and return a controller that shows the label and description together with the actual value represented by this quickform configuration.

Returns:

a controller that layouts this quickform

createValueConfiguration

public abstract V createValueConfiguration()