Android - An Open Handset Alliance Project

android.widget
public class

android.widget.TableLayout

java.lang.Object
	android.view.View				Drawable.Callback KeyEvent.Callback
		android.view.ViewGroup			ViewManager ViewParent
			android.widget.LinearLayout
				android.widget.TableLayout

A layout that arranges its children into rows and columns. A TableLayout consists of a number of TableRow objects, each defining a row (actually, you can have other children, which will be explained below). TableLayout containers do not display border lines for their rows, columns, or cells. Each row has zero or more cells; each cell can hold one View object. The table has as many columns as the row with the most cells. A table can leave cells empty. Cells can span columns, as they can in HTML.

The width of a column is defined by the row with the widest cell in that column. However, a TableLayout can specify certain columns as shrinkable or stretchable by calling setColumnShrinkable() or setColumnStretchable(). If marked as shrinkable, the column width can be shrunk to fit the table into its parent object. If marked as stretchable, it can expand in width to fit any extra space. The total width of the table is defined by its parent container. It is important to remember that a column can be both shrinkable and stretchable. In such a situation, the column will change its size to always use up the available space, but never more. Finally, you can hide a column by calling setColumnCollapsed().

The children of a TableLayout cannot specify the layout_width attribute. Width is always FILL_PARENT. However, the layout_height attribute can be defined by a child; default value is WRAP_CONTENT. If the child is a TableRow, then the height is always WRAP_CONTENT.

Cells must be added to a row in increasing column order, both in Java and XML. Column numbers are zero-based. If you don't specify a column number for a child cell, it will autoincrement to the next available column. If you skip a column number, it will be considered an empty cell in that row. See the TableLayout examples in ApiDemos for examples of creating tables in XML.

Although the typical child of a TableLayout is a TableRow, you can actually use any View subclass as a direct child of TableLayout. The View will be displayed as a single row that spans all the table columns.

Nested Classes

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.

Summary

XML Attributes

Attribute name	Related methods
android:collapseColumns	setColumnCollapsed(int,boolean)	The 0 based index of the columns to collapse.
android:shrinkColumns	setShrinkAllColumns(boolean)	The 0 based index of the columns to shrink.
android:stretchColumns	setStretchAllColumns(boolean)	The 0 based index of the columns to stretch.

XML Attributes inherited from class android.widget.LinearLayout

Attribute name	Related methods
android:animationDuration	setAnimationDuration(int)	Sets how long a transition animation should run (in milliseconds) when layout has changed.
android:baselineAligned	setBaselineAligned(boolean)	When set to false, prevents the layout from aligning its children's baselines.
android:baselineAlignedChildIndex	setBaselineAlignedChildIndex(int)	When a linear layout is part of another layout that is baseline aligned, it can specify which of its children to baseline align to (i.e which child TextView).
android:gravity	setGravity(int)	Specifies how to place an object, both its x and y axis, within a larger containing object.
android:orientation	setOrientation(int)	Should the layout be a column or a row? Use "horizontal" for a row, "vertical" for a column.

XML Attributes inherited from class android.view.ViewGroup

android:clipChildren, android:clipToPadding

Attribute name	Related methods
android:clipChildren	setClipChildren(boolean)	Defines whether a child is limited to draw inside of its bounds or not.
android:clipToPadding	setClipToPadding(boolean)	Defines whether the ViewGroup will clip its drawing surface so as to exclude the padding area.

XML Attributes inherited from class android.view.View

