LayoutParams

Kotlin |Java

open class LayoutParams : ViewGroup.MarginLayoutParams

kotlin.Any
↳	android.view.ViewGroup.LayoutParams
	↳	android.view.ViewGroup.MarginLayoutParams
		↳	android.widget.RelativeLayout.LayoutParams

Specifies how a view is positioned within a RelativeLayout. The relative layout containing the view uses the value of these layout parameters to determine where to position the view on the screen. If the view is not contained within a relative layout, these attributes are ignored. See the Relative Layout guide for example code demonstrating how to use relative layout's layout parameters in a layout XML. To learn more about layout parameters and how they differ from typical view attributes, see the Layouts guide.

Summary

XML attributes
`android:layout_above`	Positions the bottom edge of this view above the given anchor view ID.
`android:layout_alignBaseline`	Positions the baseline of this view on the baseline of the given anchor view ID.
`android:layout_alignBottom`	Makes the bottom edge of this view match the bottom edge of the given anchor view ID.
`android:layout_alignEnd`	Makes the end edge of this view match the end edge of the given anchor view ID.
`android:layout_alignLeft`	Makes the left edge of this view match the left edge of the given anchor view ID.
`android:layout_alignParentBottom`	If true, makes the bottom edge of this view match the bottom edge of the parent.
`android:layout_alignParentEnd`	If true, makes the end edge of this view match the end edge of the parent.
`android:layout_alignParentLeft`	If true, makes the left edge of this view match the left edge of the parent.
`android:layout_alignParentRight`	If true, makes the right edge of this view match the right edge of the parent.
`android:layout_alignParentStart`	If true, makes the start edge of this view match the start edge of the parent.
`android:layout_alignParentTop`	If true, makes the top edge of this view match the top edge of the parent.
`android:layout_alignRight`	Makes the right edge of this view match the right edge of the given anchor view ID.
`android:layout_alignStart`	Makes the start edge of this view match the start edge of the given anchor view ID.
`android:layout_alignTop`	Makes the top edge of this view match the top edge of the given anchor view ID.
`android:layout_alignWithParentIfMissing`	If set to true, the parent will be used as the anchor when the anchor cannot be be found for layout_toLeftOf, layout_toRightOf, etc.
`android:layout_below`	Positions the top edge of this view below the given anchor view ID.
`android:layout_centerHorizontal`	If true, centers this child horizontally within its parent.
`android:layout_centerInParent`	If true, centers this child horizontally and vertically within its parent.
`android:layout_centerVertical`	If true, centers this child vertically within its parent.
`android:layout_toEndOf`	Positions the start edge of this view to the end of the given anchor view ID.
`android:layout_toLeftOf`	Positions the right edge of this view to the left of the given anchor view ID.
`android:layout_toRightOf`	Positions the left edge of this view to the right of the given anchor view ID.
`android:layout_toStartOf`	Positions the end edge of this view to the start of the given anchor view ID.

Inherited XML attributes

From class LayoutParams

android:layout_height

Specifies the basic height of the view. This is a required attribute for any view inside of a containing layout manager. Its value may be a dimension (such as "12dip") for a constant height or one of the special constants.

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

Must be one of the following constant values.

Constant	Value	Description
fill_parent	ffffffff	The view should be as big as its parent (minus padding). This constant is deprecated starting from API Level 8 and is replaced by `match_parent`.
match_parent	ffffffff	The view should be as big as its parent (minus padding). Introduced in API Level 8.
wrap_content	fffffffe	The view should be only big enough to enclose its content (plus padding).

android:layout_width

Specifies the basic width of the view. This is a required attribute for any view inside of a containing layout manager. Its value may be a dimension (such as "12dip") for a constant width or one of the special constants.

Must be one of the following constant values.

