system.gui.showNumericKeypad

Description

Displays a modal on-screen numeric keypad, allowing for arbitrary numeric entry using the mouse, or a finger on a touchscreen monitor. Returns the number that the user entered.

Syntax

system.gui. showNumericKeypad( initialValue [, fontSize] [, usePasswordMode] )

Parameters

Number initialValue - The value to start the on-screen keypad with.

int fontSize - The font size to display in the keypad. [optional]

boolean usePasswordMode - If True, display a * for each digit. [optional] (since 7.8.1)

Returns

Number - The value that was entered in the keypad.

Scope

Client

Code Examples

Code Snippet

#This function is a holdover for backwards compatibility. Input components now know when the client is in touchscreen mode and respond accordingly. 
#This script would go in the MouseClicked or MousePressed action of a Text Field or Numeric Text Field.
 
# For Integer Numeric Text Field:
if system.gui.isTouchscreenModeEnabled():
   event.source.intValue = system.gui.showNumericKeypad(event.source.intValue)
 
# For Double Numeric Text Field:
if system.gui.isTouchscreenModeEnabled():
   event.source.doubleValue = system.gui.showNumericKeypad(event.source.doubleValue)
 
# For Text Field:
# notice the str() and int() functions used to convert the text to a number and 
# vice versa.
# str() and int() are built-in Jython functions
if system.gui.isTouchscreenModeEnabled():
   event.source.text = str(system.gui.showNumericKeypad(int(event.source.text)))