鸿蒙OS TableLayout

TableLayout

java.lang.Object

|---ohos.agp.components.Component

|---|---ohos.agp.components.ComponentContainer

|---|---|---ohos.agp.components.TableLayout

public class TableLayout
extends ComponentContainer

提供用于在带有表格的组件中排列组件的布局。

TableLayout 提供了对组件进行对齐和排列的接口，以用表格显示组件中的组件。 可配置排列方式、行列数、元件位置。

Since:

3

嵌套类摘要

修饰符和类型	类	描述
static interface	TableLayout.Alignment	为表格布局中的子组件提供对齐模式。
static class	TableLayout.CellSpan	在表格布局中存储元素的跨度、起始单元格和结束单元格。
static class	TableLayout.LayoutConfig	提供表格布局所需的布局配置。
static class	TableLayout.Specification	配置表格布局中元素的列和行属性。

从类 ohos.agp.components.Component 继承的嵌套类/接口

Component.BindStateChangedListener, Component.CanAcceptScrollListener, Component.ClickedListener, Component.ComponentStateChangedListener, Component.ContourRefreshedListener, Component.DefSpeechEventListener, Component.DoubleClickedListener, Component.DragFeedbackProvider, Component.DraggedListener, Component.DrawTask, Component.EditEventListener, Component.EstimateSizeListener, Component.EstimateSpec, Component.FadeEffectEnum, Component.FocusChangedListener, Component.ForwardHoverListener, Component.ForwardTouchListener, Component.GestureType, Component.HoverEventListener, Component.KeyEventListener, Component.LayoutDirection, Component.LayoutRefreshedListener, Component.LongClickedListener, Component.MeasureSpec, Component.MouseEventListener, Component.MousePointerStyleListener, Component.OnDragListener, Component.RotationEventListener, Component.ScaledListener, Component.ScrolledListener, Component.ShadowDevice, Component.ShadowMode, Component.ShadowSize, Component.SpeechEventListener, Component.TouchEventListener, Component.UnconsumedKeyEventListener, Component.VoiceEvent

从类 ohos.agp.components.ComponentContainer 继承的嵌套类/接口
ComponentContainer.ArrangeListener

字段摘要

修饰符和类型	字段	描述
static int	ALIGN_CONTENTS	指示子组件的边距对齐方式。
static int	ALIGN_EDGES	指示子组件的边界对齐方式。
static int	DEFAULT	表示未定义的表格布局参数。

从类 ohos.agp.components.Component 继承的字段

ACCESSIBILITY_ADAPTABLE, ACCESSIBILITY_DISABLE, ACCESSIBILITY_ENABLE, AXIS_X, AXIS_Y, CONTOUR_BACKGROUND, CONTOUR_BORDER, CONTOUR_PADDING_BORDER, DEFAULT_SCALE, DRAG_DOWN, DRAG_HORIZONTAL, DRAG_HORIZONTAL_VERTICAL, DRAG_LEFT, DRAG_RIGHT, DRAG_UP, DRAG_VERTICAL, EVENT_TYPE_COMPONENT_ACCESSIBILITY_FOCUSED, EVENT_TYPE_COMPONENT_ACCESSIBILITY_FOCUSED_CLEAR, EVENT_TYPE_COMPONENT_CLICKED, EVENT_TYPE_COMPONENT_FOCUSED, EVENT_TYPE_COMPONENT_LONG_CLICKED, EVENT_TYPE_COMPONENT_SCROLLED, EVENT_TYPE_COMPONENT_SELECTED, EVENT_TYPE_COMPONENT_TEXT_UPDATE, EVENT_TYPE_NOTICE, EVENT_TYPE_NOTIFICATION_STATE_UPDATE, EVENT_TYPE_TOAST_SHOW, EVENT_TYPE_WINDOW_STATE_UPDATE, FOCUS_ADAPTABLE, FOCUS_DISABLE, FOCUS_ENABLE, FOCUS_NEXT, FOCUS_PREVIOUS, FOCUS_SIDE_BOTTOM, FOCUS_SIDE_LEFT, FOCUS_SIDE_RIGHT, FOCUS_SIDE_TOP, HIDE, HORIZONTAL, ID_DEFAULT, INHERITED_MODE, INVISIBLE, mBackgroundElement, mCanvasForTaskOverContent, mCanvasForTaskUnderContent, mComponentParent, mContext, mDrawTaskOverContent, mDrawTaskUnderContent, mEstimateSizeListener, mForegroundElement, mForwardHoverListener, mHoverEventListener, mKeyEventListener, mMouseEventListener, mPosition, mRotationEventListener, mShadowElement, mUnconsumedKeyEventListener, OVAL_MODE, OVAL_SCROLL_BAR_MODE, POSITION_X_INDEX, POSITION_Y_INDEX, RECT_MODE, RECT_SCROLL_BAR_MODE, SCROLL_AUTO_STAGE, SCROLL_IDLE_STAGE, SCROLL_NORMAL_STAGE, UNSPECIFIED_SCROLL_BAR_MODE, VERTICAL, VISIBLE