Constant	Value	Description
fill_parent	ffffffff	The view should be as big as its parent (minus padding). This constant is deprecated starting from API Level 8 and is replaced by `match_parent`.
match_parent	ffffffff	The view should be as big as its parent (minus padding). Introduced in API Level 8.
wrap_content	fffffffe	The view should be only big enough to enclose its content (plus padding).

From class MarginLayoutParams

`android:layout_margin`	Specifies extra space on the left, top, right and bottom sides of this view. If both layout_margin and any of layout_marginLeft, layout_marginRight, layout_marginStart, layout_marginEnd, layout_marginTop, and layout_marginBottom are also specified, the layout_margin value will take precedence over the edge-specific values. This space is outside this view's bounds. Margin values should be positive. May be a dimension value, which is a floating point number appended with a unit such as "`14.5sp`". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
`android:layout_marginBottom`	Specifies extra space on the bottom side of this view. This space is outside this view's bounds. Margin values should be positive. May be a dimension value, which is a floating point number appended with a unit such as "`14.5sp`". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
`android:layout_marginEnd`	Specifies extra space on the end side of this view. This space is outside this view's bounds. Margin values should be positive. May be a dimension value, which is a floating point number appended with a unit such as "`14.5sp`". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
`android:layout_marginHorizontal`	Specifies extra space on the left and right sides of this view. Specifying layout_marginHorizontal is equivalent to specifying layout_marginLeft and layout_marginRight. If both layout_marginHorizontal and either/both of layout_marginLeft and layout_marginRight are also specified, the layout_marginHorizontal value will take precedence over the edge-specific values. Also, layout_margin will always take precedence over any of these values, including layout_marginHorizontal. This space is outside this view's bounds. Margin values should be positive. May be a dimension value, which is a floating point number appended with a unit such as "`14.5sp`". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
`android:layout_marginLeft`	Specifies extra space on the left side of this view. This space is outside this view's bounds. Margin values should be positive. May be a dimension value, which is a floating point number appended with a unit such as "`14.5sp`". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
`android:layout_marginRight`	Specifies extra space on the right side of this view. This space is outside this view's bounds. Margin values should be positive. May be a dimension value, which is a floating point number appended with a unit such as "`14.5sp`". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
`android:layout_marginStart`	Specifies extra space on the start side of this view. This space is outside this view's bounds. Margin values should be positive. May be a dimension value, which is a floating point number appended with a unit such as "`14.5sp`". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
`android:layout_marginTop`	Specifies extra space on the top side of this view. This space is outside this view's bounds. Margin values should be positive. May be a dimension value, which is a floating point number appended with a unit such as "`14.5sp`". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
`android:layout_marginVertical`	Specifies extra space on the top and bottom sides of this view. Specifying layout_marginVertical is equivalent to specifying layout_marginTop and layout_marginBottom with that same value. If both layout_marginVertical and either/both of layout_marginTop and layout_marginBottom are also specified, the layout_marginVertical value will take precedence over the edge-specific values. Also, layout_margin will always take precedence over any of these values, including layout_marginVertical. This space is outside this view's bounds. Margin values should be positive. May be a dimension value, which is a floating point number appended with a unit such as "`14.5sp`". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

Inherited constants

From class LayoutParams

Int

FILL_PARENT

Special value for the height or width requested by a View. FILL_PARENT means that the view wants to be as big as its parent, minus the parent's padding, if any. This value is deprecated starting in API Level 8 and replaced by MATCH_PARENT.

Int

MATCH_PARENT

Special value for the height or width requested by a View. MATCH_PARENT means that the view wants to be as big as its parent, minus the parent's padding, if any. Introduced in API Level 8.

Int

WRAP_CONTENT

Special value for the height or width requested by a View. WRAP_CONTENT means that the view wants to be just large enough to fit its own internal content, taking its own padding into account.

Public constructors
`LayoutParams(c: Context!, attrs: AttributeSet!)`
`LayoutParams(source: ViewGroup.LayoutParams!)`
`LayoutParams(source: ViewGroup.MarginLayoutParams!)`
`LayoutParams(source: RelativeLayout.LayoutParams!)` Copy constructor.
`LayoutParams(w: Int, h: Int)`

