org.scripthelper.swing.script

Class PropertySetter

java.lang.Object

org.scripthelper.swing.script.PropertySetter

All Implemented Interfaces:

PropertyTypes

public class PropertySetter
extends java.lang.Object
implements PropertyTypes

This class construct a dialog which allows the user to set several values.

Since:

1.6.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertySetter.Property A property definition.

Field Summary

Fields inherited from interface org.scripthelper.swing.script.PropertyTypes

TYPE_BOOLEAN, TYPE_ENUM, TYPE_FLOAT, TYPE_INT, TYPE_STRING

Constructor Summary

Constructors

Constructor and Description
PropertySetter(java.lang.String dialogTitle, ScriptContext context) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addProperty(java.lang.String key, java.lang.String desc, short type) Add a property to Edit.
void	addProperty(java.lang.String key, java.lang.String desc, short type, java.util.List<java.lang.String> params) Add a property to Edit, with an additional String parameter list.
void	addProperty(java.lang.String key, java.lang.String desc, short type, java.lang.Number minValue, java.lang.Number maxValue, java.lang.Number step) Add a property to Edit, with an additional String parameter list.
void	addProperty(java.lang.String key, java.lang.String desc, short type, java.lang.String... params) Add a property to Edit, with an additional String parameter array.
void	addProperty(java.lang.String key, java.lang.String desc, short type, java.lang.String param) Add a property to Edit, with an additional String parameter.
void	askForProperties() Show the dialog with the values editors.
boolean	getBooleanProperty(java.lang.String name) Return the boolean property with a specified name.
float	getFloatProperty(java.lang.String name, float defaultValue) Return the float property with a specified name.
int	getIntProperty(java.lang.String name, int defaultValue) Return the int property with a specified name.
java.lang.String	getNotNullStringProperty(java.lang.String name) Return the String property with a specified name.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Return the map of all property values after the edition.
java.lang.String	getStringProperty(java.lang.String name) Return the String property with a specified name.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertySetter

public PropertySetter(java.lang.String dialogTitle,
                      ScriptContext context)

Constructor.

Parameters:

dialogTitle - the dialog title

context - the ScriptContext

Method Detail

askForProperties

public void askForProperties()

Show the dialog with the values editors. After the method has finished, the values for the propeties will be available.

See Also:

getProperties(), getBooleanProperty(java.lang.String), getStringProperty(java.lang.String)

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String desc,
                        short type)

Add a property to Edit.

Parameters:

key - the property key

desc - the field description

type - the property type

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String desc,
                        short type,
                        java.lang.String param)

Add a property to Edit, with an additional String parameter. This parameter is useful for setting an extension for writing or reading files.

Parameters:

key - the property key

desc - the field description

type - the property type

param - the property additional parameter

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String desc,
                        short type,
                        java.util.List<java.lang.String> params)

Add a property to Edit, with an additional String parameter list.

Parameters:

key - the property key

desc - the field description

type - the property type

params - the property additional parameters

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String desc,
                        short type,
                        java.lang.String... params)

Add a property to Edit, with an additional String parameter array.

Parameters:

key - the property key

desc - the field description

type - the property type

params - the property additional parameters

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String desc,
                        short type,
                        java.lang.Number minValue,
                        java.lang.Number maxValue,
                        java.lang.Number step)

Add a property to Edit, with an additional String parameter list.

Parameters:

key - the property key

desc - the field description

type - the property type

minValue - the property minimum value

maxValue - the property maximum value

step - the property step

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Return the map of all property values after the edition.

Returns:

the map of all property values after the edition

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name)

Return the boolean property with a specified name.

Parameters:

name - the name of the property

Returns:

the property value (or false if there is no boolean property of the specified name)

getNotNullStringProperty

public java.lang.String getNotNullStringProperty(java.lang.String name)

Return the String property with a specified name.

Parameters:

name - the name of the property

Returns:

the property value (or an empty String if there is no String property of the specified name)

getStringProperty

public java.lang.String getStringProperty(java.lang.String name)

Return the String property with a specified name.

Parameters:

name - the name of the property

Returns:

the property value (or null if there is no String property of the specified name)

getIntProperty

public int getIntProperty(java.lang.String name,
                          int defaultValue)

Return the int property with a specified name.

Parameters:

name - the name of the property

defaultValue - the default value

Returns:

the property value (or defaultValue if there is no number property of the specified name)

getFloatProperty

public float getFloatProperty(java.lang.String name,
                              float defaultValue)

Return the float property with a specified name.

Parameters:

name - the name of the property

defaultValue - the default value

Returns:

the property value (or defaultValue if there is no number property of the specified name)