GridLayout

public class GridLayout
extends ViewGroup

java.lang.Object
↳	android.view.View
	↳	android.view.ViewGroup
		↳	android.support.v7.widget.GridLayout

---

A layout that places its children in a rectangular grid.

The grid is composed of a set of infinitely thin lines that separate the viewing area into cells. Throughout the API, grid lines are referenced by grid indices. A grid with N columns has N + 1 grid indices that run from 0 through N inclusive. Regardless of how GridLayout is configured, grid index 0 is fixed to the leading edge of the container and grid index N is fixed to its trailing edge (after padding is taken into account).

Row and Column Specs

Children occupy one or more contiguous cells, as defined by their rowSpec and columnSpec layout parameters. Each spec defines the set of rows or columns that are to be occupied; and how children should be aligned within the resulting group of cells. Although cells do not normally overlap in a GridLayout, GridLayout does not prevent children being defined to occupy the same cell or group of cells. In this case however, there is no guarantee that children will not themselves overlap after the layout operation completes.

Default Cell Assignment

If a child does not specify the row and column indices of the cell it wishes to occupy, GridLayout assigns cell locations automatically using its: orientation, rowCount and columnCount properties.

Space

Space between children may be specified either by using instances of the dedicated Space view or by setting the leftMargin, topMargin, rightMargin and bottomMargin layout parameters. When the useDefaultMargins property is set, default margins around children are automatically allocated based on the prevailing UI style guide for the platform. Each of the margins so defined may be independently overridden by an assignment to the appropriate layout parameter. Default values will generally produce a reasonable spacing between components but values may change between different releases of the platform.

Excess Space Distribution

GridLayout's distribution of excess space accommodates the principle of weight. In the event that no weights are specified, columns and rows are taken as flexible if their views specify some form of alignment within their groups.

The flexibility of a view is therefore influenced by its alignment which is, in turn, typically defined by setting the gravity property of the child's layout parameters. If either a weight or alignment were defined along a given axis then the component is taken as flexible in that direction. If no weight or alignment was set, the component is instead assumed to be inflexible.

Multiple components in the same row or column group are considered to act in parallel. Such a group is flexible only if all of the components within it are flexible. Row and column groups that sit either side of a common boundary are instead considered to act in series. The composite group made of these two elements is flexible if one of its elements is flexible.

To make a column stretch, make sure all of the components inside it define a weight or a gravity. To prevent a column from stretching, ensure that one of the components in the column does not define a weight or a gravity.

When the principle of flexibility does not provide complete disambiguation, GridLayout's algorithms favour rows and columns that are closer to its right and bottom edges. To be more precise, GridLayout treats each of its layout parameters as a constraint in the a set of variables that define the grid-lines along a given axis. During layout, GridLayout solves the constraints so as to return the unique solution to those constraints for which all variables are less-than-or-equal-to the corresponding value in any other valid solution.

Interpretation of GONE

For layout purposes, GridLayout treats views whose visibility status is GONE, as having zero width and height. This is subtly different from the policy of ignoring views that are marked as GONE outright. If, for example, a gone-marked view was alone in a column, that column would itself collapse to zero width if and only if no gravity was defined on the view. If gravity was defined, then the gone-marked view has no effect on the layout and the container should be laid out as if the view had never been added to it. GONE views are taken to have zero weight during excess space distribution.

These statements apply equally to rows as well as columns, and to groups of rows or columns.

See GridLayout.LayoutParams for a full description of the layout parameters used by GridLayout.

Summary

Nested classes
class	GridLayout.Alignment Alignments specify where a view should be placed within a cell group and what size it should be.
class	GridLayout.LayoutParams Layout information associated with each of the children of a GridLayout.
class	GridLayout.Spec A Spec defines the horizontal or vertical characteristics of a group of cells.

Constants
int	ALIGN_BOUNDS This constant is an alignmentMode.
int	ALIGN_MARGINS This constant is an alignmentMode.
int	HORIZONTAL The horizontal orientation.
int	UNDEFINED The constant used to indicate that a value is undefined.
int	VERTICAL The vertical orientation.