从类 ohos.agp.components.ComponentContainer 继承的字段
FOCUS_CHILDREN_FIRST, FOCUS_CHILDREN_HIDE, FOCUS_PARENT_FIRST, mArrangeListener

构造函数摘要

构造函数	描述
TableLayout(Context context)	用于使用默认属性集和样式创建 TableLayout 实例的默认构造函数。
TableLayout(Context context, AttrSet attrSet)	用于在 XML 文件解析后使用指定的属性集和默认样式创建 TableLayout 实例的构造函数。
TableLayout(Context context, AttrSet attrSet, String styleName)	用于在 XML 文件解析后使用指定的属性集和指定的样式创建 TableLayout 实例的构造函数。

方法总结

修饰符和类型	方法	描述
ComponentContainer.LayoutConfig	createLayoutConfig(Context context, AttrSet attrSet)	使用子组件的属性集创建布局参数。
int	getAlignmentType()	获取表格布局中的对齐方式。
int	getColumnCount()	获取表格布局中的列数。
int	getOrientation()	获取表格布局的布局方向。
int	getRowCount()	获取表格布局中的行数。
void	setAlignmentType(int type)	设置表格布局中的对齐模式。
void	setColumnCount(int columnCount)	设置表格布局中的列数。
void	setOrientation(int orientation)	设置表格布局方向。
void	setRowCount(int rowCount)	设置表格布局中的行数。
static TableLayout.Specification	specification(float weight)	根据元素的权重返回规范实例。
static TableLayout.Specification	specification(int start)	根据表格布局中元素的起始位置返回规范实例。
static TableLayout.Specification	specification(int start, float weight)	根据表格布局中元素的起始位置和元素权重返回规范实例。
static TableLayout.Specification	specification(int start, int size)	根据表格布局中元素的起始位置和元素大小返回规范实例。
static TableLayout.Specification	specification(int start, int size, float weight)	根据表格布局中元素的起始位置以及元素大小和重量返回规范实例。
static TableLayout.Specification	specification(int start, int size, int alignment)	根据元素在表格布局中的起始位置以及元素大小和对齐方式获取规范实例。
static TableLayout.Specification	specification(int start, int size, int alignment, float weight)	根据表格布局中元素的起始位置以及元素的大小、对齐方式和权重返回规范实例。
ComponentContainer.LayoutConfig	verifyLayoutConfig(ComponentContainer.LayoutConfig config)	根据当前布局类型验证布局参数。

从类 ohos.agp.components.Component 继承的方法

