Difference between revisions of "TextField:setLayout"

From GiderosMobile
(→‎Description: added 1 example)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
<languages />
+
'''Available since:''' Gideros 2017.10<br/>
 +
'''Class:''' [[TextField]]<br/>
  
−
'''<translate>Available since</translate>:''' Gideros 2017.10
+
=== Description ===
−
<br/>
+
Changes the layout parameters for this TextField Layout.
 +
<syntaxhighlight lang="lua">
 +
TextField:setLayout(layout)
 +
</syntaxhighlight>
  
−
'''<translate>Class</translate>:''' [[Special:MyLanguage/TextField|TextField]]
+
''layout'' can contain the following fields:
−
<br/>
+
* w, h: width/height of the area to layout the text in
 +
* flags: a combination of [[FontBase Constants|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
 +
* alignX, alignY: relative alignment of the text inside its cell. Defaults to 0.5,0.5. '''Since 2020.7'''
  
−
=== <translate>Description</translate> ===
+
=== Parameters ===
−
<translate>
+
'''layout''': (table) layout parameters<br/>
−
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 [[Special:MyLanguage/FontBase|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 the will be inserted to indicated broken words</translate>
 
−
<br/>
 
  
−
<source lang="lua">
+
=== Example ===
−
TextField:setLayout(layout)
+
<syntaxhighlight lang="lua">
−
</source>
+
-- a string variable
−
<br/>
+
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."
  
−
'''Example'''
+
-- the text field with default system font
−
<br/>
+
local textfield = TextField.new(nil, mystring)
  
−
<source lang="lua">
+
-- we set the string that will be used as sample for determining text line height
−
-- we initialize a text field
+
textfield:setSample(mystring)
−
local textfield = TextField.new(nil, "Some very long text with default system font. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed non risus. Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed, dolor.")
 
  
 
-- then we set the layout: width, height, line spacing and justify center
 
-- then we set the layout: width, height, line spacing and justify center
Line 38: Line 38:
 
textfield:setPosition(50, 50)
 
textfield:setPosition(50, 50)
 
stage:addChild(textfield)
 
stage:addChild(textfield)
−
</source>
+
</syntaxhighlight>
−
<br/>
 
  
−
=== <translate>Parameters</translate> ===
+
{{TextField}}
−
'''layout''': (table) <translate>Layout parameters</translate> <br/>
 
−
 
 
−
 
 
−
<br/>
 

Latest revision as of 02:25, 18 November 2023

Available since: Gideros 2017.10
Class: TextField

Description

Changes the layout parameters for this TextField Layout. 

TextField:setLayout(layout)

layout can contain the following fields:

  • w, h: width/height of the area to layout the text in
  • flags: a 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
  • alignX, alignY: relative alignment of the text inside its cell. Defaults to 0.5,0.5. Since 2020.7

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)



Retrieved from ‘https://wiki.gideros.rocks/index.php?title=TextField:setLayout&oldid=23036’