Difference between revisions of "TextField"

From GiderosMobile
(removed language stuff)
m (Text replacement - "<source" to "<syntaxhighlight")
Line 10: Line 10:
 
=== Examples ===
 
=== Examples ===
 
'''Example 1:''' bitmap font:
 
'''Example 1:''' bitmap font:
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
local font = Font.new("myfont.txt", "myfont.png") -- you need to add your bitmap font
 
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")
Line 18: Line 18:
  
 
'''Example 2:''' default font:
 
'''Example 2:''' default font:
<source lang="lua">
+
<syntaxhighlight 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 text with default font")
 
local textfield2 = TextField.new(nil, "some text with default font")
Line 25: Line 25:
  
 
'''Example 3:''' TTFont:
 
'''Example 3:''' TTFont:
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
local font = TTFont.new("fonts/Tahoma.ttf", 32, "", true, 1) -- you need to add your .ttf font
 
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")
 
local text = TextField.new(font, "This is a text")
Line 33: Line 33:
  
 
'''Example 4:''' colored text:
 
'''Example 4:''' colored text:
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
local text = TextField.new(nil, "This is a \e[color=#f005]semi transparent red\e[color] text")
 
local text = TextField.new(nil, "This is a \e[color=#f005]semi transparent red\e[color] text")
 
text:setPosition(32, 64)
 
text:setPosition(32, 64)

Revision as of 14:31, 13 July 2023

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: <syntaxhighlight lang="lua"> 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 </source>

Example 2: default font: <syntaxhighlight lang="lua"> -- 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) </source>

Example 3: TTFont: <syntaxhighlight 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>

Example 4: colored text: <syntaxhighlight 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>

See also

CompositeFont

Methods

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

Events

Constants