Android - An Open Handset Alliance Project

android.view
public static class

android.view.ViewGroup.LayoutParams

java.lang.Object
	android.view.ViewGroup.LayoutParams

LayoutParams are used by views to tell their parents how they want to be laid out. See ViewGroup Layout Attributes for a list of all child view attributes that this class supports.

The base LayoutParams class just describes how big the view wants to be for both width and height. For each dimension, it can specify one of:

an exact number
FILL_PARENT, which means the view wants to be as big as its parent (minus padding)
WRAP_CONTENT, which means that the view wants to be just big enough to enclose its content (plus padding)

There are subclasses of LayoutParams for different subclasses of ViewGroup. For example, AbsoluteLayout has its own subclass of LayoutParams which adds an X and Y value.

Known Direct Subclasses

AbsoluteLayout.LayoutParams, Gallery.LayoutParams, ViewGroup.MarginLayoutParams, WindowManager.LayoutParams

Known Indirect Subclasses

LinearLayout.LayoutParams, RadioGroup.LayoutParams, RelativeLayout.LayoutParams, TableLayout.LayoutParams, TableRow.LayoutParams

Summary

XML Attributes

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

			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

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.

Public Constructors

					ViewGroup.LayoutParams(Context c, AttributeSet attrs)
					Creates a new set of layout parameters.
					ViewGroup.LayoutParams(int width, int height)
					Creates a new set of layout parameters with the specified width and height.

Protected Methods

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	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_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), db (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

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.

May be one of the following constant values.

Constant	Value	Description
`fill_parent`	-1	The view should be as big as its parent (minus padding).
`wrap_content`	-2	The view should be only big enough to enclose its content (plus padding).

This corresponds to the global attribute resource symbol layout_height.

Related Methods

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.

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.

May be one of the following constant values.

Constant	Value	Description
`fill_parent`	-1	The view should be as big as its parent (minus padding).
`wrap_content`	-2	The view should be only big enough to enclose its content (plus padding).

This corresponds to the global attribute resource symbol layout_width.

Related Methods

Constants

public static final int FILL_PARENT

Special value for the height or width requested by a View. FILL_PARENT means that the view wants to fill the available space within the parent, taking the parent's padding into account.

Constant Value: -1 (0xffffffff)

public static final 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.

Constant Value: -2 (0xfffffffe)

Fields

public int height

Information about how tall the view wants to be. Can be an exact size, or one of the constants FILL_PARENT or WRAP_CONTENT.

public AnimationParameters layoutAnimationParameters

Used to animate layouts.

public int width

Information about how wide the view wants to be. Can be an exact size, or one of the constants FILL_PARENT or WRAP_CONTENT.

Public Constructors

public ViewGroup.LayoutParams(Context c, AttributeSet attrs)

Creates a new set of layout parameters. The values are extracted from the supplied attributes set and context. The XML attributes mapped to this set of layout parameters are:

layout_width: the width, either an exact value, WRAP_CONTENT or FILL_PARENT
layout_height: the height, either an exact value, WRAP_CONTENT or FILL_PARENT

Parameters

c	the application environment
attrs	the set of attributes from which to extract the layout parameters' values

public ViewGroup.LayoutParams(int width, int height)

Creates a new set of layout parameters with the specified width and height.

Parameters

width	the width, either FILL_PARENT, WRAP_CONTENT or a fixed size in pixels
height	the height, either FILL_PARENT, WRAP_CONTENT or a fixed size in pixels

Protected Methods

protected void setBaseAttributes(StyledAttributes a, int widthAttr, int heightAttr)

Extracts the layout parameters from the supplied attributes.

Parameters

a	the style attributes to extract the parameters from
widthAttr	the identifier of the width attribute
heightAttr	the identifier of the height attribute

Android - An Open Handset Alliance Project

Documentation

Goodies

android.view.ViewGroup.LayoutParams

Known Direct Subclasses

Known Indirect Subclasses

Summary

XML Attributes

Constants

Fields

Public Constructors

Protected Methods

Methods inherited from class java.lang.Object

Details

XML Attributes

android:layout_height

Related Methods

android:layout_width

Related Methods

Constants

public static final int FILL_PARENT

public static final int WRAP_CONTENT

Fields

public int height

public AnimationParameters layoutAnimationParameters

public int width

Public Constructors

public ViewGroup.LayoutParams(Context c, AttributeSet attrs)

Parameters

public ViewGroup.LayoutParams(int width, int height)

Parameters

Protected Methods

protected void setBaseAttributes(StyledAttributes a, int widthAttr, int heightAttr)

Parameters

AbsoluteLayout.LayoutParams	Per-child layout information associated with AbsoluteLayout.
Gallery.LayoutParams	Gallery extends LayoutParams to provide a place to hold current Transformation information along with previous position/transformation info.
ViewGroup.MarginLayoutParams	Per-child layout information for layouts that support margins.
WindowManager.LayoutParams

LinearLayout.LayoutParams	Per-child layout information associated with ViewLinearLayout.
RadioGroup.LayoutParams	This set of layout parameters defaults the width and the height of the children to WRAP_CONTENT when they are not specified in the XML file.
RelativeLayout.LayoutParams	Per-child layout information associated with RelativeLayout.
TableLayout.LayoutParams	This set of layout parameters enforces the width of each child to be FILL_PARENT and the height of each child to be WRAP_CONTENT, but only if the height is not specified.
TableRow.LayoutParams	This set of layout parameters enforces the width of each child to be FILL_PARENT and the height of each child to be WRAP_CONTENT.


e.g. "intent" or "activity"