< Back

Contents

Script Input Fields

In script you can define custom input fields using comments at file start:

// title: List Files in Directory
// input: type=line; label=Directory; size=3; mandatory
// input: type=line; label=Ending(s), comma-separated; description=Working Examples: ".java, xml", "java, .css, .html"

Field Types Available:

1. Field: line

Set type=line to get a input field (single line):

// input: type=line; label=Directory; size=3; mandatory

(size: 1-10)

2. Multi-line Field: text

Set type=text to get a multi-line field:

// input: type=text; label=Directory; size=5; mandatory

(size: 1-10)

3. Selection: select

Set type=select and add multiple items to get a selection:

// input: type=select; label=Animal; item=bear; item=goat; item=deer
// input: type=select; label=Status; item=orange,Medium; item=red,Critical; item=green,Ok; mandatory

Example for selections

Get Input

For accessing text input for the input fields defined, use the static method in code:

Examples:

String firstFieldText = INPUT.get(0);
String secondFieldText = INPUT.get(1);

Sizing

Use these parameters to set the size of the input fields:

Examples:

// input type=line size=1
// input type=line size=2
// input type=line size=3
// input type=line size=4
// input type=line size=5
// input type=line size=6
// input type=line size=7
// input type=line size=8
// input type=line size=9
// input type=line size=10

// input type=line width=6 height=3

// input type=text size=1
// input type=text size=2
// input type=text size=5
// input type=text size=10

// input type=text width=8 height=3