Under construction!
A custom User Input Panel is an xml file and commonly named userInputSpec.xml.
Step 1 - Introduce the custom panel
To use a custom user input panel you have to add the following xml code to the install.xml:
<panels> ... <panel classname="UserInputPanel"/> ... </panels>
Put the panel tag in the right order of your panels defined in the panels tag. Now specify the location of the userInputSpec.xml in the resources tag of the instal.xml.
<resources> ... <res id="userInputSpec.xml" src="userInputSpec.xml" /> ... <resources>
Step 2 - userInputSpec.xml skeleton
<userInput> <panel order="0" layout="left"> <field type="text" variable="value1"> ... </field> </panel> </userInput>
This xml code should be put in the userINputSpec.xml file. This is the skeleton description of a custom user input panel.
XML Tag | Description |
---|---|
<userInput> | Root tag |
<panel> | Definition of a panel; You can have multiple panels defined in the <userInput> |
<field> | Definiton of a gui element; One gui elemen per <field > |
Step 3 - Supported input elements
Element | Description | Code | Screenshot |
---|---|---|---|
Text Input | <field type="text" variable="textInput"> <description align="left" txt="A description for a text input field" id="description.text"/> <spec txt="Enter some text:" id="text.label" size="15" set="some text"/> </field> | ||
Combo Box | <field type="combo" variable="radioSelection"> <description align="left" txt="This is a description for radio buttons" id="description.radio"/> <spec> <choice txt="the first choice" id="radio.label.1" value="1 selected" /> <choice txt="the second choice" id="radio.label.2" value="2 selected" set="true" /> <choice txt="the third choice" id="radio.label.3" value="3 selected" /> <choice txt="the fourth choice" id="radio.label.4" value="4 selected" /> </spec> | ||
Radio Buttons | |||
Check Box | |||
Password | |||
File | |||
Multiple files | |||
Directory | |||
Rule Input Field | |||
Search Field |
Element | Description | Code | Screenshot |
---|---|---|---|
Static Text | |||
Title | |||
Space | |||
Divider |