belongs to Maven artifact com.android.support:gridlayout-v7:28.0.0-alpha1
GridLayout.LayoutParams
public
static
class
GridLayout.LayoutParams
extends ViewGroup.MarginLayoutParams
java.lang.Object | |||
↳ | android.view.ViewGroup.LayoutParams | ||
↳ | android.view.ViewGroup.MarginLayoutParams | ||
↳ | android.support.v7.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 thewidth
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
width
=WRAP_CONTENT
height
=WRAP_CONTENT
topMargin
= 0 whenuseDefaultMargins
isfalse
; otherwiseUNDEFINED
, to indicate that a default value should be computed on demand.leftMargin
= 0 whenuseDefaultMargins
isfalse
; otherwiseUNDEFINED
, to indicate that a default value should be computed on demand.bottomMargin
= 0 whenuseDefaultMargins
isfalse
; otherwiseUNDEFINED
, to indicate that a default value should be computed on demand.rightMargin
= 0 whenuseDefaultMargins
isfalse
; otherwiseUNDEFINED
, to indicate that a default value should be computed on demand.rowSpec
.row
=UNDEFINED
rowSpec
.rowSpan
= 1rowSpec
.alignment
=BASELINE
rowSpec
.weight
= 0columnSpec
.column
=UNDEFINED
columnSpec
.columnSpan
= 1columnSpec
.alignment
=START
columnSpec
.weight
= 0
GridLayout
for a more complete description of the conventions
used by GridLayout in the interpretation of the properties of this class.
Summary
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 |
|
GridLayout.LayoutParams()
Constructs a new LayoutParams with default values as defined in |
|
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 |
Public methods | |
---|---|
boolean
|
equals(Object o)
|
int
|
hashCode()
|
void
|
setGravity(int gravity)
Describes how the child views are positioned. |
Protected methods | |
---|---|
void
|
setBaseAttributes(TypedArray attributes, int widthAttr, int heightAttr)
|
Inherited methods | |
---|---|
From
class
android.view.ViewGroup.MarginLayoutParams
| |
From
class
android.view.ViewGroup.LayoutParams
| |
From
class
java.lang.Object
|
Fields
columnSpec
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
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
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
GridLayout.LayoutParams ()
Constructs a new LayoutParams with default values as defined in GridLayout.LayoutParams
.
GridLayout.LayoutParams
GridLayout.LayoutParams (ViewGroup.LayoutParams params)
Parameters | |
---|---|
params |
ViewGroup.LayoutParams |
GridLayout.LayoutParams
GridLayout.LayoutParams (ViewGroup.MarginLayoutParams params)
Parameters | |
---|---|
params |
ViewGroup.MarginLayoutParams |
GridLayout.LayoutParams
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
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
boolean equals (Object o)
Parameters | |
---|---|
o |
Object |
Returns | |
---|---|
boolean |
hashCode
int hashCode ()
Returns | |
---|---|
int |
setGravity
void setGravity (int gravity)
Describes how the child views are positioned. Default is LEFT | BASELINE
.
See Gravity
.
Parameters | |
---|---|
gravity |
int : the new gravity value |
Protected methods
setBaseAttributes
void setBaseAttributes (TypedArray attributes, int widthAttr, int heightAttr)
Parameters | |
---|---|
attributes |
TypedArray |
widthAttr |
int |
heightAttr |
int |
Annotations
Interfaces
- ActionMenuView.OnMenuItemClickListener
- PopupMenu.OnDismissListener
- PopupMenu.OnMenuItemClickListener
- RecyclerView.ChildDrawingOrderCallback
- RecyclerView.ItemAnimator.ItemAnimatorFinishedListener
- RecyclerView.LayoutManager.LayoutPrefetchRegistry
- RecyclerView.OnChildAttachStateChangeListener
- RecyclerView.OnItemTouchListener
- RecyclerView.RecyclerListener
- RecyclerView.SmoothScroller.ScrollVectorProvider
- SearchView.OnCloseListener
- SearchView.OnQueryTextListener
- SearchView.OnSuggestionListener
- ShareActionProvider.OnShareTargetSelectedListener
- ThemedSpinnerAdapter
- Toolbar.OnMenuItemClickListener
Classes
- ActionMenuView
- ActionMenuView.LayoutParams
- AppCompatAutoCompleteTextView
- AppCompatButton
- AppCompatCheckBox
- AppCompatCheckedTextView
- AppCompatEditText
- AppCompatImageButton
- AppCompatImageView
- AppCompatMultiAutoCompleteTextView
- AppCompatRadioButton
- AppCompatRatingBar
- AppCompatSeekBar
- AppCompatSpinner
- AppCompatTextView
- CardView
- DefaultItemAnimator
- DividerItemDecoration
- GridLayout
- GridLayout.Alignment
- GridLayout.LayoutParams
- GridLayout.Spec
- GridLayoutManager
- GridLayoutManager.DefaultSpanSizeLookup
- GridLayoutManager.LayoutParams
- GridLayoutManager.SpanSizeLookup
- LinearLayoutCompat
- LinearLayoutCompat.LayoutParams
- LinearLayoutManager
- LinearLayoutManager.LayoutChunkResult
- LinearSmoothScroller
- LinearSnapHelper
- ListPopupWindow
- OrientationHelper
- PagerSnapHelper
- PopupMenu
- RecyclerView
- RecyclerView.Adapter
- RecyclerView.AdapterDataObserver
- RecyclerView.EdgeEffectFactory
- RecyclerView.ItemAnimator
- RecyclerView.ItemAnimator.ItemHolderInfo
- RecyclerView.ItemDecoration
- RecyclerView.LayoutManager
- RecyclerView.LayoutManager.Properties
- RecyclerView.LayoutParams
- RecyclerView.OnFlingListener
- RecyclerView.OnScrollListener
- RecyclerView.RecycledViewPool
- RecyclerView.Recycler
- RecyclerView.SimpleOnItemTouchListener
- RecyclerView.SmoothScroller
- RecyclerView.SmoothScroller.Action
- RecyclerView.State
- RecyclerView.ViewCacheExtension
- RecyclerView.ViewHolder
- RecyclerViewAccessibilityDelegate
- RecyclerViewAccessibilityDelegate.ItemDelegate
- SearchView
- ShareActionProvider
- SimpleItemAnimator
- SnapHelper
- StaggeredGridLayoutManager
- StaggeredGridLayoutManager.LayoutParams
- SwitchCompat
- ThemedSpinnerAdapter.Helper
- Toolbar
- Toolbar.LayoutParams
- Toolbar.SavedState
- TooltipCompat