Added in API level 1

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

RelativeLayout.LayoutParams

---

Kotlin |Java

public static class RelativeLayout.LayoutParams
extends ViewGroup.MarginLayoutParams

java.lang.Object
↳	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 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 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 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(Context c, AttributeSet attrs)
LayoutParams(ViewGroup.LayoutParams source)
LayoutParams(ViewGroup.MarginLayoutParams source)
LayoutParams(RelativeLayout.LayoutParams source) Copy constructor.
LayoutParams(int w, int h)

Public methods
void	addRule(int verb, int subject) Adds a layout rule to be interpreted by the RelativeLayout.
void	addRule(int verb) Adds a layout rule to be interpreted by the RelativeLayout.
String	debug(String output)
int	getRule(int verb) Returns the layout rule associated with a specific verb.
int[]	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.
void	removeRule(int verb) Removes a layout rule to be interpreted by the RelativeLayout.
void	resolveLayoutDirection(int layoutDirection) This will be called by View.requestLayout() to resolve layout parameters that are relative to the layout direction.

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_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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

If true, centers this child horizontally within its parent.

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

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

If true, centers this child vertically within its parent.

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

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

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

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

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

Fields

alignWithParent

Added in API level 1

public boolean alignWithParent

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

Public constructors

LayoutParams

Added in API level 1

public LayoutParams (Context c, 
                AttributeSet attrs)

Parameters
c	Context
attrs	AttributeSet

LayoutParams

Added in API level 1

public LayoutParams (ViewGroup.LayoutParams source)

Parameters
source	ViewGroup.LayoutParams

LayoutParams

Added in API level 1

public LayoutParams (ViewGroup.MarginLayoutParams source)

Parameters
source	ViewGroup.MarginLayoutParams

LayoutParams

Added in API level 19

public LayoutParams (RelativeLayout.LayoutParams source)

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

public LayoutParams (int w, 
                int h)

Parameters
w	int
h	int

Public methods

addRule

Added in API level 1

public void addRule (int verb, 
                int subject)

Adds a layout rule to be interpreted by the RelativeLayout.

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

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

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

See also:

• addRule(int)
• removeRule(int)
• getRule(int)

addRule

Added in API level 1

public void addRule (int verb)

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. RelativeLayout.ALIGN_RIGHT) or take a boolean value (RelativeLayout.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. RelativeLayout.ALIGN_PARENT_START), then the layout direction must be resolved using resolveLayoutDirection(int) before calling getRule(int) an absolute rule (ex. RelativeLayout.ALIGN_PARENT_LEFT.

Parameters
verb	int: a layout verb, such as RelativeLayout.ALIGN_PARENT_LEFT

See also:

• addRule(int, int)
• removeRule(int)
• getRule(int)

debug

Added in API level 1

public String debug (String output)

Parameters
output	String

Returns
String

getRule

Added in API level 23

public int getRule (int verb)

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

Returns
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

public int[] 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. There will be no resolution of relative rules done.

Returns
int[]	the supported rules

See also:

• addRule(int, int)

removeRule

Added in API level 17

public void removeRule (int verb)

Removes a layout rule to be interpreted by the RelativeLayout.

If the rule is relative to the layout direction (ex. RelativeLayout.START_OF, RelativeLayout.ALIGN_PARENT_START, etc.) then the layout direction must be resolved using resolveLayoutDirection(int) before before calling getRule(int) with an absolute rule (ex. RelativeLayout.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

public void resolveLayoutDirection (int layoutDirection)

This will be called by 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. RelativeLayout.START_OF) previously added via addRule(int) may only be accessed via their resolved absolute verbs (ex. RelativeLayout.LEFT_OF).

Parameters
layoutDirection	int: the direction of the layout View.LAYOUT_DIRECTION_LTR View.LAYOUT_DIRECTION_RTL