User Tools

Site Tools


REALBOX

Guide Section: An EASAP GUI
EASAP Tree:
USER INTERFACE > FORM LIST or TABBED PANE LIST > FORM or TABBED PANE


REALBOX creates a data entry box for users to input a real number.

A REALBOX may take any floating point or decimal value in the following formats:

  • 102.4 - standard decimal notation
  • 1.024E+2 - exponential notation

Below is an example of a REALBOX with Units: set as it might appear on the user interface.

REALBOX
Optional Parameters:
Label:Enter literal text and/or LIST or SCALAR references for a label to the left of the box
Range Reference:Select NAMED RANGE or a RANGE REFERENCE to link value to cell in an Excel spreadsheet
Upper Bound:Enter a literal number or expression to use as an upper bound
Lower Bound:Enter a literal number or expression to use as a lower bound
Show if:Enter a logical expression to apply to this object
This object is shown if this object's and every parent's Show if: is true (ie. parent of parent, and so on up the Tree)
Default: true (also the default for other object's Show if: parameter)
Enable if:Enter a logical expression or leave blank to inherit expression from the first non-blank parent Enable if:
If expression is true object value may be modified, otherwise object is greyed-out and disabled
Default: <blank> (ie. inherit expression from parent, or if parent is <blank>, parent of parent…, up the Tree)
Top level Enable if: is true by default, thus a chain of objects with the default Enable if: <blank> are enabled
Type:Select DISPLAY ONLY to prevent a User from modifying the value
Default: EDITABLE
Units:Select a DIMENSIONAL GROUP to enable a User to choose between different units from a dropdown
A unit must also be specified for Default: and (if used) Upper Bound: and/or Lower Bound:
Number Format:enter a number format to display value
Default: 6.4g
Delimiter:Set a literal character to delimit LIST or SCALAR references on Label: and Default: above, when Type: is non-numeric
Default: %
Tool Tip:Enter literal text and/or LIST or SCALAR references to display on mouseover
Tab Index:Set a literal integer to establish an order of preference for <TAB> key navigation,
<TAB> delivers focus to Tab Index:→ 1 then 2 and continues in ascending numerical order.
After the highest set Tab Index: value, focus is delivered to Tab Index:→ 0
Tab Index: –1 will completely exclude this object from <TAB> focus selection.
Default: 0
Default:Set a default value to be displayed, expression allowed
Default: 0
Label Width:Set a literal width in pixels for the label region to the left of the REALBOX
Default: 100
Characters:Set a literal number of characters to show
Default: 16
Style:Enter a literal string, or select a USER INTERFACE STYLE or SCALAR reference with CSS-style to apply to the whole object
Input Style:Enter a literal string, or select a USER INTERFACE STYLE or SCALAR reference with CSS-style to apply to the input area

Upper Bound: and Lower Bound:

A REALBOX allows an upper and lower bound on user input defined by Upper Bound: and Lower Bound:. This capability is useful for keeping inputs from users sensible and thus keeping an EASAP running reliably.

If a User enters a value outside of the bounds, an error message is displayed.

After all inputs are within acceptable bounds the EASAP may be submitted by the user to run.

The Tool Tip: for a REALBOX automatically shows the bounds that have been set, below.


Units:

Since real numbers are often associated with a measurement of some kind, the ability to show users the unit of measure and even provide them with a choices of units is available when defining a REALBOX via the Units: parameters. See Use of Units.


Number Format:

The number format displayed within a REALBOX is specified within Number Format:

Three different formats are available:

  • a.bf - a real where:
    a - total number of characters including digits, decimal point and + or - signs
    b - the number of digits after decimal point
  • a.be - an exponential where:
    a - total number of characters including digits, decimal point, E character and + or - signs
    b - the number of digits after decimal point
  • a.bg - mixed where:
    a - total number of characters including digits, decimal point, E character and + or - signs
    b - the number of digits after decimal point
    This format defaults to real but will switch to exponential when the number is too small or too large for the real format to be valid

The default for a REALBOX is the mixed format of: 6.4g