Swing Script helper

The DefaultSwingScriptHelper class is a swing implementation of the ScriptHelper which has additional methods.

DefaultSwingScriptHelper API

The DefaultSwingScriptHelper class has several additional methods.

Asking for a property

The following methods will show a popup window asking for a property. Upon closing the popup window, the method will return the result of the user property edition or selection:

• The DefaultSwingScriptHelper.askForProperty(String) show a dialog allowing to set a String property
• The DefaultSwingScriptHelper.askForBooleanProperty(String) show a dialog allowing to set a Boolean property
• The DefaultSwingScriptHelper.askForIntProperty(String, int, int, int) show a dialog allowing to set an Integer property
• The DefaultSwingScriptHelper.askForFloatProperty(String, float, float, float) show a dialog allowing to set a Float property
• The DefaultSwingScriptHelper.askForEnumProperty(String, String...) show a dialog allowing to set a enum property
• The DefaultSwingScriptHelper.askForFileProperty(String, int, int, File) show a dialog allowing to set a File property
• The DefaultSwingScriptHelper.getPropertySetter(String) show a dialog allowing to set more than one property

Asking for a file or a directory

The following methods will simply show a dialog to select a file or a directory:

• The DefaultSwingScriptHelper.getExistingDirectory(String) show a dialog allowing to get an existing directory
• The DefaultSwingScriptHelper.getExistingDirectory(String, File) show a dialog allowing to get an existing directory with a specified current directory
• The DefaultSwingScriptHelper.getNewDirectory(String) show a dialog allowing to get an existing directory
• The DefaultSwingScriptHelper.getNewDirectory(String, File) show a dialog allowing to get a new directory with a specified current directory
• The DefaultSwingScriptHelper.getExistingFile(String, String) show a dialog allowing to get an existing File
• The DefaultSwingScriptHelper.getExistingFile(String, File, String) show a dialog allowing to get an existing File with a specified current directory
• The DefaultSwingScriptHelper.getNewFile(String, String) show a dialog allowing to get a new File
• The DefaultSwingScriptHelper.getNewFile(String, File, String) show a dialog allowing to get a new File with a specified current directory

Examples

Setting one value

The following code shows a dialog window allowing to set an int:

   public int execute() {
      Integer value = helper.askForIntProperty("Value", 0, 100, 1);
      if (value != null) {
        return value;
      } else {
        return 0;
      }
   }

Setting more than one value

The following code shows a dialog window allowing to set an int and a boolean:

   public int execute() {
      PropertySetter setter = helper.getPropertySetter("Set Values");
      setter.addProperty("int", "Int Value", PropertyTypes.TYPE_INT, 0, 100, 1);
      setter.addProperty("bool", "Boolean Value", PropertyTypes.TYPE_BOOLEAN);
      setter.askForProperties();
      int i = setter.getIntProperty("int", 0);
      boolean b = setter.getBooleanroperty("bool");
      if (b) {
        return i;
      } else {
        return 0;
      }
   }