addDrawTask, addDrawTask, addScrolledListener, announceAccessibility, arrange, bindCornerMark, callOnClick, canScroll, clearFocus, createAnimatorProperty, disableFadeEffect, draw, enableCornerMark, enableFadeEffect, enableSaveState, enableScrollBar, estimateSize, executeDoubleClick, executeLongClick, findFocus, findNextFocusableComponent, findRequestNextFocus, getAccessibility, getAccessibilityDescription, getAlpha, getAltitude, getBackgroundElement, getBaseLine, getBottom, getBoundaryFadeEffectBottomRate, getBoundaryFadeEffectLeftRate, getBoundaryFadeEffectRightRate, getBoundaryFadeEffectTopRate, getCenterZoomFactor, getCentralScrollMode, getClickedListener, getClipEnabled, getComponentDescription, getComponentMinSize, getComponentParent, getComponentPosition, getComponentSize, getComponentStateChangedListener, getComponentTreeObserver, getContentEnable, getContentPosition, getContentPositionX, getContentPositionY, getContext, getContour, getContourRefreshedListener, getCornerMark, getDragAcceptAngle, getDraggedListener, getEditEventListener, getEstimatedHeight, getEstimatedWidth, getFadeEffectBoundaryWidth, getFadeEffectColor, getFocusable, getFocusBorderEnable, getFocusBorderPadding, getFocusBorderRadius, getFocusBorderWidth, getForegroundElement, getForegroundGravity, getForwardHoverListener, getForwardTouchListener, getGesturePriority, getHeight, getHorizontalPadding, getHorizontalPosition, getHoverEventListener, getId, getKeyEventListener, getLayoutConfig, getLayoutDirection, getLayoutDirectionResolved, getLayoutRefreshedListener, getLeft, getLocationOnScreen, getMarginBottom, getMarginLeft, getMarginRight, getMargins, getMarginsLeftAndRight, getMarginsTopAndBottom, getMarginTop, getMatrix, getMinHeight, getMinWidth, getMode, getModeResolved, getMouseEventListener, getMousePointerStyleListener, getName, getPadding, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getPivot, getPivotX, getPivotY, getResourceManager, getRight, getRotation, getRotationEventListener, getRotationSensitivity, getScale, getScaledListener, getScaleX, getScaleY, getScrollbarBackgroundColor, getScrollbarColor, getScrollbarFadingDelay, getScrollbarFadingDuration, getScrollBarMode, getScrollbarRadius, getScrollbarRoundRect, getScrollbarStartAngle, getScrollbarSweepAngle, getScrollbarThickness, getScrollState, getScrollValue, getSelfVisibleRect, getShadowColor, getSpeechEventListener, getTag, getTop, getTouchEventListener, getTransitionSymbol, getTranslation, getTranslationX, getTranslationY, getTranslationZ, getUserNextFocus, getVerticalPadding, getVerticalPosition, getVisibility, getVisibleRectOnScreen, getWidth, getWindowVisibleRect, hasFocus, hasFocusedEffect, hasOverlaps, hideFocusBorder, invalidate, isBoundaryFadeEffectEnable, isBoundToWindow, isClickable, isClipToContourEnabled, isComponentDisplayed, isEnabled, isFadeEffected, isFocusable, isFocused, isIdentityMatrix, isLongClickOn, isPressed, isRtl, isSaveStateEnabled, isScrollbarFadingOn, isScrollBarOn, isScrollbarOverlapEnabled, isSelected, isSoundEnable, isTouchFocusable, isVibrationEffectEnabled, notifyAccessibility, onAttributeConfigChanged, onRestoreState, onRtlChanged, onSaveState, performScale, playSound, postLayout, refreshContour, release, removeBindStateChangedListener, removeScrolledListener, requestFocus, requestForceForwardTouchEvent, restoreComponentTreeState, saveComponentTreeState, scrollBy, scrollTo, setAccessibility, setAccessibilityDescription, setAlpha, setAltitude, setBackground, setBindStateChangedListener, setBottom, setBoundaryFadeEffectEnable, setCanAcceptScrollListener, setCenterZoomFactor, setCentralScrollMode, setClickable, setClickedListener, setClipEnabled, setClipToContourEnabled, setComponentDescription, setComponentMinSize, setComponentPosition, setComponentPosition, setComponentSize, setComponentStateChangedListener, setContentEnable, setContentPosition, setContentPositionX, setContentPositionY, setContour, setContourRefreshedListener, setDoubleClickedListener, setDragAcceptAngle, setDraggedListener, setEditEventListener, setEnabled, setEstimatedSize, setEstimateSizeListener, setFadeEffectBoundaryWidth, setFadeEffectColor, setFocusable, setFocusBorderEnable, setFocusBorderPadding, setFocusBorderRadius, setFocusBorderRadius, setFocusBorderWidth, setFocusChangedListener, setFocusedEffect, setForeground, setForegroundGravity, setForwardHoverListener, setForwardTouchListener, setGesturePriority, setHeight, setHorizontalPadding, setHorizontalPosition, setHoverEventListener, setId, setKeyEventListener, setLayoutConfig, setLayoutDirection, setLayoutRefreshedListener, setLeft, setLongClickable, setLongClickedListener, setMarginBottom, setMarginLeft, setMarginRight, setMarginsLeftAndRight, setMarginsTopAndBottom, setMarginTop, setMinHeight, setMinWidth, setMode, setMouseEventListener, setMousePointerStyleListener, setName, setOnDragListener, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRelative, setPaddingRight, setPaddingTop, setPivot, setPivot, setPivotX, setPivotY, setPosition, setPositionX, setPositionY, setPressState, setRight, setRotation, setRotationEventListener, setRotationSensitivity, setScale, setScaledListener, setScaleX, setScaleY, setScrollbarBackgroundColor, setScrollbarColor, setScrollbarFadingDelay, setScrollbarFadingDuration, setScrollbarFadingEnabled, setScrollBarMode, setScrollbarOverlapEnabled, setScrollbarRadius, setScrollbarRoundRect, setScrollbarStartAngle, setScrollbarSweepAngle, setScrollbarThickness, setScrolledListener, setSelected, setShadowColor, setShadowStyle, setSoundEnable, setSpeechEventListener, setTag, setTop, setTouchEventListener, setTouchFocusable, setTransitionSymbol, setTranslation, setTranslationX, setTranslationY, setTranslationZ, setUnconsumedKeyEventListener, setUserNextFocus, setVerticalPadding, setVerticalPosition, setVibrationEffectEnabled, setVisibility, setWidth, showFocusBorder, simulateClick, simulateDrag, startDragAndDrop, subscribeVoiceEvents, unsubscribeVoiceEvents

