ScriptLabelledNumberBox

ScriptLabelledNumberBox

Represents a labelled number box (text box) control, which lets the user select a number. The control is created by the RuleForm object's numberBox() function.

getValue()

Retrieves the number entered.

Returns:

The number entered, or (if set) the default. If no default has been provided and nothing has been entered then this will return null.

lineBreakAfter

Use this where your Rule has many controls, and they do not fit comfortably in a single line. It allows you to specify that a new row will be started after this control.

Example:

c.lineBreakAfter = true;

requireValue()

Retrieves the number entered. If no number has been entered and no default has been set then the script will end immediately and this control will be marked invalid.

Returns:

The number entered, or the default if nothing has been entered.

setDefault(value)

Sets the default value.

value

A number.

type

Returns the name we use to refer to this class in the documentation.