Difference between revisions of "TextField"

From GiderosMobile

m
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
 
<languages />
 
<languages />
 +
 
<!-- GIDEROSOBJ:TextField -->
 
<!-- GIDEROSOBJ:TextField -->
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
+
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
<br/>
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
+
'''<translate>Available since</translate>:''' Gideros 2011.6
 +
<br/>
 +
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]
 +
<br/>
 +
 
 
=== <translate>Description</translate> ===
 
=== <translate>Description</translate> ===
<translate><br />
+
<translate>
The [[Special:MyLanguage/TextField|TextField]] class is used to create display objects for text display.<br />
+
The [[Special:MyLanguage/TextField|TextField]] class is used to create objects for text display.
<br /></translate>
+
<br/>
 +
</translate>
 +
 
 
=== <translate>Examples</translate> ===
 
=== <translate>Examples</translate> ===
'''Example'''<br/>
+
'''Example 1:''' bitmap font.
<source lang="lua">local font = Font.new("myfont.txt", "myfont.png")
+
<br/>
  
 +
<source lang="lua">
 +
local font = Font.new("myfont.txt", "myfont.png") -- you need to add your bitmap font
 
local textfield = TextField.new(font, "some text")
 
local textfield = TextField.new(font, "some text")
 
 
stage:addChild(textfield)
 
stage:addChild(textfield)
 +
textfield:setText("some other text") -- change the text
 +
</source>
 +
<br/>
  
textfield:setText("some other text") -- change the text
+
'''Example 2:''' default font.
 +
<br/>
  
 +
<source lang="lua">
 
-- 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, "some other text with default font")</source>
+
local textfield2 = TextField.new(nil, "some text with default font")
 +
stage:addChild(textfield2)
 +
</source>
 +
<br/>
 +
 
 +
'''Example 3:''' TTFont.
 +
<br/>
 +
 
 +
<source lang="lua">
 +
local font = TTFont.new("fonts/Tahoma.ttf", 32, "", true, 1) -- you need to add your .ttf font
 +
local text = TextField.new(font, "This is a text")
 +
text:setPosition(100, 100)
 +
stage:addChild(text)
 +
</source>
 +
<br/>
 +
 
 +
'''Example 4:''' colored text.
 +
<br/>
 +
 
 +
<source lang="lua">
 +
local text = TextField.new(nil, "This is a \e[color=#f005]semi transparent red\e[color] text")
 +
text:setPosition(32, 64)
 +
stage:addChild(text)
 +
</source>
 +
<br/>
 +
<br/>
 +
 
 
{|-
 
{|-
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|

Latest revision as of 04:18, 14 July 2019



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 objects for text display.

Examples

Example 1: bitmap font.

local font = Font.new("myfont.txt", "myfont.png") -- you need to add your bitmap font
local textfield = TextField.new(font, "some text")
stage:addChild(textfield)
textfield:setText("some other text") -- change the text


Example 2: default font.

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


Example 3: TTFont.

local font = TTFont.new("fonts/Tahoma.ttf", 32, "", true, 1) -- you need to add your .ttf font
local text = TextField.new(font, "This is a text")
text:setPosition(100, 100)
stage:addChild(text)


Example 4: colored text.

local text = TextField.new(nil, "This is a \e[color=#f005]semi transparent red\e[color] text")
text:setPosition(32, 64)
stage:addChild(text)



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