Attribute name	Related methods
android:background	setBackground(int)	A drawable to use as the background.
android:clickable	setClickable(boolean)	Defines whether this view reacts to click events.
android:drawingCacheQuality	setDrawingCacheQuality(int)	Defines the quality of translucent drawing caches.
android:fadingEdge	setVerticalFadingEdgeEnabled(boolean)	Defines which edges should be fadeded on scrolling.
android:fadingEdgeLength	getVerticalFadingEdgeLength()	Defines the length of the fading edges.
android:fitStatusBar		Boolean internal attribute to adjust view layout based on the status bar location.
android:focusType	setFocusType(int)	Sets the circumstances under which this view will take focus.
android:focusable	setFocusable(boolean)	Boolean that controls whether a view can take focus.
android:focusableInTouchMode	setFocusableInTouchMode(boolean)	Boolean that controls whether a view can take focus while in touch mode.
android:freezeDisabled	setFreezeDisabled(boolean)	If set, no icicle will be saved for this view when it is being frozen.
android:id	setId(int)	Supply an identifier name for this view, to later retrieve it with View.findViewById() or Activity.findViewById().
android:nextFocusDown		Defines the next view to give focus to when the next focus is FOCUS_DOWN If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.
android:nextFocusLeft		Defines the next view to give focus to when the next focus is FOCUS_LEFT.
android:nextFocusRight		Defines the next view to give focus to when the next focus is FOCUS_RIGHT If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.
android:nextFocusUp		Defines the next view to give focus to when the next focus is FOCUS_UP If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.
android:padding	setPadding(int,int,int,int)	Sets the padding, in pixels, of all four edges.
android:paddingBottom	setPadding(int,int,int,int)	Sets the padding, in pixels, of the bottom edge; see padding.
android:paddingLeft	setPadding(int,int,int,int)	Sets the padding, in pixels, of the left edge; see padding.
android:paddingRight	setPadding(int,int,int,int)	Sets the padding, in pixels, of the right edge; see padding.
android:paddingTop	setPadding(int,int,int,int)	Sets the padding, in pixels, of the top edge; see padding.
android:scrollX		The initial horizontal scroll offset, in pixels.
android:scrollY		The initial vertical scroll offset, in pixels.
android:scrollbarDefaultDelayBeforeFade		Delay in milliseconds before the scrollbars disappear.
android:scrollbarFadeDuration		Duration in milliseconds of the fade when the scrollbars disappear.
android:scrollbarSize		Sets the width of vertical scrollbars and height of horizontal scrollbars.
android:scrollbarThumbHorizontal		Drawable for horizontal scrollbars' thumb.
android:scrollbarThumbVertical		Drawable for vertical scrollbars' thumb.
android:scrollbarTrackHorizontal		Drawable for horizontal scrollbars' track.
android:scrollbarTrackVertical		Drawable for vertical scrollbars' track.
android:scrollbars		Defines which scrollbars should be displayed on scrolling or not.
android:visibility	setVisibility(int)	Controls the initial visibility of the view.

Constants inherited from class android.widget.LinearLayout

			Value
int	HORIZONTAL		0	0x00000000
int	VERTICAL		1	0x00000001

Constants inherited from class android.view.ViewGroup

FLAG_SUPPORT_STATIC_TRANSFORMATIONS, PERSISTENT_ALL_CACHES, PERSISTENT_ANIMATION_CACHE, PERSISTENT_NO_CACHE, PERSISTENT_SCROLLING_CACHE

			Value
int	FLAG_SUPPORT_STATIC_TRANSFORMATIONS	When set, this ViewGroup supports static transformations on children; this causes getChildStaticTransformation(View, android.view.animation.Transformation) to be invoked when a child is drawn.	2048	0x00000800
int	PERSISTENT_ALL_CACHES	Used to indicate that all drawing caches should be kept in memory.	3	0x00000003
int	PERSISTENT_ANIMATION_CACHE	Used to indicate that the animation drawing cache should be kept in memory.	1	0x00000001
int	PERSISTENT_NO_CACHE	Used to indicate that no drawing cache should be kept in memory.	0	0x00000000
int	PERSISTENT_SCROLLING_CACHE	Used to indicate that the scrolling drawing cache should be kept in memory.	2	0x00000002

Constants inherited from class android.view.View

DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, GONE, INVISIBLE, NORMAL_FOCUS, NO_ID, VIEW_LOG_TAG, VISIBLE, WEAK_FOCUS

			Value
