org.scripthelper.swing.script

Class DefaultSwingScriptHelper<C extends ScriptContext>

java.lang.Object

org.scripthelper.context.DefaultScriptHelper

org.scripthelper.swing.script.DefaultSwingScriptHelper<C>

Type Parameters:

C - the script context type

All Implemented Interfaces:

ScriptHelper

public class DefaultSwingScriptHelper<C extends ScriptContext>
extends DefaultScriptHelper

A default customizable swing script helper.

Field Summary

Fields inherited from class org.scripthelper.context.DefaultScriptHelper

context

Constructor Summary

Constructors

Constructor and Description
DefaultSwingScriptHelper(C context) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	askForBooleanProperty(java.lang.String desc) Ask the user for a boolean property to set.
java.lang.String	askForEnumProperty(java.lang.String desc, java.lang.String... params) Ask the user for a boolean property to set.This can be used to configure the Script.
java.io.File	askForFileProperty(java.lang.String desc, int dialogType, int fileSelectionMode, java.io.File currentDirectory) Ask the user for a File property to set.
java.lang.Float	askForFloatProperty(java.lang.String desc, float minValue, float maxValue, float step) Ask the user for a float property to set.
java.lang.Integer	askForIntProperty(java.lang.String desc, int minValue, int maxValue, int step) Ask the user for an int property to set.
java.lang.String	askForNotNullProperty(java.lang.String desc) Ask the user for a property to set, making sure that the result is never null even if the user cancel the dialog.
java.lang.String	askForProperty(java.lang.String desc) Ask the user for a String property to set.
java.io.File	getExistingDirectory(java.lang.String title) Shows a dialog and returns the dialog selected directory.
java.io.File	getExistingDirectory(java.lang.String title, java.io.File currentDirectory) Shows a dialog and returns the dialog selected directory.
java.io.File	getExistingFile(java.lang.String title, java.io.File currentDirectory, java.lang.String ext) Shows a dialog and returns the dialog selected file, which must already exist.
java.io.File	getExistingFile(java.lang.String title, java.lang.String ext) Shows a dialog and returns the dialog selected file, which must already exist.
static java.util.Set<java.lang.String>	getImports() Return the imports.
java.io.File	getNewDirectory(java.lang.String title) Shows a dialog and returns the dialog selected directory to create.
java.io.File	getNewDirectory(java.lang.String title, java.io.File currentDirectory) Shows a dialog and returns the dialog selected directory to create.
java.io.File	getNewFile(java.lang.String title, java.io.File currentDirectory, java.lang.String ext) Shows a dialog and returns the dialog selected file.The file will be created if it does not already exist.
java.io.File	getNewFile(java.lang.String title, java.lang.String ext) Shows a dialog and returns the dialog selected file.The file will be created if it does not already exist.
PropertySetter	getPropertySetter(java.lang.String title) Return a PropertySetter, which allows to set several values at once.

Methods inherited from class org.scripthelper.context.DefaultScriptHelper

getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSwingScriptHelper

public DefaultSwingScriptHelper(C context)

Constructor.

Parameters:

context - the script context

Method Detail

getNewFile

public java.io.File getNewFile(java.lang.String title,
                               java.lang.String ext)

Shows a dialog and returns the dialog selected file.The file will be created if it does not already exist.

Parameters:

title - the dialog title

ext - the file extension

Returns:

the selected file

getNewFile

public java.io.File getNewFile(java.lang.String title,
                               java.io.File currentDirectory,
                               java.lang.String ext)

Shows a dialog and returns the dialog selected file.The file will be created if it does not already exist.

Parameters:

title - the dialog title

currentDirectory - the current directory

ext - the file extension

Returns:

the selected file

getExistingFile

public java.io.File getExistingFile(java.lang.String title,
                                    java.lang.String ext)

Shows a dialog and returns the dialog selected file, which must already exist.

Parameters:

title - the dialog title

ext - the file extension

Returns:

