Difference between revisions of "TextField"
From GiderosMobile
(Created page with "__NOTOC__ '''Supported platforms:''' <br/> '''Available since:''' Gideros 2011.6<br/> === Description === <br /> The `TextField` class is used to create display objects for te...") |
|||
| (30 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | '''Supported platforms:''' <br/> | + | <!-- GIDEROSOBJ:TextField --> |
| + | '''Supported platforms:''' [[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/> | ||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
| + | '''Inherits from:''' [[Sprite]]<br/> | ||
| + | |||
=== Description === | === Description === | ||
| − | + | The '''TextField''' class is used to create objects for text display. | |
| − | The | + | |
| − | < | + | === Examples === |
| + | '''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 | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | '''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) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | '''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) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | === See also === | ||
| + | '''[[CompositeFont]]''' | ||
| + | |||
{|- | {|- | ||
| − | | style="width: 50%;"| | + | | style="width: 50%; vertical-align:top;"| |
=== Methods === | === Methods === | ||
| − | | style="width: 50%;"| | + | [[TextField.new]] ''creates a new TextField object with the specified font and text''<br/><!--GIDEROSMTD:TextField.new(font,text,sample,layout) creates a new TextField object with the specified font and text--> |
| + | [[TextField:getLayout]] ''retrieves the layout parameters of the Textfield''<br/><!--GIDEROSMTD: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''<br/><!--GIDEROSMTD: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''<br/><!--GIDEROSMTD:TextField:getLineHeight() gets the textfield line height--> | ||
| + | [[TextField:getPointFromTextPosition]] ''returns the coordinates from a given offset within the text''<br/><!--GIDEROSMTD:TextField:getPointFromTextPosition(offset) returns the coordinates from a given offset within the text--> | ||
| + | [[TextField:getSample]] ''gets the string used as sample for determining line height''<br/><!--GIDEROSMTD:TextField:getSample() gets the string used as sample for determining line height--> | ||
| + | [[TextField:getText]] ''returns the textfield text''<br/><!-- GIDEROSMTD:TextField:getText() returns the textfield text--> | ||
| + | [[TextField:getTextColor]] ''returns the textfield text color in hexadecimal format''<br/><!--GIDEROSMTD:TextField:getTextColor() returns the textfield text color in hexadecimal format--> | ||
| + | [[TextField:getTextPositionFromPoint]] ''returns the offset into a text from x,y coordinates''<br/><!--GIDEROSMTD:TextField:getTextPositionFromPoint(x,y) returns the offset into a text from x,y coordinates--> | ||
| + | [[TextField:setFont]] ''sets the textfield font to use''<br/><!--GIDEROSMTD:TextField:setFont(font) sets the textfield font to use--> | ||
| + | [[TextField:setLayout]] ''changes the textfield layout parameters''<br/><!--GIDEROSMTD:TextField:setLayout(layout) 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''<br/><!-- GIDEROSMTD:TextField:setLetterSpacing(spacing) 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''<br/><!--GIDEROSMTD:TextField:setSample(sample) sets the sample string used for determining the text line height--> | ||
| + | [[TextField:setText]] ''sets the textfield text to be displayed''<br/><!--GIDEROSMTD:TextField:setText(text) sets the textfield text to be displayed--> | ||
| + | [[TextField:setTextColor]] ''sets the textfield text color in hexadecimal format''<br/><!--GIDEROSMTD:TextField:setTextColor(color) sets the textfield text color in hexadecimal format--> | ||
| + | |||
| + | | style="width: 50%; vertical-align:top;"| | ||
=== Events === | === Events === | ||
=== Constants === | === Constants === | ||
|} | |} | ||
| + | |||
| + | {{GIDEROS IMPORTANT LINKS}} | ||
Latest revision as of 18:47, 30 April 2024
Supported platforms: 
Available since: Gideros 2011.6
Inherits from: Sprite
Description
The TextField class is used to create objects for text display.
Examples
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
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)
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)
See also
MethodsTextField.new creates a new TextField object with the specified font and text |
EventsConstants |