从类 ohos.agp.components.ComponentContainer 继承的方法

addComponent, addComponent, addComponent, addComponent, addComponent, dispatchRestoreState, dispatchSaveState, findComponentById, findComponentHolderById, getAutoLayout, getChildCount, getChildIndex, getComponentAt, getComponentTransition, getFocusOrder, getLayoutManager, informConfigurationChanged, isClipToChildBoundsEnabled, isClipToPaddingBoundsEnabled, isTouchEventSplitable, moveChildToFront, onDrag, removeAllComponents, removeComponent, removeComponentAt, removeComponentById, removeComponents, setArrangeListener, setAutoLayout, setAutoLayout, setClipToChildBoundsEnabled, setClipToPaddingBoundsEnabled, setComponentTransition, setFocusOrder, setLayoutManager, setTouchEventSplitable

从接口 ohos.agp.components.ComponentParent 继承的方法
getComponentParent, postLayout

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细信息

ALIGN_CONTENTS

public static final int ALIGN_CONTENTS

指示子组件的边距对齐方式。

Since:

1

ALIGN_EDGES

public static final int ALIGN_EDGES

指示子组件的边界对齐方式。

Since:

1

DEFAULT

public static final int DEFAULT

表示未定义的表格布局参数。

在创建规范对象实例时，如果表格中某个元素的起始位置没有确定，可以使用spec(DEFAULT, weight)。

Since:

1

构造函数详细信息

TableLayout

public TableLayout(Context context)

用于使用默认属性集和样式创建 TableLayout 实例的默认构造函数。

参数：

参数名称	参数描述
context	指示应用程序上下文。

Since:

3

TableLayout

public TableLayout(Context context, AttrSet attrSet)

用于在 XML 文件解析后使用指定的属性集和默认样式创建 TableLayout 实例的构造函数。

参数：

参数名称	参数描述
context	指示应用程序上下文。
attrSet	指示要使用的属性集。

Since:

3

TableLayout

public TableLayout(Context context, AttrSet attrSet, String styleName)

用于在 XML 文件解析后使用指定的属性集和指定的样式创建 TableLayout 实例的构造函数。

参数：

参数名称	参数描述
context	指示应用程序上下文。
attrSet	指示要使用的属性集。
styleName	指示要使用的样式名称。

Since:

3

方法详情

setColumnCount

public void setColumnCount(int columnCount)

设置表格布局中的列数。

如果没有为子组件设置值，则使用父组件中的默认列数。

参数：

参数名称	参数描述
columnCount	表示列数。

Since:

1

getColumnCount

public int getColumnCount()

获取表格布局中的列数。

返回:

返回表格布局中的列数。

Since:

1

setRowCount

public void setRowCount(int rowCount)

设置表格布局中的行数。

如果没有为子组件设置值，则使用父组件中的默认行数。

参数：

参数名称	参数描述
rowCount	表示行数。

Since:

1

getRowCount

public int getRowCount()

获取表格布局中的行数。

返回:

返回表格布局中的行数。

Since:

1

setOrientation

public void setOrientation(int orientation)

设置表格布局方向。

如果不调用此方法，则默认使用 Component.HORIZONTAL。

参数：

参数名称	参数描述
orientation	指示表格布局方向。 Component.HORIZONTAL 表示组件水平排列； Component.VERTICAL 表示组件是垂直排列的。

