Added in API level 14

Summary: XML Attrs | Inherited XML Attrs | Inherited Constants | Fields | Inherited Fields | Ctors | Methods | Protected Methods | Inherited Methods

GridLayout.LayoutParams

---

Kotlin |Java

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 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 ViewGroup.LayoutParams.width and ViewGroup.LayoutParams.height properties are both ViewGroup.LayoutParams.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 ViewGroup.LayoutParams.MATCH_PARENT from ViewGroup.LayoutParams.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

• ViewGroup.LayoutParams.width = ViewGroup.LayoutParams.WRAP_CONTENT
• ViewGroup.LayoutParams.height = ViewGroup.LayoutParams.WRAP_CONTENT
• ViewGroup.MarginLayoutParams.topMargin = 0 when useDefaultMargins is false; otherwise GridLayout.UNDEFINED, to indicate that a default value should be computed on demand.
• ViewGroup.MarginLayoutParams.leftMargin = 0 when useDefaultMargins is false; otherwise GridLayout.UNDEFINED, to indicate that a default value should be computed on demand.
• ViewGroup.MarginLayoutParams.bottomMargin = 0 when useDefaultMargins is false; otherwise GridLayout.UNDEFINED, to indicate that a default value should be computed on demand.
• ViewGroup.MarginLayoutParams.rightMargin = 0 when useDefaultMargins is false; otherwise GridLayout.UNDEFINED, to indicate that a default value should be computed on demand.
• rowSpec.row = GridLayout.UNDEFINED
• rowSpec.rowSpan = 1
• rowSpec.alignment = GridLayout.BASELINE
• rowSpec.weight = 0
• columnSpec.column = GridLayout.UNDEFINED
• columnSpec.columnSpan = 1
• columnSpec.alignment = GridLayout.START
• 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

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 android:layout_margin Specifies extra space on the left, top, right and bottom sides of this view.  android:layout_marginBottom Specifies extra space on the bottom side of this view.  android:layout_marginEnd Specifies extra space on the end side of this view.  android:layout_marginHorizontal Specifies extra space on the left and right sides of this view.  android:layout_marginLeft Specifies extra space on the left side of this view.  android:layout_marginRight Specifies extra space on the right side of this view.  android:layout_marginStart Specifies extra space on the start side of this view.  android:layout_marginTop Specifies extra space on the top side of this view.  android:layout_marginVertical Specifies extra space on the top and bottom sides of this view.
From class android.view.ViewGroup.LayoutParams android:layout_height Specifies the basic height of the view.  android:layout_width Specifies the basic width of the view.

Inherited constants
From class android.view.ViewGroup.LayoutParams int FILL_PARENT Special value for the height or width requested by a View. int MATCH_PARENT Special value for the height or width requested by a View. int WRAP_CONTENT Special value for the height or width requested by a View.

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 public int bottomMargin The bottom margin in pixels of the child. public int leftMargin The left margin in pixels of the child. public int rightMargin The right margin in pixels of the child. public int topMargin The top margin in pixels of the child.
From class android.view.ViewGroup.LayoutParams public int height Information about how tall the view wants to be. public LayoutAnimationController.AnimationParameters layoutAnimationParameters Used to animate layouts. public int width Information about how wide the view wants to be.

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

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 int getLayoutDirection() Retuns the layout direction. int getMarginEnd() Returns the end margin in pixels. int getMarginStart() Returns the start margin in pixels. boolean isMarginRelative() Check if margins are relative. void resolveLayoutDirection(int layoutDirection) This will be called by View.requestLayout(). void setLayoutDirection(int layoutDirection) Set the layout direction void setMarginEnd(int end) Sets the relative end margin. void setMarginStart(int start) Sets the relative start margin. void setMargins(int left, int top, int right, int bottom) Sets the margins, in pixels.
From class android.view.ViewGroup.LayoutParams void resolveLayoutDirection(int layoutDirection) Resolve layout parameters depending on the layout direction. void setBaseAttributes(TypedArray a, int widthAttr, int heightAttr) Extracts the layout parameters from the supplied attributes.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

XML attributes

android:layout_column

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

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

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.

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

android:layout_columnWeight

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

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

android:layout_gravity

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

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

Constant	Value	Description
bottom	50	Push object to the bottom of its container, not changing its size.
center	11	Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
center_horizontal	1	Place object in the horizontal center of its container, not changing its size.
center_vertical	10	Place object in the vertical center of its container, not changing its size.
clip_horizontal	8	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.
clip_vertical	80	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.
end	800005	Push object to the end of its container, not changing its size.
fill	77	Grow the horizontal and vertical size of the object if needed so it completely fills its container.
fill_horizontal	7	Grow the horizontal size of the object if needed so it completely fills its container.
fill_vertical	70	Grow the vertical size of the object if needed so it completely fills its container.
left	3	Push object to the left of its container, not changing its size.
right	5	Push object to the right of its container, not changing its size.
start	800003	Push object to the beginning of its container, not changing its size.
top	30	Push object to the top of its container, not changing its size.

Related methods:

• setGravity(int)

android:layout_row

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

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

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.

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

android:layout_rowWeight

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

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

Fields

columnSpec

Added in API level 14

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

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

LayoutParams

Added in API level 14

public LayoutParams ()

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

LayoutParams

Added in API level 14

public LayoutParams (Context context, 
                AttributeSet attrs)

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

Parameters
context	Context
attrs	AttributeSet

LayoutParams

Added in API level 14

public LayoutParams (ViewGroup.LayoutParams params)

Parameters
params	ViewGroup.LayoutParams

LayoutParams

Added in API level 14

public LayoutParams (ViewGroup.MarginLayoutParams params)

Parameters
params	ViewGroup.MarginLayoutParams

LayoutParams

Added in API level 14

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

LayoutParams

Added in API level 14

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

Parameters
rowSpec	GridLayout.Spec: the rowSpec
columnSpec	GridLayout.Spec: the columnSpec

Public methods

equals

Added in API level 14

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

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

hashCode

Added in API level 14

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

Returns
int	a hash code value for this object.

setGravity

Added in API level 14

public void setGravity (int gravity)

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

Related XML Attributes:

• android:layout_gravity

Parameters
gravity	int: the new gravity value

Protected methods

setBaseAttributes

Added in API level 14

protected 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