the selected file

getExistingFile

public java.io.File getExistingFile(java.lang.String title,
                                    java.io.File currentDirectory,
                                    java.lang.String ext)

Shows a dialog and returns the dialog selected file, which must already exist.

Parameters:

title - the dialog title

currentDirectory - the current directory

ext - the file extension

Returns:

the selected file

getNewDirectory

public java.io.File getNewDirectory(java.lang.String title)

Shows a dialog and returns the dialog selected directory to create.

Parameters:

title - the dialog title

Returns:

the selected file

getNewDirectory

public java.io.File getNewDirectory(java.lang.String title,
                                    java.io.File currentDirectory)

Shows a dialog and returns the dialog selected directory to create.

Parameters:

title - the dialog title

currentDirectory - the current directory

Returns:

the selected file

getExistingDirectory

public java.io.File getExistingDirectory(java.lang.String title)

Shows a dialog and returns the dialog selected directory.

Parameters:

title - the dialog title

Returns:

the selected file

getExistingDirectory

public java.io.File getExistingDirectory(java.lang.String title,
                                         java.io.File currentDirectory)

Shows a dialog and returns the dialog selected directory.

Parameters:

title - the dialog title

currentDirectory - the current directory

Returns:

the selected file

askForNotNullProperty

public java.lang.String askForNotNullProperty(java.lang.String desc)

Ask the user for a property to set, making sure that the result is never null even if the user cancel the dialog.

Parameters:

desc - the prompt to set the property

Returns:

the property value

askForProperty

public java.lang.String askForProperty(java.lang.String desc)

Ask the user for a String property to set. This can be used to configure the Script. Note that the result will be null if the user cancel the dialog.

Parameters:

desc - the prompt to set the property

Returns:

the property value

askForIntProperty

public java.lang.Integer askForIntProperty(java.lang.String desc,
                                           int minValue,
                                           int maxValue,
                                           int step)

Ask the user for an int property to set. This can be used to configure the Script. Note that the result will be null if the user cancel the dialog.

Parameters:

desc - the prompt to set the property

minValue - the minimum value

maxValue - the maximum value

step - the step

Returns:

the property value

askForFloatProperty

public java.lang.Float askForFloatProperty(java.lang.String desc,
                                           float minValue,
                                           float maxValue,
                                           float step)

Ask the user for a float property to set. This can be used to configure the Script. Note that the result will be null if the user cancel the dialog.

Parameters:

desc - the prompt to set the property

minValue - the minimum value

maxValue - the maximum value

step - the step

Returns:

the property value

askForBooleanProperty

public java.lang.Boolean askForBooleanProperty(java.lang.String desc)

Ask the user for a boolean property to set. This can be used to configure the Script. Note that the result will be null if the user cancel the dialog.

Parameters:

desc - the prompt to set the property

Returns:

the property value

askForEnumProperty

public java.lang.String askForEnumProperty(java.lang.String desc,
                                           java.lang.String... params)

Ask the user for a boolean property to set.This can be used to configure the Script. Note that the result will be null if the user cancel the dialog.

Parameters:

desc - the prompt to set the property

params - the String names for the enumeration

Returns:

the property value

askForFileProperty

public java.io.File askForFileProperty(java.lang.String desc,
                                       int dialogType,
                                       int fileSelectionMode,
                                       java.io.File currentDirectory)

Ask the user for a File property to set. This can be used to configure the Script.Note that the result will be null if the user cancel the dialog.

Parameters:

desc - the prompt to set the property

dialogType - the dialog type

fileSelectionMode - the file selection mode

currentDirectory - the current directory

Returns:

the property value

getPropertySetter

public PropertySetter getPropertySetter(java.lang.String title)

Return a PropertySetter, which allows to set several values at once.

Parameters:

title - the associated Dialog title

Returns:

the PropertySetter

getImports

public static java.util.Set<java.lang.String> getImports()

Return the imports.

Returns:

the imports