Difference between revisions of "Sprite:setLayoutParameters"

From GiderosMobile
(Created page with "__NOTOC__ '''<translate>Available since</translate>:''' Gideros 2018.9<br/> '''<translate>Class</translate>:''' Sprite<br/> === <translate>Descri...")
 
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
<languages />
 
'''<translate>Available since</translate>:''' Gideros 2018.9<br/>
 
'''<translate>Available since</translate>:''' Gideros 2018.9<br/>
 
'''<translate>Class</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
 
'''<translate>Class</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
Line 6: Line 7:
 
<br />
 
<br />
 
Gideros Layout arranges a sprite's children into cells of a grid. With this method, you tell the parent's sprite how the rows and columns of the layout grid should be sized.
 
Gideros Layout arranges a sprite's children into cells of a grid. With this method, you tell the parent's sprite how the rows and columns of the layout grid should be sized.
If there is extra space available after applygin minimum widths and heights, it is distributed according to relative weights of each row/column.
+
If there is extra space available after applying minimum widths and heights, it is distributed according to relative weights of each row/column.
 +
Gideros layout system is heavily based on Java GridBagLayout principle. See here for more explanation:
 +
https://www.math.uni-hamburg.de/doc/java/tutorial/uiswing/layout/gridbag.html
  
 
The following parameters apply:
 
The following parameters apply:
* ''columnWidths'': an array of minimum width for each column<br/>
+
* '''columnWidths''': an array of minimum width for each column<br/>
* ''rowHeights'': an array of minimum height for each row<br/>
+
* '''rowHeights''': an array of minimum height for each row<br/>
* ''columnWeights'': an array of relative weights for each column<br/>
+
* '''columnWeights''': an array of relative weights for each column<br/>
* ''rowWeights'': an array of relative weights for each row<br/>
+
* '''rowWeights''': an array of relative weights for each row<br/>
* ''insetTop'': the top margin<br/>
+
* '''insetTop''': the top margin<br/>
* ''insetLeft'': the left margin<br/>
+
* '''insetLeft''': the left margin<br/>
* ''insetBottom'': the bottom margin<br/>
+
* '''insetBottom''': the bottom margin<br/>
* ''insetRight'': the right margin<br/></translate>
+
* '''insetRight''': the right margin<br/>
 +
 
 +
Specifying a '''nil''' table will clear layout parameters.</translate>
 
<source lang="lua">
 
<source lang="lua">
 
  Sprite:setLayoutParameters(layout)
 
  Sprite:setLayoutParameters(layout)

Revision as of 09:59, 3 September 2018


Available since: Gideros 2018.9
Class: Sprite

Description



Gideros Layout arranges a sprite's children into cells of a grid. With this method, you tell the parent's sprite how the rows and columns of the layout grid should be sized. If there is extra space available after applying minimum widths and heights, it is distributed according to relative weights of each row/column. Gideros layout system is heavily based on Java GridBagLayout principle. See here for more explanation: https://www.math.uni-hamburg.de/doc/java/tutorial/uiswing/layout/gridbag.html

The following parameters apply:

  • columnWidths: an array of minimum width for each column
  • rowHeights: an array of minimum height for each row
  • columnWeights: an array of relative weights for each column
  • rowWeights: an array of relative weights for each row
  • insetTop: the top margin
  • insetLeft: the left margin
  • insetBottom: the bottom margin
  • insetRight: the right margin

Specifying a nil table will clear layout parameters.

 Sprite:setLayoutParameters(layout)

Parameters

layout: (table) Table of layout parameters.