TextField

From GiderosMobile

This page contains changes which are not marked for translation.


Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
Available since: Gideros 2011.6
Inherits from: Sprite

Description


The TextField class is used to create display objects for text display.

Examples

Example

local font = Font.new("myfont.txt", "myfont.png")

local textfield = TextField.new(font, "some text")

stage:addChild(textfield)

textfield:setText("some other text")		-- change the text

-- to use the default font, pass nil value for the font parameter
local textfield2 = TextField.new(nil, "some other text with default font")

Methods

TextField.new creates a new TextField object with the specified font and text
TextField:getLayout Retrieve the layout parameters of this Textfield
TextField:getLetterSpacing returns the letter-spacing property which is used to increase or decrease the space between characters in a text
TextField:getLineHeight Get line height
TextField:getPointFromTextPosition returns the coordinates from a given offset within the text
TextField:getSample get string that was used as sample for determining line height
TextField:getText returns the text displayed
TextField:getTextColor returns the color of the text in a text field in hexadecimal format
TextField:getTextPositionFromPoint returns the offset into a text from x,y coordinates
TextField:setFont set font to use
TextField:setLayout Change the layout parameters for this TextField
TextField:setLetterSpacing sets the letter-spacing property which is used to increase or decrease the space between characters in a text
TextField:setSample Set string that will be used as sample for determining text's line height
TextField:setText sets the text to be displayed
TextField:setTextColor sets the color of the text in a text field in hexadecimal format

Events

Constants