CoordinatorLayout.LayoutParams

Artifact: androidx.coordinatorlayout:coordinatorlayout

Added in 1.1.0

Kotlin |Java

public class CoordinatorLayout.LayoutParams extends ViewGroup.MarginLayoutParams

java.lang.Object
↳	android.view.ViewGroup.LayoutParams
	↳	android.view.ViewGroup.MarginLayoutParams
		↳	androidx.coordinatorlayout.widget.CoordinatorLayout.LayoutParams

Parameters describing the desired layout for a child of a CoordinatorLayout.

Summary

Public fields
`int`	`anchorGravity` A `Gravity` value describing which edge of a child view's `anchor` view the child should position itself relative to.
`int`	`dodgeInsetEdges` A `Gravity` value describing how this child view dodges any inset child views in the CoordinatorLayout.
`int`	`gravity` A `Gravity` value describing how this child view should lay out.
`int`	`insetEdge` A `Gravity` value describing how this child view insets the CoordinatorLayout.
`int`	`keyline` The index of the horizontal keyline specified to the parent CoordinatorLayout that this child should align relative to.

Public constructors
`LayoutParams(@NonNull CoordinatorLayout.LayoutParams p)`
`LayoutParams(@NonNull ViewGroup.LayoutParams p)`
`LayoutParams(@NonNull ViewGroup.MarginLayoutParams p)`
`LayoutParams(int width, int height)`

Public methods
`@IdRes int`	`getAnchorId()` Get the id of this view's anchor.
`@Nullable CoordinatorLayout.Behavior`	`getBehavior()` Get the behavior governing the layout and interaction of the child view within a parent CoordinatorLayout.
`void`	`setAnchorId(@IdRes int id)` Set the id of this view's anchor.
`void`	`setBehavior(@Nullable CoordinatorLayout.Behavior behavior)` Set the behavior governing the layout and interaction of the child view within a parent CoordinatorLayout.

Inherited Constants

From android.view.ViewGroup.LayoutParams

`static final int`	`FILL_PARENT = -1` This field is deprecated.
`static final int`	`MATCH_PARENT = -1`
`static final int`	`WRAP_CONTENT = -2`

Inherited fields

From android.view.ViewGroup.LayoutParams

`int`	`height`
`LayoutAnimationController.AnimationParameters`	`layoutAnimationParameters`
`int`	`width`

From android.view.ViewGroup.MarginLayoutParams

`int`	`bottomMargin`
`int`	`leftMargin`
`int`	`rightMargin`
`int`	`topMargin`

Inherited methods

From android.view.ViewGroup.LayoutParams

void

setBaseAttributes(TypedArray a, int widthAttr, int heightAttr)

From android.view.ViewGroup.MarginLayoutParams

`int`	`getLayoutDirection()`
`int`	`getMarginEnd()`
`int`	`getMarginStart()`
`boolean`	`isMarginRelative()`
`void`	`resolveLayoutDirection(int layoutDirection)`
`void`	`setLayoutDirection(int layoutDirection)`
`void`	`setMarginEnd(int end)`
`void`	`setMarginStart(int start)`
`void`	`setMargins(int left, int top, int right, int bottom)`

Public fields

anchorGravity

Added in 1.1.0

public int anchorGravity

A Gravity value describing which edge of a child view's anchor view the child should position itself relative to.

dodgeInsetEdges

Added in 1.1.0

public int dodgeInsetEdges

A Gravity value describing how this child view dodges any inset child views in the CoordinatorLayout. Any views which are inset on the same edge as this view is set to dodge will result in this view being moved so that the views do not overlap.

gravity

Added in 1.1.0

public int gravity

A Gravity value describing how this child view should lay out. If either or both of the axes are not specified, they are treated by CoordinatorLayout as TOP or START. If an anchor is also specified, the gravity describes how this child view should be positioned relative to its anchored position.

insetEdge

Added in 1.1.0

public int insetEdge

A Gravity value describing how this child view insets the CoordinatorLayout. Other child views which are set to dodge the same inset edges will be moved appropriately so that the views do not overlap.

keyline

Added in 1.1.0

public int keyline

The index of the horizontal keyline specified to the parent CoordinatorLayout that this child should align relative to. If an anchor is present the keyline will be ignored.

Public constructors

Added in 1.1.0

public LayoutParams(@NonNull CoordinatorLayout.LayoutParams p)

LayoutParams

Added in 1.1.0

public LayoutParams(@NonNull ViewGroup.LayoutParams p)

LayoutParams

Added in 1.1.0

public LayoutParams(@NonNull ViewGroup.MarginLayoutParams p)

LayoutParams

Added in 1.1.0

public LayoutParams(int width, int height)

Public methods

getAnchorId

Added in 1.1.0

public @IdRes int getAnchorId()

Get the id of this view's anchor.

Returns
`@IdRes int`	A `view id` or `NO_ID` if there is no anchor

getBehavior

Added in 1.1.0

public @Nullable CoordinatorLayout.Behavior getBehavior()

Get the behavior governing the layout and interaction of the child view within a parent CoordinatorLayout.

Returns
`@Nullable CoordinatorLayout.Behavior`	The current behavior or null if no behavior is specified

setAnchorId

Added in 1.1.0

public void setAnchorId(@IdRes int id)

Set the id of this view's anchor.

The view with this id must be a descendant of the CoordinatorLayout containing the child view this LayoutParams belongs to. It may not be the child view with this LayoutParams or a descendant of it.

Parameters
`@IdRes int id`	The `view id` of the anchor or `NO_ID` if there is no anchor

Added in 1.1.0

public void setBehavior(@Nullable CoordinatorLayout.Behavior behavior)

Set the behavior governing the layout and interaction of the child view within a parent CoordinatorLayout.

Setting a new behavior will remove any currently associated Behavior tag.

Parameters
`@Nullable CoordinatorLayout.Behavior behavior`	The behavior to set or null for no special behavior