TextField:setLayout

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)

---

• 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

---

---

• Main Page
• Lua API
• Main API
• Plugins