Public methods
open Unit	`addRule(verb: Int)` Adds a layout rule to be interpreted by the RelativeLayout.
open Unit	`addRule(verb: Int, subject: Int)` Adds a layout rule to be interpreted by the RelativeLayout.
open String!	`debug(output: String!)`
open Int	`getRule(verb: Int)` Returns the layout rule associated with a specific verb.
open IntArray!	`getRules()` Retrieves a complete list of all supported rules, where the index is the rule verb, and the element value is the value specified, or "false" if it was never set.
open Unit	`removeRule(verb: Int)` Removes a layout rule to be interpreted by the RelativeLayout.
open Unit	`resolveLayoutDirection(layoutDirection: Int)` This will be called by `android.view.View#requestLayout()` to resolve layout parameters that are relative to the layout direction.

Inherited functions

From class MarginLayoutParams

`Int`	`getLayoutDirection()` Retuns the layout direction. Can be either `View.LAYOUT_DIRECTION_LTR` or `View.LAYOUT_DIRECTION_RTL`.
`Int`	`getMarginEnd()` Returns the end margin in pixels.
`Int`	`getMarginStart()` Returns the start margin in pixels.
`Boolean`	`isMarginRelative()` Check if margins are relative.
`Unit`	`setLayoutDirection(layoutDirection: Int)` Set the layout direction
`Unit`	`setMarginEnd(end: Int)` Sets the relative end margin. Margin values should be positive.
`Unit`	`setMarginStart(start: Int)` Sets the relative start margin. Margin values should be positive.
`Unit`	`setMargins(left: Int, top: Int, right: Int, bottom: Int)` Sets the margins, in pixels. A call to `android.view.View#requestLayout()` needs to be done so that the new margins are taken into account. Left and right margins may be overridden by `android.view.View#requestLayout()` depending on layout direction. Margin values should be positive.

From class LayoutParams

Unit

setBaseAttributes(a: TypedArray!, widthAttr: Int, heightAttr: Int)

Extracts the layout parameters from the supplied attributes.

Properties
Boolean	`alignWithParent` When true, uses the parent as the anchor if the anchor doesn't exist or if the anchor's visibility is GONE.

Inherited properties

From class MarginLayoutParams

`Int`	`bottomMargin` The bottom margin in pixels of the child. Margin values should be positive. Call `ViewGroup.setLayoutParams(LayoutParams)` after reassigning a new value to this field.
`Int`	`leftMargin` The left margin in pixels of the child. Margin values should be positive. Call `ViewGroup.setLayoutParams(LayoutParams)` after reassigning a new value to this field.
`Int`	`rightMargin` The right margin in pixels of the child. Margin values should be positive. Call `ViewGroup.setLayoutParams(LayoutParams)` after reassigning a new value to this field.
`Int`	`topMargin` The top margin in pixels of the child. Margin values should be positive. Call `ViewGroup.setLayoutParams(LayoutParams)` after reassigning a new value to this field.

From class LayoutParams

Int

height

Information about how tall the view wants to be. Can be one of the constants FILL_PARENT (replaced by MATCH_PARENT in API Level 8) or WRAP_CONTENT, or an exact size.

LayoutAnimationController.AnimationParameters!

layoutAnimationParameters

Used to animate layouts.

Int

width

Information about how wide the view wants to be. Can be one of the constants FILL_PARENT (replaced by MATCH_PARENT in API Level 8) or WRAP_CONTENT, or an exact size.

XML attributes

android:layout_above

android:layout_above

Positions the bottom edge of this view above the given anchor view ID. Accommodates bottom margin of this view and top margin of anchor view.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_alignBaseline

android:layout_alignBaseline

Positions the baseline of this view on the baseline of the given anchor view ID.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_alignBottom

android:layout_alignBottom

