Difference between revisions of "TextField"

From GiderosMobile
Line 6: Line 6:
 
The `TextField` class is used to create display objects for text display.<br />
 
The `TextField` class is used to create display objects for text display.<br />
 
<br />
 
<br />
 +
=== Examples ===
 +
'''Example'''<br/>
 +
<source lang="lua">local font = Font.new(&quot;myfont.txt&quot;, &quot;myfont.png&quot;)<br />
 +
<br />
 +
local textfield = TextField.new(font, &quot;some text&quot;)<br />
 +
<br />
 +
stage:addChild(textfield)<br />
 +
<br />
 +
textfield:setText(&quot;some other text&quot;) -- change the text<br />
 +
<br />
 +
-- to use the default font, pass nil value for the font parameter<br />
 +
local textfield2 = TextField.new(nil, &quot;some other text with default font&quot;)</source>
 
{|-
 
{|-
 
| style="width: 50%;"|
 
| style="width: 50%;"|

Revision as of 11:46, 23 August 2018

Supported platforms: android, ios, mac, pc
Available since: Gideros 2011.6

Description


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

Examples

Example

local font = Font.new(&quot;myfont.txt&quot;, &quot;myfont.png&quot;)<br />
<br />
local textfield = TextField.new(font, &quot;some text&quot;)<br />
<br />
stage:addChild(textfield)<br />
<br />
textfield:setText(&quot;some other text&quot;)		-- change the text<br />
<br />
-- to use the default font, pass nil value for the font parameter<br />
local textfield2 = TextField.new(nil, &quot;some other text with default font&quot;)

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: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: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