Module flower.widget.TextInput

This class is a line of text can be entered.

Does not correspond to a multi-line input. TODO: TextInput does not support multi-byte. TODO: TextInput can not move the cursor.

Extends:

Info:

  • Release: V3.0.0
  • Author: Makoto

Functions

TextInput:_initInternal () Initialize a variables
TextInput:_initEventListeners () Initialize the event listeners.
TextInput:_createChildren () Create the children.
TextInput:drawFocus (focus) Draw the focus object.
TextInput:drawTextAllow () Draw an arrow in the text.
TextInput:getBackgroundTexture () Returns the background texture path.
TextInput:getMaxLength () Returns the input max length.
TextInput:setMaxLength (maxLength) Set the input max length.
TextInput:onFocusIn (e) This event handler is called when focus in.
TextInput:onFocusOut (e) This event handler is called when focus in.
TextInput:onKeyDown (e) This event handler is called when focus in.
TextInput:onKeyUp (e) This event handler is called when key up.
TextInput:onKeyboardInput (start, length, text) This event handler is called when keyboard input.
TextInput:onKeyboardReturn () This event handler is called when keyboard input.

Fields

STYLE_FOCUS_TEXTURE Style: focusTexture
STYLE_MAX_LENGTH Style: maxLength


Functions

TextInput:_initInternal ()
Initialize a variables
TextInput:_initEventListeners ()
Initialize the event listeners.
TextInput:_createChildren ()
Create the children.
TextInput:drawFocus (focus)
Draw the focus object.

Parameters:

  • focus focus
TextInput:drawTextAllow ()
Draw an arrow in the text.
TextInput:getBackgroundTexture ()
Returns the background texture path.

Returns:

    background texture path
TextInput:getMaxLength ()
Returns the input max length.

Returns:

    max length
TextInput:setMaxLength (maxLength)
Set the input max length.

Parameters:

  • maxLength max length.
TextInput:onFocusIn (e)
This event handler is called when focus in.

Parameters:

  • e event
TextInput:onFocusOut (e)
This event handler is called when focus in.

Parameters:

  • e event
TextInput:onKeyDown (e)
This event handler is called when focus in.

Parameters:

  • e event
TextInput:onKeyUp (e)
This event handler is called when key up.

Parameters:

  • e event
TextInput:onKeyboardInput (start, length, text)
This event handler is called when keyboard input.

Parameters:

  • start start
  • length length
  • text text
TextInput:onKeyboardReturn ()
This event handler is called when keyboard input.

Fields

STYLE_FOCUS_TEXTURE
Style: focusTexture
STYLE_MAX_LENGTH
Style: maxLength
generated by LDoc 1.3