Since:

1

getOrientation

public int getOrientation()

获取表格布局的布局方向。

返回:

返回表格布局方向。 Component.HORIZONTAL 表示组件水平排列； Component.VERTICAL 表示组件是垂直排列的。

Since:

1

setAlignmentType

public void setAlignmentType(int type)

设置表格布局中的对齐模式。

如果不调用此方法，则默认使用 ALIGN_CONTENTS。

参数：

参数名称	参数描述
type	表示表格布局中的对齐方式。 ALIGN_EDGES 表示边界对齐； ALIGN_CONTENTS 表示边距对齐。

Since:

4

getAlignmentType

public int getAlignmentType()

获取表格布局中的对齐方式。

返回:

返回表格布局中的对齐方式。 如果使用边界对齐模式，则返回 ALIGN_EDGES； 如果使用边距对齐模式，则返回 ALIGN_CONTENTS。

Since:

4

specification

public static TableLayout.Specification specification(float weight)

根据元素的权重返回规范实例。 默认位置为 DEFAULT。

参数：

参数名称	参数描述
weight	表示元素权重。 该值不能小于 0。

Since:

3

specification

public static TableLayout.Specification specification(int start)

根据表格布局中元素的起始位置返回规范实例。 默认元素权重为 1。

参数：

参数名称	参数描述
start	指示元素在表格布局中的起始位置。 该值不能小于 0。

Since:

3

specification

public static TableLayout.Specification specification(int start, float weight)

根据表格布局中元素的起始位置和元素权重返回规范实例。

参数：

参数名称	参数描述
start	指示元素在表格布局中的起始位置。 该值不能小于 0。
weight	表示元素权重。 该值不能小于 0。

Since:

3

specification

public static TableLayout.Specification specification(int start, int size)

根据表格布局中元素的起始位置和元素大小返回规范实例。

参数：

参数名称	参数描述
start	指示元素在表格布局中的起始位置。 该值不能小于 0。
size	指示元素大小。 该值不能小于 0。

Since:

3

specification

public static TableLayout.Specification specification(int start, int size, float weight)

根据表格布局中元素的起始位置以及元素大小和重量返回规范实例。

参数：

参数名称	参数描述
start	指示元素在表格布局中的起始位置。 该值不能小于 0。
size	指示元素大小。 该值不能小于 0。
weight	表示元素权重。 该值不能小于 0。

Since:

3

specification

public static TableLayout.Specification specification(int start, int size, int alignment)

根据元素在表格布局中的起始位置以及元素大小和对齐方式获取规范实例。

参数：

参数名称	参数描述
start	指示元素在表格布局中的起始位置。 该值不能小于 0。
size	指示元素大小。 该值不能小于 0。
alignment	指示元素的对齐方式。 ALIGN_EDGES 表示边界对齐； ALIGN_CONTENTS 表示边距对齐。

Since:

3

specification

public static TableLayout.Specification specification(int start, int size, int alignment, float weight)

根据表格布局中元素的起始位置以及元素的大小、对齐方式和权重返回规范实例。

参数：

参数名称	参数描述
start	指示元素在表格布局中的起始位置。 该值不能小于 0。
size	指示元素大小。 该值不能小于 0。
alignment	指示元素的对齐方式。 ALIGN_EDGES 表示边界对齐； ALIGN_CONTENTS 表示边距对齐。
weight	表示元素权重。 该值不能小于 0。

Since:

3

verifyLayoutConfig

public ComponentContainer.LayoutConfig verifyLayoutConfig(ComponentContainer.LayoutConfig config)

从类复制的描述：ComponentContainer

根据当前布局类型验证布局参数。

指定者：

接口 ComponentParent 中的 verifyLayoutConfig

覆盖：

ComponentContainer 类中的 verifyLayoutConfig

参数：

参数名称	参数描述
config	指示要转换为 ComponentContainer 实例的一组布局参数。

返回:

返回 LayoutConfig 实例，它表示布局参数。

createLayoutConfig

public ComponentContainer.LayoutConfig createLayoutConfig(Context context, AttrSet attrSet)

从类复制的描述：ComponentContainer

使用子组件的属性集创建布局参数。

覆盖：

ComponentContainer 类中的 createLayoutConfig

参数：

参数名称	参数描述
context	指示应用程序上下文。
attrSet	表示属性集。

返回:

返回创建的布局参数。