Difference between revisions of "TextField"

From GiderosMobile
Line 11: Line 11:
 
=== <translate>Examples</translate> ===
 
=== <translate>Examples</translate> ===
 
'''Example'''<br/>
 
'''Example'''<br/>
<source lang="lua">local font = Font.new(&quot;myfont.txt&quot;, &quot;myfont.png&quot;)
+
<source lang="lua">local font = Font.new("myfont.txt", "myfont.png")
  
local textfield = TextField.new(font, &quot;some text&quot;)
+
local textfield = TextField.new(font, "some text")
  
 
stage:addChild(textfield)
 
stage:addChild(textfield)
  
textfield:setText(&quot;some other text&quot;) -- change the text
+
textfield:setText("some other text") -- change the text
  
 
-- to use the default font, pass nil value for the font parameter
 
-- 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;)</source>
+
local textfield2 = TextField.new(nil, "some other text with default font")</source>
 
{|-
 
{|-
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 +
 
=== <translate>Methods</translate> ===
 
=== <translate>Methods</translate> ===
 
[[Special:MyLanguage/TextField.new|TextField.new]] ''<translate>creates a new TextField object with the specified font and text</translate>''<br/><!-- GIDEROSMTD:TextField.new(font,text,sample,layout) creates a new TextField object with the specified font and text -->
 
[[Special:MyLanguage/TextField.new|TextField.new]] ''<translate>creates a new TextField object with the specified font and text</translate>''<br/><!-- GIDEROSMTD:TextField.new(font,text,sample,layout) creates a new TextField object with the specified font and text -->

Revision as of 17:22, 2 November 2018


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