int	DRAWING_CACHE_QUALITY_AUTO	Enables automatic quality mode for the drawing cache.	0	0x00000000
int	DRAWING_CACHE_QUALITY_HIGH	Enables high quality mode for the drawing cache.	1048576	0x00100000
int	DRAWING_CACHE_QUALITY_LOW	Enables low quality mode for the drawing cache.	524288	0x00080000
int	FOCUS_BACKWARD	Use with focusSearch(int).	1	0x00000001
int	FOCUS_DOWN	Use with focusSearch(int).	130	0x00000082
int	FOCUS_FORWARD	Use with focusSearch(int).	2	0x00000002
int	FOCUS_LEFT	Use with focusSearch(int).	17	0x00000011
int	FOCUS_RIGHT	Use with focusSearch(int).	66	0x00000042
int	FOCUS_UP	Use with focusSearch(int).	33	0x00000021
int	GONE	This view is invisible, and it doesn't take any space for layout purposes.	8	0x00000008
int	INVISIBLE	This view is invisible, but it still takes up space for layout purposes.	4	0x00000004
int	NORMAL_FOCUS	This view wants keystrokes.	0	0x00000000
int	NO_ID	Used to mark a View that has no ID.	-1	0xffffffff
String	VIEW_LOG_TAG	The logging tag used by this class with android.util.Log.	"View"
int	VISIBLE	This view is visible.	0	0x00000000
int	WEAK_FOCUS	This view wants keystrokes, but only if none of its children has focus.	2	0x00000002

Fields inherited from class android.widget.LinearLayout

Fields inherited from class android.view.ViewGroup

mDisappearingChildren, mGroupFlags, mOnHierarchyChangeListener, mPersistentDrawingCache

Fields inherited from class android.view.View

mBottom, mContext, mLayoutParams, mLeft, mLocation, mOnClickListener, mOnFocusChangeListener, mOnLongClickListener, mOnPopulateContextMenuListener, mPaddingBottom, mPaddingLeft, mPaddingRight, mPaddingTop, mParent, mRight, mScrollX, mScrollY, mTag, mTop

protected		int	mBottom	The distance in pixels from the top edge of this view's parent to the bottom edge of this view.
protected		Context	mContext	The application environment this view lives in.
protected		LayoutParams	mLayoutParams	The layout parameters associated with this view and used by the parent ViewGroup to determine how this view should be laid out.
protected		int	mLeft	The distance in pixels from the left edge of this view's parent to the left edge of this view.
protected	final	int[]	mLocation	Used to store a pair of coordinates, for instance returned values returned by getLocationInWindow(int[]).
protected		OnClickListener	mOnClickListener	Listener used to dispatch click events.
protected		OnFocusChangeListener	mOnFocusChangeListener	Listener used to dispatch focus change events.
protected		OnLongClickListener	mOnLongClickListener	Listener used to dispatch long click events.
protected		OnPopulateContextMenuListener	mOnPopulateContextMenuListener	Listener used to build the context menu.
protected		int	mPaddingBottom	The bottom padding in pixels, that is the distance in pixels between the bottom edge of this view and the bottom edge of its content.
protected		int	mPaddingLeft	The left padding in pixels, that is the distance in pixels between the left edge of this view and the left edge of its content.
protected		int	mPaddingRight	The right padding in pixels, that is the distance in pixels between the right edge of this view and the right edge of its content.
protected		int	mPaddingTop	The top padding in pixels, that is the distance in pixels between the top edge of this view and the top edge of its content.
protected		ViewParent	mParent	The parent this view is attached to.
protected		int	mRight	The distance in pixels from the left edge of this view's parent to the right edge of this view.
protected		int	mScrollX	The offset, in pixels, by which the content of this view is scrolled horizontally.
protected		int	mScrollY	The offset, in pixels, by which the content of this view is scrolled vertically.
protected		Object	mTag	The view's tag.
protected		int	mTop	The distance in pixels from the top edge of this view's parent to the top edge of this view.

Public Constructors

					TableLayout(Context context)
					Creates a new TableLayout for the given context.
					TableLayout(Context context, AttributeSet attrs, Map inflateParams)
					Creates a new TableLayout for the given context and with the specified set attributes.