Inherited constants
From class android.view.ViewGroup int CLIP_TO_PADDING_MASK int FOCUS_AFTER_DESCENDANTS int FOCUS_BEFORE_DESCENDANTS int FOCUS_BLOCK_DESCENDANTS int LAYOUT_MODE_CLIP_BOUNDS int LAYOUT_MODE_OPTICAL_BOUNDS int PERSISTENT_ALL_CACHES int PERSISTENT_ANIMATION_CACHE int PERSISTENT_NO_CACHE int PERSISTENT_SCROLLING_CACHE
From class android.view.View int ACCESSIBILITY_LIVE_REGION_ASSERTIVE int ACCESSIBILITY_LIVE_REGION_NONE int ACCESSIBILITY_LIVE_REGION_POLITE int AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR String AUTOFILL_HINT_CREDIT_CARD_NUMBER String AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE String AUTOFILL_HINT_EMAIL_ADDRESS String AUTOFILL_HINT_NAME String AUTOFILL_HINT_PASSWORD String AUTOFILL_HINT_PHONE String AUTOFILL_HINT_POSTAL_ADDRESS String AUTOFILL_HINT_POSTAL_CODE String AUTOFILL_HINT_USERNAME int AUTOFILL_TYPE_DATE int AUTOFILL_TYPE_LIST int AUTOFILL_TYPE_NONE int AUTOFILL_TYPE_TEXT int AUTOFILL_TYPE_TOGGLE int DRAG_FLAG_GLOBAL int DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION int DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION int DRAG_FLAG_GLOBAL_URI_READ int DRAG_FLAG_GLOBAL_URI_WRITE int DRAG_FLAG_OPAQUE int DRAWING_CACHE_QUALITY_AUTO int DRAWING_CACHE_QUALITY_HIGH int DRAWING_CACHE_QUALITY_LOW int FIND_VIEWS_WITH_CONTENT_DESCRIPTION int FIND_VIEWS_WITH_TEXT int FOCUSABLE int FOCUSABLES_ALL int FOCUSABLES_TOUCH_MODE int FOCUSABLE_AUTO int FOCUS_BACKWARD int FOCUS_DOWN int FOCUS_FORWARD int FOCUS_LEFT int FOCUS_RIGHT int FOCUS_UP int GONE int HAPTIC_FEEDBACK_ENABLED int IMPORTANT_FOR_ACCESSIBILITY_AUTO int IMPORTANT_FOR_ACCESSIBILITY_NO int IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS int IMPORTANT_FOR_ACCESSIBILITY_YES int IMPORTANT_FOR_AUTOFILL_AUTO int IMPORTANT_FOR_AUTOFILL_NO int IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS int IMPORTANT_FOR_AUTOFILL_YES int IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS int INVISIBLE int KEEP_SCREEN_ON int LAYER_TYPE_HARDWARE int LAYER_TYPE_NONE int LAYER_TYPE_SOFTWARE int LAYOUT_DIRECTION_INHERIT int LAYOUT_DIRECTION_LOCALE int LAYOUT_DIRECTION_LTR int LAYOUT_DIRECTION_RTL int MEASURED_HEIGHT_STATE_SHIFT int MEASURED_SIZE_MASK int MEASURED_STATE_MASK int MEASURED_STATE_TOO_SMALL int NOT_FOCUSABLE int NO_ID int OVER_SCROLL_ALWAYS int OVER_SCROLL_IF_CONTENT_SCROLLS int OVER_SCROLL_NEVER int SCREEN_STATE_OFF int SCREEN_STATE_ON int SCROLLBARS_INSIDE_INSET int SCROLLBARS_INSIDE_OVERLAY int SCROLLBARS_OUTSIDE_INSET int SCROLLBARS_OUTSIDE_OVERLAY int SCROLLBAR_POSITION_DEFAULT int SCROLLBAR_POSITION_LEFT int SCROLLBAR_POSITION_RIGHT int SCROLL_AXIS_HORIZONTAL int SCROLL_AXIS_NONE int SCROLL_AXIS_VERTICAL int SCROLL_INDICATOR_BOTTOM int SCROLL_INDICATOR_END int SCROLL_INDICATOR_LEFT int SCROLL_INDICATOR_RIGHT int SCROLL_INDICATOR_START int SCROLL_INDICATOR_TOP int SOUND_EFFECTS_ENABLED int STATUS_BAR_HIDDEN int STATUS_BAR_VISIBLE int SYSTEM_UI_FLAG_FULLSCREEN int SYSTEM_UI_FLAG_HIDE_NAVIGATION int SYSTEM_UI_FLAG_IMMERSIVE int SYSTEM_UI_FLAG_IMMERSIVE_STICKY int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION int SYSTEM_UI_FLAG_LAYOUT_STABLE int SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR int SYSTEM_UI_FLAG_LIGHT_STATUS_BAR int SYSTEM_UI_FLAG_LOW_PROFILE int SYSTEM_UI_FLAG_VISIBLE int SYSTEM_UI_LAYOUT_FLAGS int TEXT_ALIGNMENT_CENTER int TEXT_ALIGNMENT_GRAVITY int TEXT_ALIGNMENT_INHERIT int TEXT_ALIGNMENT_TEXT_END int TEXT_ALIGNMENT_TEXT_START int TEXT_ALIGNMENT_VIEW_END int TEXT_ALIGNMENT_VIEW_START int TEXT_DIRECTION_ANY_RTL int TEXT_DIRECTION_FIRST_STRONG int TEXT_DIRECTION_FIRST_STRONG_LTR int TEXT_DIRECTION_FIRST_STRONG_RTL int TEXT_DIRECTION_INHERIT int TEXT_DIRECTION_LOCALE int TEXT_DIRECTION_LTR int TEXT_DIRECTION_RTL String VIEW_LOG_TAG int VISIBLE

