native.newTextField()

Type Function
Library native.*
Return value TextField
Revision Current Public Release (2014.2393)
Keywords text input, text fields, native text
See also native.newTextBox()
native.setKeyboardFocus()
object.inputType
userInput events

Overview

Creates a single-line text field for text input.

Native text fields can listen for userInput events (see example).

Native text fields can display optional placeholder text (nil by default). This can provide a "hint" as to what the user should enter in the field. If set, the placeholder string is displayed using the same style information (except the text color). The placeholder does not appear once actual text has been input into the field and it does not currently participate in determining the size of the text field.

Gotchas

Syntax

native.newTextField( centerX, centerY, width, height [, listener] )
centerX, centerY (required)

Numbers. The x and y coordinates that correspond to the center of the text field.

width, height (required)

Numbers. Width and height (size) of the text field.

listener (optional)

Listener. Function to respond to keyboard events. We recommended that you do not use this argument and instead add a "userInput" event listener to the text field object. See userInput or the examples below for details.

Examples

Standard
local defaultField

local function textListener( event )

    if ( event.phase == "began" ) then

        -- user begins editing text field
        print( event.text )

    elseif ( event.phase == "ended" or event.phase == "submitted" ) then

        -- text field loses focus
        -- do something with defaultField's text
        print( "Submitted text: " .. event.target.text )

    elseif ( event.phase == "editing" ) then

        print( event.newCharacters )
        print( event.oldText )
        print( event.startPosition )
        print( event.text )

    end
end

-- Create text field
defaultField = native.newTextField( 150, 150, 180, 30 )

defaultField:addEventListener( "userInput", textListener )
Numeric Input Only
local function handlerFunction( event )

    if ( event.phase == "began" ) then

        -- user begins editing text field
        print( event.text )
    end   
end

local numericField = native.newTextField( 150, 150, 220, 36 )
numericField.inputType = "number"

numericField:addEventListener( "userInput", handlerFunction )