Public Methods

				void	addView(View child, LayoutParams params)
					Adds a child view with the specified layout parameters.
				void	addView(View child, int index, LayoutParams params)
					Adds a child view with the specified layout parameters.
				void	addView(View child)
					Adds a child view that already has layout parameters set on it.
				void	addView(View child, int index)
					Adds a child view that already has layout parameters set on it.
				LayoutParams	generateLayoutParams(AttributeSet attrs)

				boolean	isColumnCollapsed(int columnIndex)
					Returns the collapsed state of the specified column.
				boolean	isColumnShrinkable(int columnIndex)
					Returns whether the specified column is shrinkable or not.
				boolean	isColumnStretchable(int columnIndex)
					Returns whether the specified column is stretchable or not.
				boolean	isShrinkAllColumns()
					Indicates whether all columns are shrinkable or not.
				boolean	isStretchAllColumns()
					Indicates whether all columns are stretchable or not.
				void	setColumnCollapsed(int columnIndex, boolean isCollapsed)
					Collapses or restores a given column.
				void	setColumnShrinkable(int columnIndex, boolean isShrinkable)
					Makes the given column shrinkable or not.
				void	setColumnStretchable(int columnIndex, boolean isStretchable)
					Makes the given column stretchable or not.
				void	setOnHierarchyChangeListener(OnHierarchyChangeListener listener)
					Register a callback to be invoked when a child is added to or removed from this view.
				void	setShrinkAllColumns(boolean shrinkAllColumns)
					Convenience method to mark all columns as shrinkable.
				void	setStretchAllColumns(boolean stretchAllColumns)
					Convenience method to mark all columns as stretchable.

Protected Methods

				boolean	checkLayoutParams(LayoutParams p)

				void	measureChildBeforeLayout(View child, int childIndex, int widthMeasureSpec, int totalWidth, int heightMeasureSpec, int totalHeight)
					Measure the child according to the parent's measure specs.
				void	measureVertical(int widthMeasureSpec, int heightMeasureSpec)

				void	onLayout(boolean changed, int l, int t, int r, int b)
					Called from layout when this view should assign a size and position to each of its children.
				void	onMeasure(int widthMeasureSpec, int heightMeasureSpec)
					Measure the view and its content to determine the measured width and the measured height.

Methods inherited from class android.widget.LinearLayout

				boolean	checkLayoutParams(LayoutParams p)

				LayoutParams	generateLayoutParams(AttributeSet attrs)

				int	getBaseline()
					Return the offset of the widget's text baseline from the widget's top boundary.
				int	getBaselineAlignedChildIndex()
				int	getChildrenSkipCount(View child, int index)
					Returns the number of children to skip after measuring/laying out the specified child.
				int	getLocationOffset(View child)
					Return the location offset of the specified child.
				int	getNextLocationOffset(View child)
					Return the size offset of the next sibling of the specified child.
				View	getVirtualChildAt(int index)
					Returns the view at the specified index.
				int	getVirtualChildCount()
					Returns the virtual number of children.
				boolean	isBaselineAligned()
					Indicates whether widgets contained within this layout are aligned on their baseline or not.
				void	layoutHorizontal()
				void	layoutVertical()
				void	measureChildBeforeLayout(View child, int childIndex, int widthMeasureSpec, int totalWidth, int heightMeasureSpec, int totalHeight)
					Measure the child according to the parent's measure specs.
				void	measureHorizontal(int widthMeasureSpec, int heightMeasureSpec)
				int	measureNullChild(int childIndex)
					Returns the size (width or height) that should be occupied by a null child.
				void	measureVertical(int widthMeasureSpec, int heightMeasureSpec)
				void	onLayout(boolean changed, int l, int t, int r, int b)
					Called from layout when this view should assign a size and position to each of its children.
				void	onMeasure(int widthMeasureSpec, int heightMeasureSpec)
					Measure the view and its content to determine the measured width and the measured height.
				void	setAnimateNextLayout(boolean animate)
					Sets whether the LinearLayout will animate child views when they move from one position to another
				void	setAnimationDuration(int animationDurationMillis)
					Sets how long the transition animation should run when a chid view changes position.
				void	setBaselineAligned(boolean baselineAligned)
					Defines whether widgets contained in this layout are baseline-aligned or not.
				void	setBaselineAlignedChildIndex(int i)
				void	setGravity(int gravity)
					Describes how the child views are positioned.
				void	setHorizontalGravity(int horizontalGravity)
				void	setOrientation(int orientation)
					Should the layout be a column or a row.
				void	setVerticalGravity(int verticalGravity)

