Android - An Open Handset Alliance Project

android.widget
public static class

android.widget.RelativeLayout.LayoutParams

java.lang.Object
	android.view.ViewGroup.LayoutParams
		android.view.ViewGroup.MarginLayoutParams
			android.widget.RelativeLayout.LayoutParams

Per-child layout information associated with RelativeLayout.

Summary

XML Attributes

Attribute name	Related methods
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_alignLeft		Makes the left edge of this view match the left edge of the given anchor view ID.
android:layout_alignParentBottom		f true, makes the bottom edge of this view match the bottom 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_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_alignTop		Makes the top edge of this view match the top edge of the given anchor view ID.
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_toLeft		Positions the right edge of this view to the left of the given anchor view ID.
android:layout_toRight		Positions the left edge of this view to the right of the given anchor view ID.

XML Attributes inherited from class android.view.ViewGroup.MarginLayoutParams

android:layout_marginBottom, android:layout_marginLeft, android:layout_marginRight, android:layout_marginTop

Attribute name	Related methods
android:layout_marginBottom	setMargins(int,int,int,int)	Specifies extra space on the bottom side of this view.
android:layout_marginLeft	setMargins(int,int,int,int)	Specifies extra space on the left side of this view.
android:layout_marginRight	setMargins(int,int,int,int)	Specifies extra space on the right side of this view.
android:layout_marginTop	setMargins(int,int,int,int)	Specifies extra space on the top side of this view.

XML Attributes inherited from class android.view.ViewGroup.LayoutParams

android:layout_height, android:layout_width

Attribute name	Related methods
android:layout_height		Specifies the basic height of the view.
android:layout_width		Specifies the basic width of the view.

Constants inherited from class android.view.ViewGroup.LayoutParams

FILL_PARENT, WRAP_CONTENT

			Value
int	FILL_PARENT	Special value for the height or width requested by a View.	-1	0xffffffff
int	WRAP_CONTENT	Special value for the height or width requested by a View.	-2	0xfffffffe

Fields inherited from class android.view.ViewGroup.MarginLayoutParams

bottomMargin, leftMargin, rightMargin, topMargin

Fields inherited from class android.view.ViewGroup.LayoutParams

height, layoutAnimationParameters, width

Public Constructors

					RelativeLayout.LayoutParams(Context c, AttributeSet attrs)
					RelativeLayout.LayoutParams(int w, int h)

Public Methods

				void	addRule(int verb, int anchor)
					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)
					Returns a String representation of this set of layout parameters.
				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.

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Details

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.

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

This corresponds to the global attribute resource symbol layout_above.

Related Methods

android:layout_alignBaseline

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

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

This corresponds to the global attribute resource symbol layout_alignBaseline.

Related Methods

android:layout_alignBottom

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

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

This corresponds to the global attribute resource symbol layout_alignBottom.

Related Methods

android:layout_alignLeft

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

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

This corresponds to the global attribute resource symbol layout_alignLeft.

Related Methods

android:layout_alignParentBottom

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

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_alignParentBottom.

Related Methods

android:layout_alignParentLeft

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

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_alignParentLeft.

Related Methods

android:layout_alignParentRight

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

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_alignParentRight.

Related Methods

android:layout_alignParentTop

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

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_alignParentTop.

Related Methods

android:layout_alignRight

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

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

This corresponds to the global attribute resource symbol layout_alignRight.

Related Methods

android:layout_alignTop

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

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

This corresponds to the global attribute resource symbol layout_alignTop.

Related Methods

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.

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

This corresponds to the global attribute resource symbol layout_below.

Related Methods

android:layout_centerHorizontal

If true, centers this child horizontally within its parent.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_centerHorizontal.

Related Methods

android:layout_centerInParent

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

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_centerInParent.

Related Methods

android:layout_centerVertical

If true, centers this child vertically within its parent.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol layout_centerVertical.

Related Methods

android:layout_toLeft

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.

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

This corresponds to the global attribute resource symbol layout_toLeft.

Related Methods

android:layout_toRight

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.

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

This corresponds to the global attribute resource symbol layout_toRight.

Related Methods

Public Constructors

public RelativeLayout.LayoutParams(Context c, AttributeSet attrs)

public RelativeLayout.LayoutParams(int w, int h)

Public Methods

public void addRule(int verb, int anchor)

Adds a layout rule to be interpreted by the RelativeLayout. Use this for verbs that take a target, such as a sibling (ALIGN_RIGHT) or a boolean value (VISIBLE).

Parameters

verb	One of the verbs defined by RelativeLayout, such as ALIGN_WITH_PARENT_LEFT.
anchor	The id of another view to use as an anchor, or a boolean value(represented as TRUE) for true or 0 for false). For verbs that don't refer to another sibling (for example, ALIGN_WITH_PARENT_BOTTOM) just use -1.

public void addRule(int verb)

Adds a layout rule to be interpreted by the RelativeLayout. This method should only be used for constraints that don't refer to another sibling (e.g., CENTER_IN_PARENT) or take a boolean value (TRUE for true or - for false). To specify a verb that takes a subject, use addRule(int, int) instead. ALIGN_WITH_PARENT_* and CENTER_*

Parameters

verb	One of the verbs defined by RelativeLayout, such as ALIGN_WITH_PARENT_LEFT.

public String debug(String output)

Returns a String representation of this set of layout parameters.

Parameters

output	the String to prepend to the internal representation

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.

Returns

the supported rules

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.

public	int	height	Information about how tall the view wants to be.
public	AnimationParameters	layoutAnimationParameters	Used to animate layouts.
public	int	width	Information about how wide the view wants to be.

				void	setMargins(int left, int top, int right, int bottom)
					Sets the margins, in pixels.

				void	setBaseAttributes(StyledAttributes a, int widthAttr, int heightAttr)
					Extracts the layout parameters from the supplied attributes.


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

android.widget.RelativeLayout.LayoutParams

Summary

XML Attributes

XML Attributes inherited from class android.view.ViewGroup.MarginLayoutParams

XML Attributes inherited from class android.view.ViewGroup.LayoutParams

Constants inherited from class android.view.ViewGroup.LayoutParams

Fields inherited from class android.view.ViewGroup.MarginLayoutParams

Fields inherited from class android.view.ViewGroup.LayoutParams

Public Constructors

Public Methods

Methods inherited from class android.view.ViewGroup.MarginLayoutParams

Methods inherited from class android.view.ViewGroup.LayoutParams

Methods inherited from class java.lang.Object

Details

XML Attributes

android:layout_above

Related Methods

android:layout_alignBaseline

Related Methods

android:layout_alignBottom

Related Methods

android:layout_alignLeft

Related Methods

android:layout_alignParentBottom

Related Methods

android:layout_alignParentLeft

Related Methods

android:layout_alignParentRight

Related Methods

android:layout_alignParentTop

Related Methods

android:layout_alignRight

Related Methods

android:layout_alignTop

Related Methods

android:layout_below

Related Methods

android:layout_centerHorizontal

Related Methods

android:layout_centerInParent

Related Methods

android:layout_centerVertical

Related Methods

android:layout_toLeft

Related Methods

android:layout_toRight

Related Methods

Public Constructors

public RelativeLayout.LayoutParams(Context c, AttributeSet attrs)

public RelativeLayout.LayoutParams(int w, int h)

Public Methods

public void addRule(int verb, int anchor)

Parameters

See Also

public void addRule(int verb)

Parameters

See Also

public String debug(String output)

Parameters

public int[] getRules()

Returns

See Also