Skip to content

Most visited

Recently visited

navigation

GridLayout.LayoutParams

public static class GridLayout.LayoutParams
extends ViewGroup.MarginLayoutParams

java.lang.Object
   ↳ android.view.ViewGroup.LayoutParams
     ↳ android.view.ViewGroup.MarginLayoutParams
       ↳ android.widget.GridLayout.LayoutParams


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. 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 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 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 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

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

Summary

XML attributes

android:layout_column The column boundary delimiting the left of the group of cells occupied by this view. 
android:layout_columnSpan The column span: the difference between the right and left boundaries delimiting the group of cells occupied by this view. 
android:layout_columnWeight The relative proportion of horizontal space that should be allocated to this view during excess space distribution. 
android:layout_gravity Gravity specifies how a component should be placed in its group of cells. 
android:layout_row The row boundary delimiting the top of the group of cells occupied by this view. 
android:layout_rowSpan The row span: the difference between the top and bottom boundaries delimiting the group of cells occupied by this view. 
android:layout_rowWeight The relative proportion of vertical space that should be allocated to this view during excess space distribution. 

Inherited XML attributes

From class android.view.ViewGroup.MarginLayoutParams
From class android.view.ViewGroup.LayoutParams

Inherited constants

From class android.view.ViewGroup.LayoutParams

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.

Inherited fields

From class android.view.ViewGroup.MarginLayoutParams
From class android.view.ViewGroup.LayoutParams

Public constructors

GridLayout.LayoutParams(GridLayout.Spec rowSpec, GridLayout.Spec columnSpec)

Constructs a new LayoutParams instance for this rowSpec and columnSpec.

GridLayout.LayoutParams()

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

GridLayout.LayoutParams(ViewGroup.LayoutParams params)

GridLayout.LayoutParams(ViewGroup.MarginLayoutParams params)

GridLayout.LayoutParams(GridLayout.LayoutParams source)

Copy constructor.

GridLayout.LayoutParams(Context context, AttributeSet attrs)

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

Public methods

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

int hashCode()

Returns a hash code value for the object.

void setGravity(int gravity)

Describes how the child views are positioned.

Protected methods

void setBaseAttributes(TypedArray attributes, int widthAttr, int heightAttr)

Extracts the layout parameters from the supplied attributes.

Inherited methods

From class android.view.ViewGroup.MarginLayoutParams
From class android.view.ViewGroup.LayoutParams
From class java.lang.Object

XML attributes

android:layout_column

The column boundary delimiting the left of the group of cells occupied by this view.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_column.

android:layout_columnSpan

The column span: the difference between the right and left boundaries delimiting the group of cells occupied by this view. The default is one. See GridLayout.Spec.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_columnSpan.

android:layout_columnWeight

The relative proportion of horizontal space that should be allocated to this view during excess space distribution.

Must be a floating point value, such as "1.2".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_columnWeight.

android:layout_gravity

Gravity specifies how a component should be placed in its group of cells. The default is LEFT | BASELINE. See setGravity(int).

Must be one or more (separated by '|') of the following constant values.

ConstantValueDescription
top0x30 Push object to the top of its container, not changing its size.
bottom0x50 Push object to the bottom of its container, not changing its size.
left0x03 Push object to the left of its container, not changing its size.
right0x05 Push object to the right of its container, not changing its size.
center_vertical0x10 Place object in the vertical center of its container, not changing its size.
fill_vertical0x70 Grow the vertical size of the object if needed so it completely fills its container.
center_horizontal0x01 Place object in the horizontal center of its container, not changing its size.
fill_horizontal0x07 Grow the horizontal size of the object if needed so it completely fills its container.
center0x11 Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
fill0x77 Grow the horizontal and vertical size of the object if needed so it completely fills its container.
clip_vertical0x80 Additional option that can be set to have the top and/or bottom edges of the child clipped to its container's bounds. The clip will be based on the vertical gravity: a top gravity will clip the bottom edge, a bottom gravity will clip the top edge, and neither will clip both edges.
clip_horizontal0x08 Additional option that can be set to have the left and/or right edges of the child clipped to its container's bounds. The clip will be based on the horizontal gravity: a left gravity will clip the right edge, a right gravity will clip the left edge, and neither will clip both edges.
start0x00800003 Push object to the beginning of its container, not changing its size.
end0x00800005 Push object to the end of its container, not changing its size.

This corresponds to the global attribute resource symbol layout_gravity.

Related methods:

android:layout_row

The row boundary delimiting the top of the group of cells occupied by this view.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_row.

android:layout_rowSpan

The row span: the difference between the top and bottom boundaries delimiting the group of cells occupied by this view. The default is one. See GridLayout.Spec.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_rowSpan.

android:layout_rowWeight

The relative proportion of vertical space that should be allocated to this view during excess space distribution.

Must be a floating point value, such as "1.2".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_rowWeight.

Fields

columnSpec

Added in API level 14
GridLayout.Spec columnSpec

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 setLayoutParams(ViewGroup.LayoutParams) 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.

rowSpec

Added in API level 14
GridLayout.Spec rowSpec

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 setLayoutParams(ViewGroup.LayoutParams) 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.

Public constructors

GridLayout.LayoutParams

Added in API level 14
GridLayout.LayoutParams (GridLayout.Spec rowSpec, 
                GridLayout.Spec columnSpec)

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 GridLayout.Spec: the rowSpec
columnSpec GridLayout.Spec: the columnSpec

GridLayout.LayoutParams

Added in API level 14
GridLayout.LayoutParams ()

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

GridLayout.LayoutParams

Added in API level 14
GridLayout.LayoutParams (ViewGroup.LayoutParams params)

Parameters
params ViewGroup.LayoutParams

GridLayout.LayoutParams

Added in API level 14
GridLayout.LayoutParams (ViewGroup.MarginLayoutParams params)

Parameters
params ViewGroup.MarginLayoutParams

GridLayout.LayoutParams

Added in API level 14
GridLayout.LayoutParams (GridLayout.LayoutParams source)

Copy constructor. Clones the width, height, margin values, row spec, and column spec of the source.

Parameters
source GridLayout.LayoutParams: The layout params to copy from.

GridLayout.LayoutParams

Added in API level 14
GridLayout.LayoutParams (Context context, 
                AttributeSet attrs)

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

Parameters
context Context
attrs AttributeSet

Public methods

equals

Added in API level 14
boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

hashCode

Added in API level 14
int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
int a hash code value for this object.

setGravity

Added in API level 14
void setGravity (int gravity)

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

Related XML Attributes:

Parameters
gravity int: the new gravity value

Protected methods

setBaseAttributes

Added in API level 14
void setBaseAttributes (TypedArray attributes, 
                int widthAttr, 
                int heightAttr)

Extracts the layout parameters from the supplied attributes.

Parameters
attributes TypedArray: the style attributes to extract the parameters from
widthAttr int: the identifier of the width attribute
heightAttr int: the identifier of the height attribute
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.