Android
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
XML Attributes inherited from class android.view.ViewGroup
XML Attributes inherited from class android.view.View
Constants inherited from class android.widget.LinearLayout
Constants inherited from class android.view.ViewGroup
Constants inherited from class android.view.View
Fields inherited from class android.view.ViewGroup
Fields inherited from class android.view.View

Public Constructors

            TableLayout(Context context)

Creates a new TableLayout for the given context.

            TableLayout(Context context, AttributeSet attrs)

Creates a new TableLayout for the given context and with the specified set attributes.

Public Methods

          void  addView(View child, ViewGroup.LayoutParams params)
Adds a child view with the specified layout parameters.
          void  addView(View child, int index, ViewGroup.LayoutParams params)
Adds a child view with the specified layout parameters.
          void  addView(View child)
Adds a child view.
          void  addView(View child, int index)
Adds a child view.
          TableLayout.LayoutParams  generateLayoutParams(AttributeSet attrs)
Returns a new set of layout parameters based on the supplied attributes set.
          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  requestLayout()
Call this when something has changed which has invalidated the layout of this view.
          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(ViewGroup.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(ViewGroup.LayoutParams p)
          LinearLayout.LayoutParams  generateDefaultLayoutParams()
Returns a set of layout parameters with a width of FILL_PARENT, and a height of WRAP_CONTENT.
          LinearLayout.LayoutParams  generateLayoutParams(ViewGroup.LayoutParams p)
Returns a safe set of layout parameters based on the supplied layout params.
          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
Methods inherited from class android.view.ViewGroup
Methods inherited from class android.view.View
Methods inherited from class java.lang.Object
Methods inherited from interface android.graphics.drawable.Drawable.Callback
Methods inherited from interface android.view.KeyEvent.Callback
Methods inherited from interface android.view.ViewManager
Methods inherited from interface android.view.ViewParent

Details

XML Attributes

android:collapseColumns

The 0 based index of the columns to collapse. The column indices must be separated by a comma: 1, 2, 5. Illegal and duplicate indices are ignored.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

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

android:shrinkColumns

The 0 based index of the columns to shrink. The column indices must be separated by a comma: 1, 2, 5. Illegal and duplicate indices are ignored. You can shrink all columns by using the value "*" instead. Note that a column can be marked stretchable and shrinkable at the same time.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

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

android:stretchColumns

The 0 based index of the columns to stretch. The column indices must be separated by a comma: 1, 2, 5. Illegal and duplicate indices are ignored. You can stretch all columns by using the value "*" instead. Note that a column can be marked stretchable and shrinkable at the same time.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

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

Public Constructors

public TableLayout(Context context)

Creates a new TableLayout for the given context.

Parameters

context the application environment

public TableLayout(Context context, AttributeSet attrs)

Creates a new TableLayout for the given context and with the specified set attributes.

Parameters

context the application environment
attrs a collection of attributes

Public Methods

public void addView(View child, ViewGroup.LayoutParams params)

Adds a child view with the specified layout parameters.

Parameters

child the child view to add
params the layout parameters to set on the child

public void addView(View child, int index, ViewGroup.LayoutParams params)

Adds a child view with the specified layout parameters.

Parameters

child the child view to add
index the position at which to add the child
params the layout parameters to set on the child

public void addView(View child)

Adds a child view. If no layout parameters are already set on the child, the default parameters for this ViewGroup are set on the child.

Parameters

child the child view to add

public void addView(View child, int index)

Adds a child view. If no layout parameters are already set on the child, the default parameters for this ViewGroup are set on the child.

Parameters

child the child view to add
index the position at which to add the child

public TableLayout.LayoutParams generateLayoutParams(AttributeSet attrs)

Returns a new set of layout parameters based on the supplied attributes set.

Parameters

attrs the attributes to build the layout parameters from

public boolean isColumnCollapsed(int columnIndex)

Returns the collapsed state of the specified column.

Parameters

columnIndex the index of the column

Returns

  • true if the column is collapsed, false otherwise

public boolean isColumnShrinkable(int columnIndex)

Returns whether the specified column is shrinkable or not.

Parameters

columnIndex the index of the column

Returns

  • true if the column is shrinkable, false otherwise. Default is false.

public boolean isColumnStretchable(int columnIndex)

Returns whether the specified column is stretchable or not.

Parameters

columnIndex the index of the column

Returns

  • true if the column is stretchable, false otherwise

public boolean isShrinkAllColumns()

Indicates whether all columns are shrinkable or not.

Returns

  • true if all columns are shrinkable, false otherwise

public boolean isStretchAllColumns()

Indicates whether all columns are stretchable or not.

Returns

  • true if all columns are stretchable, false otherwise

public void requestLayout()

Call this when something has changed which has invalidated the layout of this view. This will schedule a layout pass of the view tree.

public void setColumnCollapsed(int columnIndex, boolean isCollapsed)

Collapses or restores a given column. When collapsed, a column does not appear on screen and the extra space is reclaimed by the other columns. A column is collapsed/restored only when it belongs to a TableRow.

Calling this method requests a layout operation.

Related XML Attributes

Parameters

columnIndex the index of the column
isCollapsed true if the column must be collapsed, false otherwise

public void setColumnShrinkable(int columnIndex, boolean isShrinkable)

Makes the given column shrinkable or not. When a row is too wide, the table can reclaim extra space from shrinkable columns.

Calling this method requests a layout operation.

Related XML Attributes

Parameters

columnIndex the index of the column
isShrinkable true if the column must be shrinkable, false otherwise. Default is false.

public void setColumnStretchable(int columnIndex, boolean isStretchable)

Makes the given column stretchable or not. When stretchable, a column takes up as much as available space as possible in its row.

Calling this method requests a layout operation.

Related XML Attributes

Parameters

columnIndex the index of the column
isStretchable true if the column must be stretchable, false otherwise. Default is false.

public void setOnHierarchyChangeListener(ViewGroup.OnHierarchyChangeListener listener)

Register a callback to be invoked when a child is added to or removed from this view.

Parameters

listener the callback to invoke on hierarchy change

public void setShrinkAllColumns(boolean shrinkAllColumns)

Convenience method to mark all columns as shrinkable.

Related XML Attributes

Parameters

shrinkAllColumns true to mark all columns shrinkable

public void setStretchAllColumns(boolean stretchAllColumns)

Convenience method to mark all columns as stretchable.

Related XML Attributes

Parameters

stretchAllColumns true to mark all columns stretchable

Protected Methods

protected boolean checkLayoutParams(ViewGroup.LayoutParams p)

protected LinearLayout.LayoutParams generateDefaultLayoutParams()

Returns a set of layout parameters with a width of FILL_PARENT, and a height of WRAP_CONTENT.

protected LinearLayout.LayoutParams generateLayoutParams(ViewGroup.LayoutParams p)

Returns a safe set of layout parameters based on the supplied layout params. When a ViewGroup is passed a View whose layout params do not pass the test of checkLayoutParams(android.view.ViewGroup.LayoutParams), this method is invoked. This method should return a new set of layout params suitable for this ViewGroup, possibly by copying the appropriate attributes from the specified set of layout params.

Parameters

p The layout parameters to convert into a suitable set of layout parameters for this ViewGroup.

protected 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. Derived classes with children should override this method and call layout on each of their their children.

Parameters

changed This is a new size or position for this view
l Left position, relative to parent
t Top position, relative to parent
r Right position, relative to parent
b Bottom position, relative to parent

protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec)

Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overriden by subclasses to provide accurate and efficient measurement of their contents.

CONTRACT: When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an IllegalStateException, thrown by measure(int, int). Calling the superclass' onMeasure(int, int) is a valid use.

The base class implementation of measure defaults to the background size, unless a larger size is allowed by the MeasureSpec. Subclasses should override onMeasure(int, int) to provide better measurements of their content.

If this method is overridden, it is the subclass's responsibility to make sure the measured height and width are at least the view's minimum height and width (getSuggestedMinimumHeight() and getSuggestedMinimumWidth()).

Parameters

widthMeasureSpec horizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
heightMeasureSpec vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48