Difference between revisions of "TextField:setLayout"
From GiderosMobile
m (formatting + 1 typo) |
|||
Line 2: | Line 2: | ||
<languages /> | <languages /> | ||
− | '''<translate>Available since</translate>:''' Gideros 2017.10 | + | '''<translate>Available since</translate>:''' Gideros 2017.10<br/> |
− | <br/> | + | '''<translate>Class</translate>:''' [[Special:MyLanguage/TextField|TextField]]<br/> |
− | |||
− | '''<translate>Class</translate>:''' [[Special:MyLanguage/TextField|TextField]] | ||
− | <br/> | ||
=== <translate>Description</translate> === | === <translate>Description</translate> === | ||
− | + | Change the layout parameters for this TextField Layout parameters can contain the following fields: | |
− | Change the layout parameters for this TextField | ||
− | |||
* w,h: Width/height of the area to layout the text in | * w,h: Width/height of the area to layout the text in | ||
* flags: A or combination of [[Special:MyLanguage/FontBase|FontBase]].TLF_xxx constants instructing how to layout the text | * flags: A or combination of [[Special:MyLanguage/FontBase|FontBase]].TLF_xxx constants instructing how to layout the text | ||
Line 17: | Line 12: | ||
* lineSpacing: The space to add between each line of the text | * lineSpacing: The space to add between each line of the text | ||
* tabSpace: The size of a tab in space characters increment, default to 4 if unspecified | * tabSpace: The size of a tab in space characters increment, default to 4 if unspecified | ||
− | * breakChar: A string | + | * breakChar: A string that will be inserted to indicated broken words |
− | |||
<source lang="lua"> | <source lang="lua"> | ||
− | + | TextField:setLayout(layout) | |
</source> | </source> | ||
− | |||
− | ''' | + | === <translate>Parameters</translate> === |
− | < | + | '''layout''': (table) <translate>Layout parameters</translate> <br/> |
+ | |||
+ | === <translate>Example</translate> === | ||
<source lang="lua"> | <source lang="lua"> | ||
Line 45: | Line 40: | ||
stage:addChild(textfield) | stage:addChild(textfield) | ||
</source> | </source> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
{{TextField}} | {{TextField}} |
Revision as of 04:34, 7 December 2019
Available since: Gideros 2017.10
Class: TextField
Description
Change the layout parameters for this TextField Layout parameters can contain the following fields:
- w,h: Width/height of the area to layout the text in
- flags: A or combination of FontBase.TLF_xxx constants instructing how to layout the text
- letterSpacing: The space to add between each letter of the text
- lineSpacing: The space to add between each line of the text
- tabSpace: The size of a tab in space characters increment, default to 4 if unspecified
- breakChar: A string that will be inserted to indicated broken words
TextField:setLayout(layout)
Parameters
layout: (table) Layout parameters
Example
-- a string variable
local mystring = "Some very long text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed non risus. Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed, dolor."
-- the text field with default system font
local textfield = TextField.new(nil, mystring)
-- we set the string that will be used as sample for determining text line height
textfield:setSample(mystring)
-- then we set the layout: width, height, line spacing and justify center
textfield:setLayout( {w=200, h=100, lineSpacing=7, flags=FontBase.TLF_CENTER} )
-- finally, we set the text position and add it to stage
textfield:setPosition(50, 50)
stage:addChild(textfield)
- TextField
- TextField.new
- TextField:getLayout
- TextField:getLetterSpacing
- TextField:getLineHeight
- TextField:getPointFromTextPosition
- TextField:getSample
- TextField:getText
- TextField:getTextColor
- TextField:getTextPositionFromPoint
- TextField:setFont
- TextField:setLayout
- TextField:setLetterSpacing
- TextField:setSample
- TextField:setText
- TextField:setTextColor