Difference between revisions of "TextField"

From GiderosMobile
Line 19: Line 19:
 
local textfield2 = TextField.new(nil, &quot;some other text with default font&quot;)</source>
 
local textfield2 = TextField.new(nil, &quot;some other text with default font&quot;)</source>
 
{|-
 
{|-
| style="width: 50%;"|
+
| style="width: 50%; vertical-align:top;"|
 
=== Methods ===
 
=== Methods ===
[[TextField.new]] {{<translate>creates a new TextField object with the specified font and text</translate>}}<br/>
+
[[TextField.new]] ''<translate>creates a new TextField object with the specified font and text</translate>''<br/>
[[TextField:getLayout]] {{<translate>Retrieve the layout parameters of this Textfield</translate>}}<br/>
+
[[TextField:getLayout]] ''<translate>Retrieve the layout parameters of this Textfield</translate>''<br/>
[[TextField:getLetterSpacing]] {{<translate>returns the letter-spacing property which is used to increase or decrease the space between characters in a text</translate>}}<br/>
+
[[TextField:getLetterSpacing]] ''<translate>returns the letter-spacing property which is used to increase or decrease the space between characters in a text</translate>''<br/>
[[TextField:getLineHeight]] {{<translate>Get line height</translate>}}<br/>
+
[[TextField:getLineHeight]] ''<translate>Get line height</translate>''<br/>
[[TextField:getSample]] {{<translate>get string that was used as sample for determining line height</translate>}}<br/>
+
[[TextField:getSample]] ''<translate>get string that was used as sample for determining line height</translate>''<br/>
[[TextField:getText]] {{<translate>returns the text displayed</translate>}}<br/>
+
[[TextField:getText]] ''<translate>returns the text displayed</translate>''<br/>
[[TextField:getTextColor]] {{<translate>returns the color of the text in a text field in hexadecimal format</translate>}}<br/>
+
[[TextField:getTextColor]] ''<translate>returns the color of the text in a text field in hexadecimal format</translate>''<br/>
[[TextField:setFont]] {{<translate>set font to use</translate>}}<br/>
+
[[TextField:setFont]] ''<translate>set font to use</translate>''<br/>
[[TextField:setLayout]] {{<translate>Change the layout parameters for this TextField</translate>}}<br/>
+
[[TextField:setLayout]] ''<translate>Change the layout parameters for this TextField</translate>''<br/>
[[TextField:setLetterSpacing]] {{<translate>sets the letter-spacing property which is used to increase or decrease the space between characters in a text</translate>}}<br/>
+
[[TextField:setLetterSpacing]] ''<translate>sets the letter-spacing property which is used to increase or decrease the space between characters in a text</translate>''<br/>
[[TextField:setSample]] {{<translate>Set string that will be used as sample for determining text's line height</translate>}}<br/>
+
[[TextField:setSample]] ''<translate>Set string that will be used as sample for determining text's line height</translate>''<br/>
[[TextField:setText]] {{<translate>sets the text to be displayed</translate>}}<br/>
+
[[TextField:setText]] ''<translate>sets the text to be displayed</translate>''<br/>
[[TextField:setTextColor]] {{<translate>sets the color of the text in a text field in hexadecimal format</translate>}}<br/>
+
[[TextField:setTextColor]] ''<translate>sets the color of the text in a text field in hexadecimal format</translate>''<br/>
| style="width: 50%;"|
+
| style="width: 50%; vertical-align:top;"|
 
=== Events ===
 
=== Events ===
 
=== Constants ===
 
=== Constants ===
 
|}
 
|}

Revision as of 15:31, 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;)

local textfield = TextField.new(font, &quot;some text&quot;)

stage:addChild(textfield)

textfield:setText(&quot;some other text&quot;)		-- change the text

-- to use the default font, pass nil value for the font parameter
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