Overview

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 GridLayout.LayoutParams.rowSpec and GridLayout.LayoutParams.columnSpec layout parameters. 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.

WRAP_CONTENT and MATCH_PARENT

Because the default values of the GridLayout.LayoutParams and GridLayout.LayoutParams properties are both GridLayout.LayoutParams, 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 GridLayout.LayoutParams from GridLayout.LayoutParams. A component's ability to expand to the size of the parent is instead controlled by the principle of flexibility, as discussed in GridLayout.

Summary

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

Default values

• GridLayout.LayoutParams = GridLayout.LayoutParams
• GridLayout.LayoutParams = GridLayout.LayoutParams
• GridLayout.LayoutParams = 0 when useDefaultMargins is false; otherwise GridLayout.UNDEFINED, to indicate that a default value should be computed on demand.
• GridLayout.LayoutParams = 0 when useDefaultMargins is false; otherwise GridLayout.UNDEFINED, to indicate that a default value should be computed on demand.
• GridLayout.LayoutParams = 0 when useDefaultMargins is false; otherwise GridLayout.UNDEFINED, to indicate that a default value should be computed on demand.
• GridLayout.LayoutParams = 0 when useDefaultMargins is false; otherwise GridLayout.UNDEFINED, to indicate that a default value should be computed on demand.
• GridLayout.LayoutParams.rowSpec.row = GridLayout.UNDEFINED
• GridLayout.LayoutParams.rowSpec.rowSpan = 1
• GridLayout.LayoutParams.rowSpec.alignment = GridLayout.BASELINE
• GridLayout.LayoutParams.rowSpec.weight = 0
• GridLayout.LayoutParams.columnSpec.column = GridLayout.UNDEFINED
• GridLayout.LayoutParams.columnSpec.columnSpan = 1
• GridLayout.LayoutParams.columnSpec.alignment = GridLayout.START
• GridLayout.LayoutParams.columnSpec.weight = 0

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

Summary

Fields
public GridLayout.Spec	columnSpec The spec that defines the horizontal characteristics of the cell group described by these layout parameters.
public GridLayout.Spec	rowSpec The spec that defines the vertical characteristics of the cell group described by these layout parameters.

Constructors
public	LayoutParams() Constructs a new LayoutParams with default values as defined in GridLayout.LayoutParams.
public	LayoutParams(Context context, AttributeSet attrs) Values not defined in the attribute set take the default values defined in GridLayout.LayoutParams.
public	LayoutParams(GridLayout.Spec rowSpec, GridLayout.Spec columnSpec) Constructs a new LayoutParams instance for this rowSpec and columnSpec.
public	LayoutParams(MarginLayoutParams params)
public	LayoutParams(ViewGroup.LayoutParams params)

Methods
public boolean	equals(java.lang.Object o)
public int	hashCode()
protected void	setBaseAttributes(TypedArray attributes, int widthAttr, int heightAttr)
public void	setGravity(int gravity) Describes how the child views are positioned.
from java.lang.Object	clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Fields

The spec that defines the vertical characteristics of the cell group described by these layout parameters. If an assignment is made to this field after a measurement or layout operation has already taken place, a call to ViewGroup must be made to notify GridLayout of the change. GridLayout is normally able to detect when code fails to observe this rule, issue a warning and take steps to compensate for the omission. This facility is implemented on a best effort basis and should not be relied upon in production code - so it is best to include the above calls to remove the warnings as soon as it is practical.

The spec that defines the horizontal characteristics of the cell group described by these layout parameters. If an assignment is made to this field after a measurement or layout operation has already taken place, a call to ViewGroup must be made to notify GridLayout of the change. GridLayout is normally able to detect when code fails to observe this rule, issue a warning and take steps to compensate for the omission. This facility is implemented on a best effort basis and should not be relied upon in production code - so it is best to include the above calls to remove the warnings as soon as it is practical.

Constructors

Constructs a new LayoutParams instance for this rowSpec and columnSpec. All other fields are initialized with default values as defined in GridLayout.LayoutParams.

Parameters:

rowSpec: the rowSpec
columnSpec: the columnSpec

Constructs a new LayoutParams with default values as defined in GridLayout.LayoutParams.

Values not defined in the attribute set take the default values defined in GridLayout.LayoutParams.

Methods

Describes how the child views are positioned. Default is LEFT | BASELINE. See .

Parameters:

gravity: the new gravity value