Class TableLayout

All Implemented Interfaces:
Drawable.Callback, ViewManager, ViewParent

public class TableLayout extends LinearLayout

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 MATCH_PARENT. However, the layout_height attribute can be defined by a child; default value is ViewGroup.LayoutParams.WRAP_CONTENT. If the child is a TableRow, then the height is always ViewGroup.LayoutParams.WRAP_CONTENT.

Cells must be added to a row in increasing column order, both in code 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.

  • Constructor Details

    • TableLayout

      public TableLayout(Context context)

      Creates a new TableLayout for the given context.

      Parameters:
      context - the application environment
  • Method Details

    • onViewAdded

      protected void onViewAdded(View child)
      Description copied from class: ViewGroup
      Called when a new child is added to this ViewGroup. Overrides should always call super.onViewAdded.
      Overrides:
      onViewAdded in class ViewGroup
      Parameters:
      child - the added child view
    • requestLayout

      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. This should not be called while the view hierarchy is currently in a layout pass (View.isInLayout(). If layout is happening, the request may be honored at the end of the current layout pass (and then layout will run again) or after the current frame is drawn and the next layout occurs.

      Subclasses which override this method should call the superclass method to handle possible request-during-layout errors correctly.

      Specified by:
      requestLayout in interface ViewParent
      Overrides:
      requestLayout in class View
    • isShrinkAllColumns

      public boolean isShrinkAllColumns()

      Indicates whether all columns are shrinkable or not.

      Returns:
      true if all columns are shrinkable, false otherwise
    • setShrinkAllColumns

      public void setShrinkAllColumns(boolean shrinkAllColumns)

      Convenience method to mark all columns as shrinkable.

      Parameters:
      shrinkAllColumns - true to mark all columns shrinkable
    • isStretchAllColumns

      public boolean isStretchAllColumns()

      Indicates whether all columns are stretchable or not.

      Returns:
      true if all columns are stretchable, false otherwise
    • setStretchAllColumns

      public void setStretchAllColumns(boolean stretchAllColumns)

      Convenience method to mark all columns as stretchable.

      Parameters:
      stretchAllColumns - true to mark all columns stretchable
    • setColumnCollapsed

      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.

      Parameters:
      columnIndex - the index of the column
      isCollapsed - true if the column must be collapsed, false otherwise
    • isColumnCollapsed

      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
    • setColumnStretchable

      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.

      Parameters:
      columnIndex - the index of the column
      isStretchable - true if the column must be stretchable, false otherwise. Default is false.
    • isColumnStretchable

      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
    • setColumnShrinkable

      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.

      Parameters:
      columnIndex - the index of the column
      isShrinkable - true if the column must be shrinkable, false otherwise. Default is false.
    • isColumnShrinkable

      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.
    • addView

      public void addView(@NonNull 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.

      Note: do not invoke this method from View.draw(Canvas), View.onDraw(Canvas), ViewGroup.dispatchDraw(Canvas) or any related method.

      Overrides:
      addView in class ViewGroup
      Parameters:
      child - the child view to add
      See Also:
    • addView

      public void addView(@NonNull 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.

      Note: do not invoke this method from View.draw(Canvas), View.onDraw(Canvas), ViewGroup.dispatchDraw(Canvas) or any related method.

      Overrides:
      addView in class ViewGroup
      Parameters:
      child - the child view to add
      index - the position at which to add the child
      See Also:
    • addView

      public void addView(@NonNull View child, @NonNull ViewGroup.LayoutParams params)
      Adds a child view with the specified layout parameters.

      Note: do not invoke this method from View.draw(Canvas), View.onDraw(Canvas), ViewGroup.dispatchDraw(Canvas) or any related method.

      Specified by:
      addView in interface ViewManager
      Overrides:
      addView in class ViewGroup
      Parameters:
      child - the child view to add
      params - the layout parameters to set on the child
    • addView

      public void addView(@NonNull View child, int index, @NonNull ViewGroup.LayoutParams params)
      Adds a child view with the specified layout parameters.

      Note: do not invoke this method from View.draw(Canvas), View.onDraw(Canvas), ViewGroup.dispatchDraw(Canvas) or any related method.

      Overrides:
      addView in class ViewGroup
      Parameters:
      child - the child view to add
      index - the position at which to add the child or -1 to add last
      params - the layout parameters to set on the child
    • onMeasure

      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 View.measure(int, int) and should be overridden by subclasses to provide accurate and efficient measurement of their contents.

      CONTRACT: When overriding this method, you must call View.setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an IllegalStateException, thrown by View.measure(int, int). Calling super.onMeasure() 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 the base one to provide better measurements of their content.

      Overrides:
      onMeasure in class LinearLayout
      Parameters:
      widthMeasureSpec - width measure specification imposed by the parent MeasureSpec
      heightMeasureSpec - height measure specification imposed by the parent MeasureSpec
    • onLayout

      protected void onLayout(boolean changed, int l, int t, int r, int b)
      Called from View.layout(int, int, int, int) 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 children.

      Overrides:
      onLayout in class LinearLayout
      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
    • generateDefaultLayoutParams

      @NonNull protected TableLayout.LayoutParams generateDefaultLayoutParams()
      Returns a set of layout parameters with a width of ViewGroup.LayoutParams.MATCH_PARENT, and a height of ViewGroup.LayoutParams.WRAP_CONTENT.
      Overrides:
      generateDefaultLayoutParams in class LinearLayout
      Returns:
      a set of default layout parameters
    • checkLayoutParams

      protected boolean checkLayoutParams(ViewGroup.LayoutParams p)
      Check whether given params fit to this view group.

      See also ViewGroup.generateLayoutParams(LayoutParams) See also ViewGroup.generateDefaultLayoutParams()

      Overrides:
      checkLayoutParams in class LinearLayout
      Parameters:
      p - layout params to check
      Returns:
      if params matched to this view group
    • generateLayoutParams

      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 ViewGroup.checkLayoutParams(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.
      Overrides:
      generateLayoutParams in class LinearLayout
      Parameters:
      p - The layout parameters to convert into a suitable set of layout parameters for this ViewGroup.
      Returns:
      an instance of ViewGroup.LayoutParams or one of its descendants