Methods inherited from class android.view.ViewGroup

addView, addView, addView, addView, addViewInLayout, addViewInLayout, addsStatesFromChildren, attachLayoutAnimationParameters, attachViewToParent, bringChildToFront, canAnimate, checkLayoutParams, childDrawableStateChanged, cleanupLayoutState, clearChildFocus, clearDisappearingChildren, clearFocus, debug, detachAllViewsFromParent, detachViewFromParent, detachViewFromParent, dispatchDraw, dispatchFreeze, dispatchFreezeSelfOnly, dispatchKeyEvent, dispatchThaw, dispatchThawSelfOnly, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchWindowFocusChanged, dispatchWindowVisibilityChanged, findFocus, focusSearch, focusableViewAvailable, gatherTransparentRegion, generateLayoutParams, getChildAt, getChildCount, getChildMeasureSpec, getChildStaticTransformation, getChildVisibleRect, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getPeristentDrawingCache, hasFocus, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isChildrenDrawnWithCacheEnabled, isKeepAnimations, measureChild, measureChildWithMargins, measureChildren, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onCreateDrawableState, onInterceptTouchEvent, onLayout, removeAllViews, removeAllViewsInLayout, removeDetachedView, removeView, removeViewAt, removeViewInLayout, requestChildFocus, requestChildRectangleOnScreen, requestFocus, requestTransparentRegion, scheduleLayoutAnimation, setAddsStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setChildrenDrawingCacheEnabled, setChildrenDrawnWithCacheEnabled, setClipChildren, setClipToPadding, setKeepAnimations, setLayoutAnimation, setLayoutAnimationListener, setOnHierarchyChangeListener, setPadding, setPersistentDrawingCache, setSelected, showContextMenuForChild, startLayoutAnimation, updateViewLayout

	void	addView(View child, int index)
		Adds a child view that already has layout parameters set on it.
	void	addView(View child, int index, LayoutParams params)
		Adds a child view with the specified layout parameters.
	void	addView(View child, LayoutParams params)
		Adds a child view with the specified layout parameters.
	void	addView(View child)
		Adds a child view that already has layout parameters set on it.
	boolean	addViewInLayout(View child, int index, LayoutParams params)
		Adds a view during layout.
	boolean	addViewInLayout(View child, int index, LayoutParams params, boolean preventRequestLayout)
		Adds a view during layout.
	boolean	addsStatesFromChildren()
		Returns whether this ViewGroup's drawable states also include its children's drawable states.
	void	attachLayoutAnimationParameters(View child, LayoutParams params, int index, int count)
		Subclasses should override this method to set layout animation parameters on the supplied child.
	void	attachViewToParent(View child, int index, LayoutParams params)
		Attaches a view to this view group.
	void	bringChildToFront(View child)
		Change the z order of the child so it's on top of all other children
	boolean	canAnimate()
		Indicates whether the view group has the ability to animate its children after the first layout.
	boolean	checkLayoutParams(LayoutParams p)

	void	childDrawableStateChanged(View child)
		If {link #addsStatesFromChildren} is true, refreshes this group's drawable state (to include the states from its children).
	void	cleanupLayoutState(View child)
		Prevents the specified child to be laid out during the next layout pass.
	void	clearChildFocus(View child)
		Called when a child of this parent is giving up focus
	void	clearDisappearingChildren()
		Removes any pending animations for views that have been removed.
<