GridLayout.LayoutParams Class

Definition

[Android.Runtime.Register("android/widget/GridLayout$LayoutParams", DoNotGenerateAcw=true)]
public class GridLayout.LayoutParams : Android.Views.ViewGroup.MarginLayoutParams

[<Android.Runtime.Register("android/widget/GridLayout$LayoutParams", DoNotGenerateAcw=true)>]
type GridLayout.LayoutParams = class
    inherit ViewGroup.MarginLayoutParams

Inheritance

Object

Object

ViewGroup.LayoutParams

ViewGroup.MarginLayoutParams

GridLayout.LayoutParams

Attributes

RegisterAttribute

Remarks

Layout information associated with each of the children of a GridLayout.

GridLayout supports both row and column spanning and arbitrary forms of alignment within each cell group. The fundamental parameters associated with each cell group are gathered into their vertical and horizontal components and stored in the #rowSpec and #columnSpec layout parameters. GridLayout.Spec Specs are immutable structures and may be shared between the layout parameters of different children.

The row and column specs contain the leading and trailing indices along each axis and together specify the four grid indices that delimit the cells of this cell group.

The alignment properties of the row and column specs together specify both aspects of alignment within the cell group. It is also possible to specify a child's alignment within its cell group by using the GridLayout.LayoutParams#setGravity(int) method.

The weight property is also included in Spec and specifies the proportion of any excess space that is due to the associated view.

<h4>WRAP_CONTENT and MATCH_PARENT</h4>

Because the default values of the #width and #height properties are both #WRAP_CONTENT, this value never needs to be explicitly declared in the layout parameters of GridLayout's children. In addition, GridLayout does not distinguish the special size value #MATCH_PARENT from #WRAP_CONTENT. A component's ability to expand to the size of the parent is instead controlled by the principle of <em>flexibility</em>, as discussed in GridLayout.

<h4>Summary</h4>

You should not need to use either of the special size values: WRAP_CONTENT or MATCH_PARENT when configuring the children of a GridLayout.

<h4>Default values</h4>

<ul> <li>#width = #WRAP_CONTENT</li> <li>#height = #WRAP_CONTENT</li> <li>#topMargin = 0 when GridLayout#setUseDefaultMargins(boolean) useDefaultMargins is false; otherwise #UNDEFINED, to indicate that a default value should be computed on demand. </li> <li>#leftMargin = 0 when GridLayout#setUseDefaultMargins(boolean) useDefaultMargins is false; otherwise #UNDEFINED, to indicate that a default value should be computed on demand. </li> <li>#bottomMargin = 0 when GridLayout#setUseDefaultMargins(boolean) useDefaultMargins is false; otherwise #UNDEFINED, to indicate that a default value should be computed on demand. </li> <li>#rightMargin = 0 when GridLayout#setUseDefaultMargins(boolean) useDefaultMargins is false; otherwise #UNDEFINED, to indicate that a default value should be computed on demand. </li> <li>#rowSpec.row = #UNDEFINED</li> <li>#rowSpec.rowSpan = 1 </li> <li>#rowSpec.alignment = #BASELINE</li> <li>#rowSpec.weight = 0 </li> <li>#columnSpec.column = #UNDEFINED</li> <li>#columnSpec.columnSpan = 1 </li> <li>#columnSpec.alignment = #START</li> <li>#columnSpec.weight = 0 </li> </ul>

See GridLayout for a more complete description of the conventions used by GridLayout in the interpretation of the properties of this class.

Java documentation for android.widget.GridLayout.LayoutParams.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

        Values not defined in the attribute set take the default values
        defined in <code data-dev-comment-type="c">LayoutParams</code>.

Fields

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to