Difference between revisions of "TextField"

From GiderosMobile
Line 24: Line 24:
 
| 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 -->
+
[[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:getLayout|TextField:getLayout]] ''<translate>Retrieve the layout parameters of this Textfield</translate>''<br/><!-- GIDEROSMTD:TextField:getLayout -->
+
[[Special:MyLanguage/TextField:getLayout|TextField:getLayout]] ''<translate>Retrieve the layout parameters of this Textfield</translate>''<br/><!-- GIDEROSMTD:TextField:getLayout() Retrieve the layout parameters of this Textfield -->
[[Special:MyLanguage/TextField:getLetterSpacing|TextField:getLetterSpacing]] ''<translate>returns the letter-spacing property which is used to increase or decrease the space between characters in a text</translate>''<br/><!-- GIDEROSMTD:TextField:getLetterSpacing -->
+
[[Special:MyLanguage/TextField:getLetterSpacing|TextField:getLetterSpacing]] ''<translate>returns the letter-spacing property which is used to increase or decrease the space between characters in a text</translate>''<br/><!-- GIDEROSMTD:TextField:getLetterSpacing() returns the letter-spacing property which is used to increase or decrease the space between characters in a text -->
[[Special:MyLanguage/TextField:getLineHeight|TextField:getLineHeight]] ''<translate>Get line height</translate>''<br/><!-- GIDEROSMTD:TextField:getLineHeight -->
+
[[Special:MyLanguage/TextField:getLineHeight|TextField:getLineHeight]] ''<translate>Get line height</translate>''<br/><!-- GIDEROSMTD:TextField:getLineHeight() Get line height -->
[[Special:MyLanguage/TextField:getSample|TextField:getSample]] ''<translate>get string that was used as sample for determining line height</translate>''<br/><!-- GIDEROSMTD:TextField:getSample -->
+
[[Special:MyLanguage/TextField:getSample|TextField:getSample]] ''<translate>get string that was used as sample for determining line height</translate>''<br/><!-- GIDEROSMTD:TextField:getSample() get string that was used as sample for determining line height -->
[[Special:MyLanguage/TextField:getText|TextField:getText]] ''<translate>returns the text displayed</translate>''<br/><!-- GIDEROSMTD:TextField:getText -->
+
[[Special:MyLanguage/TextField:getText|TextField:getText]] ''<translate>returns the text displayed</translate>''<br/><!-- GIDEROSMTD:TextField:getText() returns the text displayed -->
[[Special:MyLanguage/TextField:getTextColor|TextField:getTextColor]] ''<translate>returns the color of the text in a text field in hexadecimal format</translate>''<br/><!-- GIDEROSMTD:TextField:getTextColor -->
+
[[Special:MyLanguage/TextField:getTextColor|TextField:getTextColor]] ''<translate>returns the color of the text in a text field in hexadecimal format</translate>''<br/><!-- GIDEROSMTD:TextField:getTextColor() returns the color of the text in a text field in hexadecimal format -->
[[Special:MyLanguage/TextField:setFont|TextField:setFont]] ''<translate>set font to use</translate>''<br/><!-- GIDEROSMTD:TextField:setFont -->
+
[[Special:MyLanguage/TextField:setFont|TextField:setFont]] ''<translate>set font to use</translate>''<br/><!-- GIDEROSMTD:TextField:setFont(font) set font to use -->
[[Special:MyLanguage/TextField:setLayout|TextField:setLayout]] ''<translate>Change the layout parameters for this TextField</translate>''<br/><!-- GIDEROSMTD:TextField:setLayout -->
+
[[Special:MyLanguage/TextField:setLayout|TextField:setLayout]] ''<translate>Change the layout parameters for this TextField</translate>''<br/><!-- GIDEROSMTD:TextField:setLayout(layout) Change the layout parameters for this TextField -->
[[Special:MyLanguage/TextField:setLetterSpacing|TextField:setLetterSpacing]] ''<translate>sets the letter-spacing property which is used to increase or decrease the space between characters in a text</translate>''<br/><!-- GIDEROSMTD:TextField:setLetterSpacing -->
+
[[Special:MyLanguage/TextField:setLetterSpacing|TextField:setLetterSpacing]] ''<translate>sets the letter-spacing property which is used to increase or decrease the space between characters in a text</translate>''<br/><!-- GIDEROSMTD:TextField:setLetterSpacing(spacing) sets the letter-spacing property which is used to increase or decrease the space between characters in a text -->
[[Special:MyLanguage/TextField:setSample|TextField:setSample]] ''<translate>Set string that will be used as sample for determining text's line height</translate>''<br/><!-- GIDEROSMTD:TextField:setSample -->
+
[[Special:MyLanguage/TextField:setSample|TextField:setSample]] ''<translate>Set string that will be used as sample for determining text's line height</translate>''<br/><!-- GIDEROSMTD:TextField:setSample(sample) Set string that will be used as sample for determining text's line height -->
[[Special:MyLanguage/TextField:setText|TextField:setText]] ''<translate>sets the text to be displayed</translate>''<br/><!-- GIDEROSMTD:TextField:setText -->
+
[[Special:MyLanguage/TextField:setText|TextField:setText]] ''<translate>sets the text to be displayed</translate>''<br/><!-- GIDEROSMTD:TextField:setText(text) sets the text to be displayed -->
[[Special:MyLanguage/TextField:setTextColor|TextField:setTextColor]] ''<translate>sets the color of the text in a text field in hexadecimal format</translate>''<br/><!-- GIDEROSMTD:TextField:setTextColor -->
+
[[Special:MyLanguage/TextField:setTextColor|TextField:setTextColor]] ''<translate>sets the color of the text in a text field in hexadecimal format</translate>''<br/><!-- GIDEROSMTD:TextField:setTextColor(color) sets the color of the text in a text field in hexadecimal format -->
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== <translate>Events</translate> ===
 
=== <translate>Events</translate> ===
 
=== <translate>Constants</translate> ===
 
=== <translate>Constants</translate> ===
 
|}
 
|}

Revision as of 15:33, 13 September 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(&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