3.2.4.2 Dialog.addCtrl()
dlg.addTextCtrl (id, label, value); dlg.addMultilineCtrl (id, label, value); dlg.addPasswordCtrl (id, label, value); dlg.addSelectCtrl (id, label, value, option1, option2, ...); dlg.addCheckCtrl (id, label, value); dlg.addStaticText ([id,]label); dlg.addButton (id, label, [callbackFn]);
With the addCtrl() functions you add controls to a dialog object. When done, you can show the dialog using Dialog.show() or Dialog.showModal() and query the values entered by the user after the dialog is closed.
- The id is any identifier unique to the dialog and is needed if
you want to set or get the values of the control. You can mix numbers and
strings as you like.
- label is any string shown beside or inside the control.
- value is the default value of the control.
With the addButton() function you can add buttons to the dialog. If the user presses the button, the given callback function is called.
- The callbackFn callback function is called in the scope of the
dialog object.
- If you do not provide a callback function, Dialog.close() is called
when the button is pressed.
- Buttons with the IDs "ok", "cancel" or
"help" are shown at the bottom of the dialog in a system-defined
order. The labels of the "ok" and "cancel" buttons are
editable since Silverjuke 2.52beta2; for the label of the "help"
button, a system-specific text or icon is used.
- All other buttons are shown in the order as added.
- If you do not add at least an "ok" button, the buttons
"ok" and "cancel" are added automatically.
Example:
var d = new Dialog;
d.addTextCtrl('name', 'Your name:');
d.addSelectCtrl('like', 'Like this script?', 0, 'yes', 'no');
if( d.showModal() == 'ok' )
{
usersName = d.getValue('name');
likeOrDislike = d.getValue('like');
}
See also: Dialog.showModal(), Dialog.show(), Dialog.getValue(), Dialog.setValue()