Fields
public static final GridLayout.Alignment	BASELINE Indicates that a view should be aligned with the baselines of the other views in its cell group.
public static final GridLayout.Alignment	BOTTOM Indicates that a view should be aligned with the bottom edges of the other views in its cell group.
public static final GridLayout.Alignment	CENTER Indicates that a view should be centered with the other views in its cell group.
public static final GridLayout.Alignment	END Indicates that a view should be aligned with the end edges of the other views in its cell group.
public static final GridLayout.Alignment	FILL Indicates that a view should expanded to fit the boundaries of its cell group.
public static final GridLayout.Alignment	LEFT Indicates that a view should be aligned with the left edges of the other views in its cell group.
public static final GridLayout.Alignment	RIGHT Indicates that a view should be aligned with the right edges of the other views in its cell group.
public static final GridLayout.Alignment	START Indicates that a view should be aligned with the start edges of the other views in its cell group.
public static final GridLayout.Alignment	TOP Indicates that a view should be aligned with the top edges of the other views in its cell group.

Inherited fields

From class android.view.View public static final Property<View, Float> ALPHA protected static final int[] EMPTY_STATE_SET protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET protected static final int[] ENABLED_FOCUSED_STATE_SET protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET protected static final int[] ENABLED_SELECTED_STATE_SET protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET protected static final int[] ENABLED_STATE_SET protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET protected static final int[] FOCUSED_SELECTED_STATE_SET protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET protected static final int[] FOCUSED_STATE_SET protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET protected static final int[] PRESSED_ENABLED_STATE_SET protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET protected static final int[] PRESSED_FOCUSED_STATE_SET protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET protected static final int[] PRESSED_SELECTED_STATE_SET protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET protected static final int[] PRESSED_STATE_SET protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET public static final Property<View, Float> ROTATION public static final Property<View, Float> ROTATION_X public static final Property<View, Float> ROTATION_Y public static final Property<View, Float> SCALE_X public static final Property<View, Float> SCALE_Y protected static final int[] SELECTED_STATE_SET protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET public static final Property<View, Float> TRANSLATION_X public static final Property<View, Float> TRANSLATION_Y public static final Property<View, Float> TRANSLATION_Z protected static final int[] WINDOW_FOCUSED_STATE_SET public static final Property<View, Float> X public static final Property<View, Float> Y public static final Property<View, Float> Z

Public constructors
GridLayout(Context context, AttributeSet attrs, int defStyle)
GridLayout(Context context, AttributeSet attrs)
GridLayout(Context context)

Public methods
GridLayout.LayoutParams	generateLayoutParams(AttributeSet attrs)
int	getAlignmentMode() Returns the alignment mode.
int	getColumnCount() Returns the current number of columns.
int	getOrientation() Returns the current orientation.
Printer	getPrinter() Return the printer that will log diagnostics from this layout.
int	getRowCount() Returns the current number of rows.
boolean	getUseDefaultMargins() Returns whether or not this GridLayout will allocate default margins when no corresponding layout parameters are defined.
boolean	isColumnOrderPreserved() Returns whether or not column boundaries are ordered by their grid indices.
boolean	isRowOrderPreserved() Returns whether or not row boundaries are ordered by their grid indices.
void	requestLayout()
void	setAlignmentMode(int alignmentMode) Sets the alignment mode to be used for all of the alignments between the children of this container.
void	setColumnCount(int columnCount) ColumnCount is used only to generate default column/column indices when they are not specified by a component's layout parameters.
void	setColumnOrderPreserved(boolean columnOrderPreserved) When this property is true, GridLayout is forced to place the column boundaries so that their associated grid indices are in ascending order in the view.