Makes the bottom edge of this view match the bottom edge of the given anchor view ID. Accommodates bottom margin.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_alignEnd

android:layout_alignEnd

Makes the end edge of this view match the end edge of the given anchor view ID. Accommodates end margin.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_alignLeft

android:layout_alignLeft

Makes the left edge of this view match the left edge of the given anchor view ID. Accommodates left margin.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_alignParentBottom

android:layout_alignParentBottom

If true, makes the bottom edge of this view match the bottom edge of the parent. Accommodates bottom margin.

May be a boolean value, such as "true" or "false".

android:layout_alignParentEnd

android:layout_alignParentEnd

If true, makes the end edge of this view match the end edge of the parent. Accommodates end margin.

May be a boolean value, such as "true" or "false".

android:layout_alignParentLeft

android:layout_alignParentLeft

If true, makes the left edge of this view match the left edge of the parent. Accommodates left margin.

May be a boolean value, such as "true" or "false".

android:layout_alignParentRight

android:layout_alignParentRight

If true, makes the right edge of this view match the right edge of the parent. Accommodates right margin.

May be a boolean value, such as "true" or "false".

android:layout_alignParentStart

android:layout_alignParentStart

If true, makes the start edge of this view match the start edge of the parent. Accommodates start margin.

May be a boolean value, such as "true" or "false".

android:layout_alignParentTop

android:layout_alignParentTop

If true, makes the top edge of this view match the top edge of the parent. Accommodates top margin.

May be a boolean value, such as "true" or "false".

android:layout_alignRight

android:layout_alignRight

Makes the right edge of this view match the right edge of the given anchor view ID. Accommodates right margin.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_alignStart

android:layout_alignStart

Makes the start edge of this view match the start edge of the given anchor view ID. Accommodates start margin.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_alignTop

android:layout_alignTop

Makes the top edge of this view match the top edge of the given anchor view ID. Accommodates top margin.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_alignWithParentIfMissing

android:layout_alignWithParentIfMissing

If set to true, the parent will be used as the anchor when the anchor cannot be be found for layout_toLeftOf, layout_toRightOf, etc.

May be a boolean value, such as "true" or "false".

android:layout_below

android:layout_below

Positions the top edge of this view below the given anchor view ID. Accommodates top margin of this view and bottom margin of anchor view.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_centerHorizontal

android:layout_centerHorizontal

If true, centers this child horizontally within its parent.

May be a boolean value, such as "true" or "false".

android:layout_centerInParent

android:layout_centerInParent

If true, centers this child horizontally and vertically within its parent.

May be a boolean value, such as "true" or "false".

android:layout_centerVertical

android:layout_centerVertical

If true, centers this child vertically within its parent.

May be a boolean value, such as "true" or "false".

android:layout_toEndOf

android:layout_toEndOf

Positions the start edge of this view to the end of the given anchor view ID. Accommodates start margin of this view and end margin of anchor view.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_toLeftOf

android:layout_toLeftOf

Positions the right edge of this view to the left of the given anchor view ID. Accommodates right margin of this view and left margin of anchor view.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_toRightOf

android:layout_toRightOf

Positions the left edge of this view to the right of the given anchor view ID. Accommodates left margin of this view and right margin of anchor view.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:layout_toStartOf

android:layout_toStartOf

Positions the end edge of this view to the start of the given anchor view ID. Accommodates end margin of this view and start margin of anchor view.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

Public constructors

LayoutParams

Added in API level 1

LayoutParams(
    c: Context!, 
    attrs: AttributeSet!)

LayoutParams

Added in API level 1

LayoutParams(source: ViewGroup.LayoutParams!)

LayoutParams

Added in API level 1

LayoutParams(source: ViewGroup.MarginLayoutParams!)

LayoutParams

Added in API level 19

LayoutParams(source: RelativeLayout.LayoutParams!)

Copy constructor. Clones the width, height, margin values, and rules of the source.

Parameters
`source`	RelativeLayout.LayoutParams!: The layout params to copy from.

