FontBase:layoutText
From GiderosMobile
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Available since: Gideros 2017.10
Class: FontBase
Description
Computes the layout of the given text according to a given rectangular region size, layout flags and other parameters.
(table) = FontBase:layoutText(text,width,height,flags,letterSpacing,lineSpacing,tabSpace,breakChar)
Refer to TextField:setLayout for a description of the arguments.
The returned table contains the following fields:
- x,y,w,h: computed bounding box of the full text
- lines: the number of lines used to display the text
- parts: information about individual chunks of texts
Each table in the part field of the returned table describes the placement of chunks of text. Their fields are:
- text: the text to display in this chunk
- x,y,w,h: computed bounding box of this chunk
- dx,dy: coordinates to draw this chunk at
- sep: separator character that came just after this chunk in text block
- line: line number this chunk belongs to
Parameters
text: (string)
width: (number)
height: (number)
flags: (number, default=FontBase.TLF_NOWRAP)
letterSpacing: (number, default = 0)
lineSpacing: (number, default = 0)
tabSpace: (number, default = 4)
breakChar: (string) optional
Return values
Returns (table) a table describing how to draw the given text