LayoutParams

Added in API level 1

LayoutParams(
    w: Int, 
    h: Int)

Public methods

addRule

Added in API level 1

open fun addRule(verb: Int): Unit

Adds a layout rule to be interpreted by the RelativeLayout.

This method should only be used for verbs that don't refer to a sibling (ex. ALIGN_RIGHT) or take a boolean value (TRUE for true or 0 for false). To specify a verb that takes a subject, use addRule(int,int).

If the rule is relative to the layout direction (ex. ALIGN_PARENT_START), then the layout direction must be resolved using #resolveLayoutDirection(int) before calling getRule(int) an absolute rule (ex. ALIGN_PARENT_LEFT.

Parameters
`verb`	Int: a layout verb, such as `ALIGN_PARENT_LEFT`

See Also

#addRule(int, int)
#removeRule(int)
#getRule(int)

addRule

Added in API level 1

open fun addRule(
    verb: Int, 
    subject: Int
): Unit

Adds a layout rule to be interpreted by the RelativeLayout.

Use this for verbs that refer to a sibling (ex. ALIGN_RIGHT) or take a boolean value (ex. CENTER_IN_PARENT).

If the rule is relative to the layout direction (ex. START_OF), then the layout direction must be resolved using #resolveLayoutDirection(int) before calling getRule(int) with an absolute rule (ex. LEFT_OF.

Parameters
`verb`	Int: a layout verb, such as `ALIGN_RIGHT`
`subject`	Int: the ID of another view to use as an anchor, or a boolean value (represented as `TRUE` for true or 0 for false)

See Also

#addRule(int)
#removeRule(int)
#getRule(int)

debug

Added in API level 1

open fun debug(output: String!): String!

getRule

Added in API level 23

open fun getRule(verb: Int): Int

Returns the layout rule associated with a specific verb.

Parameters
`verb`	Int: one of the verbs defined by `RelativeLayout`, such as ALIGN_WITH_PARENT_LEFT

Return
`Int`	the id of another view to use as an anchor, a boolean value (represented as `RelativeLayout.TRUE` for true or 0 for false), or -1 for verbs that don't refer to another sibling (for example, ALIGN_WITH_PARENT_BOTTOM)

See Also

#addRule(int)
#addRule(int, int)

getRules

Added in API level 1

open fun getRules(): IntArray!

Retrieves a complete list of all supported rules, where the index is the rule verb, and the element value is the value specified, or "false" if it was never set. There will be no resolution of relative rules done.

Return
`IntArray!`	the supported rules

See Also

#addRule(int, int)

removeRule

Added in API level 17

open fun removeRule(verb: Int): Unit

Removes a layout rule to be interpreted by the RelativeLayout.

If the rule is relative to the layout direction (ex. START_OF, ALIGN_PARENT_START, etc.) then the layout direction must be resolved using #resolveLayoutDirection(int) before before calling getRule(int) with an absolute rule (ex. LEFT_OF.

Parameters
`verb`	Int: One of the verbs defined by `RelativeLayout`, such as ALIGN_WITH_PARENT_LEFT.

See Also

#addRule(int)
#addRule(int, int)
#getRule(int)

resolveLayoutDirection

Added in API level 17

open fun resolveLayoutDirection(layoutDirection: Int): Unit

This will be called by android.view.View#requestLayout() to resolve layout parameters that are relative to the layout direction.

After this method is called, any rules using layout-relative verbs (ex. START_OF) previously added via addRule(int) may only be accessed via their resolved absolute verbs (ex. LEFT_OF).

Parameters
`layoutDirection`	Int: the direction of the layout `View.LAYOUT_DIRECTION_LTR` `View.LAYOUT_DIRECTION_RTL`

Properties

alignWithParent

Added in API level 1

var alignWithParent: Boolean

When true, uses the parent as the anchor if the anchor doesn't exist or if the anchor's visibility is GONE.