Component

java.lang.Object

|---ohos.agp.components.Component

public class Component
extends Object

为用户界面 (UI) 提供基本组件。

每个组件在屏幕上占据一个矩形区域，负责在这个区域内进行绘制和事件处理。 Component 是控件的基类，用于创建交互式 UI 组件。 它的子类 ComponentContainer 是所有布局的基类，它定义了其他组件或组件组的布局属性。

嵌套类摘要

修饰符和类型	类	描述
static interface	Component.BindStateChangedListener	提供当组件绑定到其窗口或从其窗口分离时要调用的回调。
static interface	Component.CanAcceptScrollListener	提供要调用的侦听器来决定是否可以接受滚动手势。
static interface	Component.ClickedListener	提供单击组件时要调用的回调。
static interface	Component.ComponentStateChangedListener	为组件的状态更改事件提供回调。
static interface	Component.ContourRefreshedListener	为用于为组件设置自定义 Contour 对象的回调提供侦听器。
static class	Component.DefSpeechEventListener	提供在语音事件绑定到组件时调用的默认回调。
static interface	Component.DoubleClickedListener	提供双击组件时要调用的回调。
static class	Component.DragFeedbackProvider	提供系统在拖放操作期间显示的图像（称为“拖动阴影”）。
static interface	Component.DraggedListener	提供当手势识别器将拖动事件分派到组件时要调用的回调。
static interface	Component.DrawTask	实现绘图任务。
static interface	Component.EditEventListener	提供侦听器来处理由键盘快捷键触发的编辑事件，当它们分发到组件时。
static interface	Component.EstimateSizeListener	提供用于自定义尺寸（宽度/高度）估计过程的界面。
static class	Component.EstimateSpec	定义组件的度量规范。
static class	Component.FadeEffectEnum	枚举可以应用淡出效果的组件指示器的类型。
static interface	Component.FocusChangedListener	提供当组件的焦点状态更改时要调用的回调。
static interface	Component.ForwardHoverListener	提供在鼠标悬停事件转发到子组件之前调用的回调。
static interface	Component.ForwardTouchListener	在将触摸事件转发到子组件之前提供要调用的回调。
static class	Component.GestureType	枚举手势类型。
static interface	Component.HoverEventListener	提供从组件调度悬停事件时要调用的回调。
static interface	Component.KeyEventListener	提供从组件调度键事件时要调用的回调。
static class	Component.LayoutDirection	枚举水平布局方向。
static interface	Component.LayoutRefreshedListener	提供在再次布局组件时调用的回调。
static interface	Component.LongClickedListener	提供从组件分派长触摸事件时要调用的回调。
static class	Component.MeasureSpec	已弃用。 此更改自 API 版本 6 起生效。已替换为 EstimateSpec
static interface	Component.MouseEventListener	提供从组件分派鼠标事件时要调用的回调。
static interface	Component.MousePointerStyleListener	提供一个监听器来观察鼠标指针样式的变化。
static interface	Component.OnDragListener	将拖动事件分派到组件时调用的回调。
static interface	Component.RotationEventListener	提供从组件分派旋转事件时要调用的回调。
static interface	Component.ScaledListener	为组件的缩放事件提供回调。
static interface	Component.ScrolledListener	提供从组件分派滚动事件时要调用的回调。
static class	Component.ShadowDevice	表示窗口的阴影设备。
static class	Component.ShadowMode	指示窗口的阴影模式。
static class	Component.ShadowSize	指示窗口的阴影大小。
static interface	Component.SpeechEventListener	提供当语音事件绑定到组件时要调用的回调。
static interface	Component.TouchEventListener	提供在将触摸事件分派到组件时要调用的回调。
static interface	Component.UnconsumedKeyEventListener	如果键盘事件没有被使用，则提供一个侦听器来调度键盘事件。
static class	Component.VoiceEvent	为组件提供语音事件。

字段摘要

修饰符和类型	字段	描述
static int	ACCESSIBILITY_ADAPTABLE	表示可以访问该组件。
static int	ACCESSIBILITY_DISABLE	表示无法访问该组件。
static int	ACCESSIBILITY_ENABLE	表示该组件已启用。
static int	AXIS_X	表示 x 轴。
static int	AXIS_Y	表示 y 轴。
static Component.ContourRefreshedListener	CONTOUR_BACKGROUND	组件的默认 ContourRefreshedListener。
static Component.ContourRefreshedListener	CONTOUR_BORDER	提供与组件矩形边框匹配的轮廓。
static Component.ContourRefreshedListener	CONTOUR_PADDING_BORDER	提供与组件的矩形填充边框匹配的轮廓。
static float	DEFAULT_SCALE	表示缩放组件的默认缩放系数。
static int	DRAG_DOWN	表示向下拖动滚动条。
static int	DRAG_HORIZONTAL	表示水平拖动滚动条。
static int	DRAG_HORIZONTAL_VERTICAL	表示滚动条水平和垂直拖动。
static int	DRAG_LEFT	表示向左拖动滚动条。
static int	DRAG_RIGHT	表示向右拖动滚动条。
static int	DRAG_UP	表示向上拖动滚动条。
static int	DRAG_VERTICAL	表示垂直拖动滚动条。
static int	EVENT_TYPE_COMPONENT_ACCESSIBILITY_FOCUSED	表示一个事件，指示获得了可访问性焦点。
static int	EVENT_TYPE_COMPONENT_ACCESSIBILITY_FOCUSED_CLEAR	表示一个事件，指示清除辅助功能焦点。
static int	EVENT_TYPE_COMPONENT_CLICKED	表示一个指示组件被单击的事件。
static int	EVENT_TYPE_COMPONENT_FOCUSED	表示一个指示组件获得焦点的事件。
static int	EVENT_TYPE_COMPONENT_LONG_CLICKED	表示一个指示组件被长按的事件。
static int	EVENT_TYPE_COMPONENT_SCROLLED	表示一个指示组件滚动的事件。
static int	EVENT_TYPE_COMPONENT_SELECTED	表示一个指示组件被选中的事件。
static int	EVENT_TYPE_COMPONENT_TEXT_UPDATE	表示指示 Text 组件中的文本已更改的事件。
static int	EVENT_TYPE_NOTICE	表示指示应用程序发送通知的事件。
static int	EVENT_TYPE_NOTIFICATION_STATE_UPDATE	表示指示显示通知的事件。
static int	EVENT_TYPE_TOAST_SHOW	表示指示显示 toast 的事件。
static int	EVENT_TYPE_WINDOW_STATE_UPDATE	表示指示窗口状态已更新的事件。
static int	FOCUS_ADAPTABLE	组件自行决定可聚焦性。
static int	FOCUS_DISABLE	该组件不需要击键。
static int	FOCUS_ENABLE	该组件需要击键。
static int	FOCUS_NEXT	将焦点移至下一个可点击项目。
static int	FOCUS_PREVIOUS	将焦点移到上一个可点击项目。
static int	FOCUS_SIDE_BOTTOM	向下移动焦点。
static int	FOCUS_SIDE_LEFT	将焦点移到左侧。
static int	FOCUS_SIDE_RIGHT	将焦点向右移动。
static int	FOCUS_SIDE_TOP	上移焦点。
static int	HIDE	该组件是不可见的，并且不占用任何用于布局目的的空间。
static int	HORIZONTAL	表示水平方向模式。
static int	ID_DEFAULT	组件的默认 ID。
static int	INHERITED_MODE	表示组件使用其父组件的显示模式。
static int	INVISIBLE	该组件是不可见的，但仍为布局目的占用空间。
protected Element	mBackgroundElement	表示在组件背景中绘制的元素对象。
protected Canvas	mCanvasForTaskOverContent	用于内容和前景之间的自定义绘图任务的画布。
protected Canvas	mCanvasForTaskUnderContent	用于背景和内容之间的自定义绘图任务的画布。
protected ComponentParent	mComponentParent	指示组件的父布局。
protected Context	mContext	表示上下文。
protected Component.DrawTask	mDrawTaskOverContent	自定义内容和前景之间的绘图任务。
protected Component.DrawTask	mDrawTaskUnderContent	自定义内容和背景之间的绘图任务。
protected Component.EstimateSizeListener	mEstimateSizeListener	在组件估计尺寸过程中自定义组件的宽度和高度
protected Element	mForegroundElement	表示在组件前景中绘制的元素对象。
protected Component.ForwardHoverListener	mForwardHoverListener	表示转发鼠标悬停事件时调用的回调。
protected Component.HoverEventListener	mHoverEventListener	表示接收到鼠标悬停事件时调用的回调。
protected Component.KeyEventListener	mKeyEventListener	表示当焦点组件接收到键事件时调用的回调。
protected Component.MouseEventListener	mMouseEventListener	表示接收到鼠标事件时调用的回调。
protected float[]	mPosition	为位置创建浮点值。
protected Component.RotationEventListener	mRotationEventListener	表示接收旋转事件时调用的回调。
protected ShadowElement	mShadowElement	表示以组件的 shadowstyle 绘制的元素对象。
protected Component.UnconsumedKeyEventListener	mUnconsumedKeyEventListener	表示接收到未使用的按键事件时调用的回调。
static int	OVAL_MODE	表示组件内容以椭圆显示。
static int	OVAL_SCROLL_BAR_MODE	表示滚动条显示为椭圆。
protected static int	POSITION_X_INDEX	位置数组中的 X 轴坐标。
protected static int	POSITION_Y_INDEX	位置数组中的 Y 轴坐标。
static int	RECT_MODE	表示组件内容以矩形显示。
static int	RECT_SCROLL_BAR_MODE	指示滚动条显示为矩形。
static int	SCROLL_AUTO_STAGE	表示组件会惯性滚动以响应专用操作（例如，甩动或反弹）。
static int	SCROLL_IDLE_STAGE	表示滚动已经结束，组件处于空闲状态。
static int	SCROLL_NORMAL_STAGE	表示组件响应外部操作（例如，用户触摸输入）自然滚动。
static int	UNSPECIFIED_SCROLL_BAR_MODE	指示滚动条的模式遵循显示组件的模式。
static int	VERTICAL	指示垂直方向模式。
static int	VISIBLE	该组件是可见的。

构造函数摘要

构造函数	描述
Component(Context context)	默认构造函数用于使用默认属性集和样式创建 Component 实例。
Component(Context context, AttrSet attrSet)	一个构造函数，用于在解析 XML 文件后使用指定的属性集和默认样式创建一个 Component 实例。
Component(Context context, AttrSet attrSet, int resId)	用于在 XML 文件解析后根据上下文、属性集和默认主题创建 Component 实例的构造函数。
Component(Context context, AttrSet attrSet, String styleName)	一个构造函数，用于在解析 XML 文件后，使用指定的属性集和指定的样式创建一个 Component 实例。

方法总结

修饰符和类型	方法	描述
void	addDrawTask(Component.DrawTask task)	在前景和组件内容之间添加绘图任务。
void	addDrawTask(Component.DrawTask task, int layer)	添加绘图任务。
void	addScrolledListener(Component.ScrolledListener listener)	添加一个监听器来监听组件的滚动阶段或位置发生变化时报告的滚动事件。
void	announceAccessibility(String text)	为 TYPE_ANNOUNCEMENT 类型的可访问性事件设置文本。
void	arrange(int left, int top, int width, int height)	相对于父布局定位组件。
CornerMark	bindCornerMark()	将角标记对象设置为显示在组件顶部。
boolean	callOnClick()	调用分配的 OnClickListener。
boolean	canScroll(int orientation)	检查组件是否可以按指定方向滚动。
void	clearFocus()	请求放弃焦点。
AnimatorProperty	createAnimatorProperty()	创建与组件关联的属性动画器对象。
void	disableFadeEffect(Component.FadeEffectEnum fadeEffectEnum)	当组件未滚动时，禁用滚动条或边界指示器的淡出效果。
protected void	dispatchRestoreState(PlainArraySequenceable stateContainer)	分发状态恢复过程来恢复该组件及其子组件的状态。
protected void	dispatchSaveState(PlainArraySequenceable stateContainer)	分发状态保存过程，保存该组件及其子组件的状态。
void	draw(Canvas canvas)	在画布上绘制此组件及其子组件。
void	enableCornerMark(boolean enable)	启用或禁用当前组件的角标记。
void	enableFadeEffect(Component.FadeEffectEnum fadeEffectEnum)	当组件未滚动时，启用滚动条或边界指示器的淡出效果。
void	enableSaveState(boolean isEnabled)	设置此组件及其子组件是否可以保存其状态。
void	enableScrollBar(int direction, boolean enabled)	设置是否为此组件启用滚动条。
void	estimateSize(int widthEstimatedConfig, int heightEstimatedConfig)	设置组件的宽度和高度尺寸和要求
boolean	executeDoubleClick()	执行此组件中发生的双击事件。
boolean	executeLongClick()	在组件中执行长按事件。
<T extends Component>T	findComponentById(int id)	查找具有给定 ID 的组件。
ComponentHolder	findComponentHolderById(int resId)	使用资源 ID 获取 ComponentHolder 实例。
Component	findFocus()	获取当前在其后代组件和自身中具有焦点的组件。
Component	findNextFocusableComponent(int direction)	查找下一个要关注的组件。
boolean	findRequestNextFocus(int side)	找到下一个获得焦点的组件并为其请求焦点。
int	getAccessibility()	获取可访问性状态。
String	getAccessibilityDescription()	获取该组件的可访问性描述。
float	getAlpha()	获取组件的 alpha 值。
float	getAltitude()	获取该组件在垂直于屏幕方向的基本深度位置。
Element	getBackgroundElement()	获取组件背景中的元素。
int	getBaseLine()	获取从文本基线到组件顶部的高度。
int	getBottom()	获取组件相对于父布局的底部边缘位置。
float	getBoundaryFadeEffectBottomRate()	获得率乘以基本边界宽度，得到组件淡化效果区域的底部边界宽度。
float	getBoundaryFadeEffectLeftRate()	获取速率乘以基本边界宽度，得到组件淡化效果区域的左边界宽度。
float	getBoundaryFadeEffectRightRate()	获取速率乘以基本边界宽度，得到组件淡化效果区域的右边界宽度。
float	getBoundaryFadeEffectTopRate()	获取速率乘以基本边界宽度，得到组件淡化效果区域的顶部边界宽度。
float[]	getCenterZoomFactor()	获取缩放中心组件项的缩放系数。
boolean	getCentralScrollMode()	获取中央滚动模式的状态。
Component.ClickedListener	getClickedListener()	获取监听该组件点击事件的监听器。
boolean	getClipEnabled()	检查此组件超出其父布局时是否启用自动剪裁。
CharSequence	getComponentDescription()	获取组件中内容的描述。
DimensFloat	getComponentMinSize()	获取此组件的可能最小大小。
ComponentParent	getComponentParent()	获取组件的父布局。
Rect	getComponentPosition()	获取组件相对于父布局的位置。
DimensFloat	getComponentSize()	获取组件大小。
Component.ComponentStateChangedListener	getComponentStateChangedListener()	获取监听该组件状态变化的监听器。
ComponentTreeObserver	getComponentTreeObserver()	获取组件的 ComponentTreeObserver。
boolean	getContentEnable()	获取组件的内容是否会被绘制。
float[]	getContentPosition()	绘制时获取位置。
float	getContentPositionX()	获取 X 轴坐标。
float	getContentPositionY()	获取 Y 轴坐标。
Context	getContext()	获取该组件持有的上下文对象。
Contour	getContour()	获取当前组件的 Contour 对象。
Component.ContourRefreshedListener	getContourRefreshedListener()	获取对组件的 Contour 对象进行更新的侦听器。
CornerMark	getCornerMark()	获取组件的角标对象。
float	getDragAcceptAngle()	获取为水平或垂直拖动识别器设置的偏转角。
Component.DraggedListener	getDraggedListener()	获取监听该组件拖动事件的监听器。
Component.EditEventListener	getEditEventListener()	获取监听由键盘快捷键触发并分发给该组件的编辑事件的监听器。
int	getEstimatedHeight()	返回组件的估计高度。
int	getEstimatedWidth()	返回组件的估计宽度。
int	getFadeEffectBoundaryWidth()	获取组件淡化效果区域的边界宽度。
Color	getFadeEffectColor()	获取产生淡入淡出效果时显示的颜色。
int	getFocusable()	获取组件的可聚焦设置。
boolean	getFocusBorderEnable()	检查当该组件处于焦点时是否显示焦点边框。
int	getFocusBorderPadding()	获取焦点边框和此组件之间的填充。
float[]	getFocusBorderRadius()	获取焦点边界的四个角的半径。
int	getFocusBorderWidth()	获取焦点边框的宽度。
Element	getForegroundElement()	获取组件前景中的元素。
int	getForegroundGravity()	已弃用。 此更改从 API 版本 6 开始生效。此方法是多余的，因此已弃用。
Component.ForwardHoverListener	getForwardHoverListener()	获取该组件向前鼠标悬停事件的监听器。
Component.ForwardTouchListener	getForwardTouchListener()	获取该组件前向触摸事件的监听器。
int	getGesturePriority(Component.GestureType gestureType)	获取手势的优先级。
int	getHeight()	获取组件的高度。
int[]	getHorizontalPadding()	获取此组件的水平填充。
int[]	getHorizontalPosition()	获取组件相对于父布局的水平位置。
Component.HoverEventListener	getHoverEventListener()	获取监听该组件悬停事件的监听器。
int	getId()	获取组件的唯一标识。
Component.KeyEventListener	getKeyEventListener()	获取监听该组件关键事件的监听器。
ComponentContainer.LayoutConfig	getLayoutConfig()	获取与组件关联的布局参数。
Component.LayoutDirection	getLayoutDirection()	获取该组件的布局方向。
Component.LayoutDirection	getLayoutDirectionResolved()	获取该组件的解析布局方向。
Component.LayoutRefreshedListener	getLayoutRefreshedListener()	获取监听该组件布局刷新的监听器。
int	getLeft()	获取组件相对于父布局的左边缘位置。
int[]	getLocationOnScreen()	获取组件在屏幕上的绝对位置。
int	getMarginBottom()	获取该组件的下边距。
int	getMarginLeft()	获取该组件的左边距。
int	getMarginRight()	获取该组件的右边距。
int[]	getMargins()	获取此组件的左、上、右和下边距。
int[]	getMarginsLeftAndRight()	获取该组件的水平边距。
int[]	getMarginsTopAndBottom()	获取该组件的垂直边距。
int	getMarginTop()	获取该组件的上边距。
Matrix	getMatrix()	获取当前组件的转换矩阵。
int	getMinHeight()	获取组件的最小可能高度。
int	getMinWidth()	获取组件的最小可能宽度。
int	getMode()	获取该组件的显示方式。
int	getModeResolved()	获取持有该组件的设备的显示模式。
Component.MouseEventListener	getMouseEventListener()	获取监听该组件鼠标事件的监听器。
Component.MousePointerStyleListener	getMousePointerStyleListener()	获取鼠标指针样式更改的侦听器。
String	getName()	获取组件的名称。
int[]	getPadding()	获取该组件的内边距。
int	getPaddingBottom()	获取组件的底部填充。
int	getPaddingEnd()	根据解析的布局方向获取组件的结束填充。
int	getPaddingLeft()	获取组件的左内边距。
int	getPaddingRight()	获取组件的正确填充。
int	getPaddingStart()	根据解析的布局方向获取组件的开始填充。
int	getPaddingTop()	获取组件的顶部填充。
Point	getPivot()	获取相对于父布局的枢轴。
float	getPivotX()	获取组件旋转缩放所围绕的点，即轴心点的X轴坐标。
float	getPivotY()	获取枢轴点相对于父布局的 Y 轴坐标。
ResourceManager	getResourceManager()	获取与上下文关联的资源管理器。
int	getRight()	获取组件相对于父布局的右边缘位置。
float	getRotation()	获取组件相对于父布局绕 Z 轴旋转的度数。
Component.RotationEventListener	getRotationEventListener()	获取监听该组件旋转事件的监听器。
float	getRotationSensitivity()	获取组件的旋转灵敏度。
DimensFloat	getScale()	获取组件相对于父布局的枢轴周围的比例因子。
Component.ScaledListener	getScaledListener()	获取监听该组件缩放事件的监听器。
float	getScaleX()	获取组件在 X 方向上相对于父布局的枢轴点的缩放因子。
float	getScaleY()	获取组件在 Y 方向上相对于父布局的枢轴点的缩放因子。
Color	getScrollbarBackgroundColor()	获取滚动条的背景颜色。
Color	getScrollbarColor()	获取滚动条的颜色。
int	getScrollbarFadingDelay()	获取滚动条消失之前的延迟。
int	getScrollbarFadingDuration()	获取滚动条的淡出持续时间。
int	getScrollBarMode()	获取正在显示的滚动条的模式。
float	getScrollbarRadius()	获取滚动条圆角边框的半径。
boolean	getScrollbarRoundRect()	获取滚动条的圆角边框。
float	getScrollbarStartAngle()	获取圆形滚动条的起始角度。
float	getScrollbarSweepAngle()	获取圆形滚动条的扫角。
int	getScrollbarThickness()	获取滚动条的粗细。
int	getScrollState()	获取组件滚动状态。
int	getScrollValue(int direction)	获取该组件的滚动偏移量。
boolean	getSelfVisibleRect(Rect rect)	允许获取本地可见的 Rect（与组件的父级相关）
Color	getShadowColor()	获取组件的阴影颜色。
Component.SpeechEventListener	getSpeechEventListener()	获取 setSpeechEventListener(ohos.agp.components.Component.SpeechEventListener) 设置的监听器。
Object	getTag()	获取组件的标签。
int	getTop()	获取组件相对于父布局的上边缘位置。
Component.TouchEventListener	getTouchEventListener()	获取监听该组件触摸事件的监听器。
String	getTransitionSymbol()	获取过渡符号。
DimensFloat	getTranslation()	获取组件相对于其左边界的水平平移和相对于其上边界的垂直平移。
float	getTranslationX()	获取组件相对于其左侧位置的水平平移。
float	getTranslationY()	获取组件相对于其顶部位置的垂直平移。
float	getTranslationZ()	获取该组件在垂直于屏幕方向的深度位置变化。
int	getUserNextFocus(int side)	获取下一个要关注的组件的 ID。
int[]	getVerticalPadding()	获取此组件的垂直填充。
int[]	getVerticalPosition()	获取组件相对于父布局的位置。
int	getVisibility()	获取组件的可见性。
boolean	getVisibleRectOnScreen(Rect rect, int[] position)	获取组件相对于屏幕左上角的可见矩形区域。
int	getWidth()	获取组件的宽度。
boolean	getWindowVisibleRect(Rect visibleRect)	获取组件所在窗口的可见矩形。
boolean	hasFocus()	返回组件是否有焦点。
boolean	hasFocusedEffect()	检查该组件获得焦点时是否显示焦点效果。
boolean	hasOverlaps()	检查此组件是否有重叠内容。
void	hideFocusBorder()	已弃用。 此更改自 API 版本 8 起生效。此方法是多余且临时的，因此已弃用。
void	informConfigurationChanged(Configuration config)	调度配置更改事件。
void	invalidate()	使组件无效。
boolean	isBoundaryFadeEffectEnable()	已弃用。 此更改从 API 版本 6 开始生效。替换为 isFadeEffected(FadeEffectEnum)
boolean	isBoundToWindow()	检查组件是否已绑定到窗口。
boolean	isClickable()	返回组件是否响应点击事件。
boolean	isClipToContourEnabled()	检查组件的 Contour 对象是否可用于内容剪辑。
boolean	isComponentDisplayed()	检查组件是否可以显示。
boolean	isEnabled()	获取组件的启用状态。
boolean	isFadeEffected(Component.FadeEffectEnum fadeEffectEnum)	检查是否为滚动条或边界指示器启用了淡出效果。
boolean	isFocusable()	返回组件当前是否可以接收焦点。
boolean	isFocused()	返回组件是否已获得焦点。
boolean	isIdentityMatrix()	检查当前组件的转换矩阵是否为单位矩阵。
boolean	isLongClickOn()	返回组件是否可长时间点击。
boolean	isPressed()	返回组件当前是否处于按下状态。
boolean	isRtl()	检查组件是否从右到左布局。
boolean	isSaveStateEnabled()	检查此组件及其子组件是否可以保存其状态。
boolean	isScrollbarFadingOn()	已弃用。 此更改从 API 版本 6 开始生效。替换为 isFadeEffected(FadeEffectEnum)
boolean	isScrollBarOn(int direction)	检查是否为此组件启用了滚动条。
boolean	isScrollbarOverlapEnabled()	检查滚动条是否与内容重叠。
boolean	isSelected()	获取组件的选择状态。
boolean	isSoundEnable()	检查单击此组件时是否播放声音。
boolean	isTouchFocusable()	返回组件是否可以在触摸模式下接收焦点。
boolean	isVibrationEffectEnabled()	检查是否启用了振动效果。
void	notifyAccessibility(int eventType)	触发此组件指定的可访问性事件。
protected void	onAttributeConfigChanged(Configuration config)	更改配置时调用。
boolean	onDrag(Component component, DragEvent event)	在将拖动事件分派到组件时调用。
protected void	onRestoreState(Sequenceable state)	当要恢复此组件及其子组件的状态时调用。
protected void	onRtlChanged(Component.LayoutDirection layoutDirection)	在更改任何 RTL 属性时调用。
protected Sequenceable	onSaveState()	当要保存此组件及其子组件的状态时调用。
boolean	performScale()	在组件中执行缩放事件。
void	playSound(int soundId)	播放此组件的声音。
void	postLayout()	请求重新排列组件的布局。
void	refreshContour()	刷新组件的当前 Contour 对象并触发 ContourRefreshedListener#onContourRefreshed(Component) 用于设置自定义 Contour 对象。
void	release()	释放资源。
void	removeBindStateChangedListener(Component.BindStateChangedListener listener)	删除绑定状态更改的侦听器。
void	removeScrolledListener(Component.ScrolledListener listener)	删除一个监听滚动事件的监听器。
boolean	requestFocus()	请求当前组件或其子组件之一的焦点。
void	requestForceForwardTouchEvent(boolean forceForward)	当组件希望此父级及其祖先继续转发触摸事件时调用。
void	restoreComponentTreeState(PlainArraySequenceable stateContainer)	从给定容器中恢复此组件及其子组件的状态。
void	saveComponentTreeState(PlainArraySequenceable stateContainer)	将此组件及其子组件的状态保存到给定容器中。
void	scrollBy(int x, int y)	设置组件滚动的偏移量。
void	scrollTo(int x, int y)	设置您希望组件滚动到的目标位置。
void	setAccessibility(int flag)	设置可访问性状态。
void	setAccessibilityDescription(String description)	设置此组件的可访问性模式的描述。
void	setAlpha(float alpha)	设置组件的 alpha 值。
void	setAltitude(float altitude)	设置此组件在垂直于屏幕的方向上的基本深度位置。
void	setBackground(Element element)	将指定元素设置为组件的背景。
void	setBindStateChangedListener(Component.BindStateChangedListener listener)	添加绑定状态更改的侦听器。
void	setBottom(int bottom)	设置组件相对于父容器的底部边缘位置。
void	setBoundaryFadeEffectEnable(boolean enable)	已弃用。 此更改从 API 版本 6 开始生效。替换为 enableFadeEffect(FadeEffectEnum) 或 disableFadeEffect(FadeEffectEnum)
void	setCanAcceptScrollListener(Component.CanAcceptScrollListener listener)
void	setCenterZoomFactor(float scaleX, float scaleY)	设置缩放中心组件项目的缩放系数。
void	setCentralScrollMode(boolean centralMode)	设置是否启用中央滚动模式以始终在组件中心显示组件项。
void	setClickable(boolean clickable)	启用或禁用组件的点击事件。
void	setClickedListener(Component.ClickedListener listener)	为组件中的点击事件注册一个监听器。
void	setClipEnabled(boolean enabled)	设置是否允许在组件超出其父布局时自动裁剪。
void	setClipToContourEnabled(boolean enable)	设置组件的 Contour 对象是否可用于内容裁剪。
void	setComponentDescription(CharSequence componentDescription)	设置组件中内容的描述。
void	setComponentMinSize(int minWidth, int minHeight)	设置此组件的最小可能宽度和高度。
void	setComponentPosition(int left, int top, int right, int bottom)	设置组件相对于父容器的位置。
void	setComponentPosition(Rect rect)	根据 rect 设置组件相对于父容器的位置。
void	setComponentSize(int width, int height)	设置组件大小。
void	setComponentStateChangedListener(Component.ComponentStateChangedListener listener)	设置组件状态更改事件的侦听器。
void	setContentEnable(boolean enable)	设置是否为组件绘制内容。
void	setContentPosition(float x, float y)	设置绘图和事件监听的位置。
void	setContentPositionX(float x)	设置绘图和事件监听的 x 坐标。
void	setContentPositionY(float y)	设置绘图和事件监听的 y 坐标。
void	setContour(Contour contour)	为组件设置自定义轮廓对象。
void	setContourRefreshedListener(Component.ContourRefreshedListener listener)	注册一个侦听器以获取组件的 Contour 对象的更新。
void	setDoubleClickedListener(Component.DoubleClickedListener listener)	注册监听该组件的双击事件。
void	setDragAcceptAngle(float degree)	设置水平或垂直拖动识别器的偏转角度。
void	setDraggedListener(int dragMode, Component.DraggedListener listener)	为组件的拖动事件注册一个监听器。
void	setEditEventListener(Component.EditEventListener listener)	注册一个侦听器以观察由键盘快捷键触发并分发到此组件的编辑事件。
void	setEnabled(boolean enabled)	设置组件的启用状态。
protected void	setEstimatedSize(int estimatedWidth, int estimatedHeight)	这应该从 EstimateSizeListener#onEstimateSize(int, int) 调用以设置测量的宽度和高度。
protected void	setEstimateSizeListener(Component.EstimateSizeListener listener)	在组件的大小估计过程中添加一个侦听器。
void	setFadeEffectBoundaryWidth(int width)	设置组件的淡入淡出效果区域的边界宽度。
void	setFadeEffectColor(Color color)	设置产生淡入淡出效果时显示的颜色。
void	setFocusable(int focusable)	设置组件是否可以接收焦点。
void	setFocusBorderEnable(boolean enabled)	设置当该组件处于焦点时是否启用焦点边框。
void	setFocusBorderPadding(int padding)	设置焦点边框和此组件之间的填充。
void	setFocusBorderRadius(float radius)	设置焦点边框的半径。
void	setFocusBorderRadius(float[] radii)	设置焦点边框角的半径。
void	setFocusBorderWidth(int width)	设置焦点边框的宽度。
void	setFocusChangedListener(Component.FocusChangedListener listener)	为组件中的焦点更改事件注册一个侦听器。
void	setFocusedEffect(boolean enabled)	设置此组件获得焦点时是否具有焦点效果。
void	setForeground(Element element)	将指定元素设置为组件的前景。
void	setForegroundGravity(int foregroundGravity)	已弃用。 此更改从 API 版本 6 开始生效。此方法是多余的，因此已弃用。
void	setForwardHoverListener(Component.ForwardHoverListener listener)	注册一个监听器来决定将鼠标悬停事件转发给子组件。
void	setForwardTouchListener(Component.ForwardTouchListener listener)	注册一个监听器来决定子组件的前向触摸事件。
void	setGesturePriority(Component.GestureType gestureType, int priority)	设置手势的优先级。
void	setHeight(int height)	设置组件的高度。
void	setHorizontalPadding(int left, int right)	设置此组件的水平填充。
void	setHorizontalPosition(int left, int right)	设置组件相对于父容器的水平位置。
void	setHoverEventListener(Component.HoverEventListener listener)	为组件中的悬停事件注册一个侦听器。
void	setId(int id)	设置组件的唯一 ID。
void	setKeyEventListener(Component.KeyEventListener listener)	为组件中的关键事件注册一个监听器。
void	setLayoutConfig(ComponentContainer.LayoutConfig config)	设置组件在其父布局中的布局参数。
void	setLayoutDirection(Component.LayoutDirection layoutDirection)	设置此组件的布局方向。
void	setLayoutRefreshedListener(Component.LayoutRefreshedListener listener)	为组件的重新布局注册一个监听器。
void	setLeft(int left)	设置组件相对于父容器的左边缘位置。
void	setLongClickable(boolean longClickable)	设置组件是否可长按。
void	setLongClickedListener(Component.LongClickedListener listener)	为组件中的长按事件注册一个监听器（组件被单击并按住）。
void	setMarginBottom(int bottom)	设置此组件的下边距。
void	setMarginLeft(int left)	设置此组件的左边距。
void	setMarginRight(int right)	设置此组件的右边距。
void	setMarginsLeftAndRight(int left, int right)	设置此组件的水平边距。
void	setMarginsTopAndBottom(int top, int bottom)	设置此组件的垂直边距。
void	setMarginTop(int top)	设置此组件的上边距。
void	setMinHeight(int minHeight)	设置组件的最小高度。
void	setMinWidth(int minWidth)	设置组件的最小可能宽度。
void	setMode(int mode)	设置此组件的显示模式。
void	setMouseEventListener(Component.MouseEventListener listener)	为组件中的鼠标事件注册一个监听器。
void	setMousePointerStyleListener(Component.MousePointerStyleListener listener)	注册鼠标指针样式更改的侦听器。
void	setName(String name)	设置组件的名称。
void	setOnDragListener(Component.OnDragListener listener)	为组件中的拖动事件注册一个监听器。
void	setPadding(int left, int top, int right, int bottom)	设置组件的填充。
void	setPaddingBottom(int bottom)	设置此组件的底部填充。
void	setPaddingLeft(int left)	设置此组件的左侧填充。
void	setPaddingRelative(int start, int top, int end, int bottom)	设置组件的相对填充。
void	setPaddingRight(int right)	为此组件设置正确的填充。
void	setPaddingTop(int top)	设置此组件的顶部填充。
void	setPivot(float x, float y)	设置枢轴（点），围绕该组件旋转和缩放。
void	setPivot(Point point)	设置枢轴（点），此组件基于该点旋转和缩放。
void	setPivotX(float pivotX)	设置组件旋转和缩放所围绕的点的 X 轴坐标，即枢轴点。
void	setPivotY(float pivotY)	设置组件旋转和缩放所围绕的点，即枢轴点的 Y 轴坐标。
void	setPosition(int coordX, int coordY)	设置组件左上角相对于父布局的位置。
void	setPositionX(int coordX)	设置组件左上角相对于父布局的 x 坐标。
void	setPositionY(int coordY)	设置组件左上角相对于父布局的 y 坐标。
void	setPressState(boolean pressState)	设置组件的按下状态。
void	setRight(int right)	设置组件相对于父容器的右边缘位置。
void	setRotation(float degree)	设置组件绕 Z 轴旋转的度数。
void	setRotationEventListener(Component.RotationEventListener listener)	为组件中的旋转事件注册一个监听器。
void	setRotationSensitivity(float value)	设置组件的旋转灵敏度。
void	setScale(float x, float y)	围绕枢轴设置组件的比例因子。
void	setScaledListener(Component.ScaledListener listener)	为组件的缩放事件注册一个监听器。
void	setScaleX(float scaleX)	围绕枢轴点设置组件在 X 方向上的缩放因子。
void	setScaleY(float scaleY)	围绕枢轴点设置组件在 Y 方向上的缩放因子。
void	setScrollbarBackgroundColor(Color color)	设置滚动条的背景颜色。
void	setScrollbarColor(Color color)	设置滚动条的颜色。
void	setScrollbarFadingDelay(int delay)	设置滚动条消失之前的延迟。
void	setScrollbarFadingDuration(int duration)	设置滚动条的淡出持续时间。
void	setScrollbarFadingEnabled(boolean enabled)	已弃用。 此更改从 API 版本 6 开始生效。替换为 enableFadeEffect(FadeEffectEnum) 或 disableFadeEffect(FadeEffectEnum)
void	setScrollBarMode(int scrollBarMode)	设置正在显示的滚动条的模式。
void	setScrollbarOverlapEnabled(boolean enabled)	设置滚动条是否与内容重叠。
void	setScrollbarRadius(float radius)	设置滚动条圆角边框的半径。
void	setScrollbarRoundRect(boolean isRoundRect)	设置滚动条的形状。
void	setScrollbarStartAngle(float start)	设置圆形滚动条的起始角度。
void	setScrollbarSweepAngle(float sweep)	设置圆形滚动条的扫角。
void	setScrollbarThickness(int thickness)	设置滚动条的粗细。
void	setScrolledListener(Component.ScrolledListener listener)	为组件中的滚动事件注册一个监听器。
void	setSelected(boolean selected)	设置组件的选择状态。
void	setShadowColor(Color color)	设置组件的阴影颜色。
void	setShadowStyle(Component.ShadowSize size, Component.ShadowMode mode, Component.ShadowDevice device)	将指定元素设置为组件的阴影样式。
void	setSoundEnable(boolean enable)	单击此组件时启用或禁用该组件的声音。
void	setSpeechEventListener(Component.SpeechEventListener listener)	设置此组件中语音事件的侦听器。
void	setTag(Object tag)	设置与组件关联的标签。
void	setTop(int top)	设置组件相对于父容器的顶部边缘位置。
void	setTouchEventListener(Component.TouchEventListener listener)	为组件中的触摸事件注册一个监听器。
void	setTouchFocusable(boolean focusable)	设置组件在触摸模式下是否可以接收焦点。
void	setTransitionSymbol(String symbol)	设置过渡符号。
void	setTranslation(float x, float y)	设置组件相对于其左边界的水平平移和相对于其上边界的垂直平移。
void	setTranslationX(float translationX)	设置组件相对于其左侧位置的水平位置。
void	setTranslationY(float translationY)	设置组件相对于其顶部位置的垂直位置。
void	setTranslationZ(float translationZ)	设置该组件在垂直于屏幕方向的深度位置变化。
void	setUnconsumedKeyEventListener(Component.UnconsumedKeyEventListener listener)	为组件中未使用的键事件注册一个侦听器。
void	setUserNextFocus(int side, int id)	设置要关注的下一个组件。
void	setVerticalPadding(int top, int bottom)	设置此组件的垂直填充。
void	setVerticalPosition(int top, int bottom)	设置组件相对于父容器的垂直位置。
void	setVibrationEffectEnabled(boolean enabled)	设置是否开启震动效果。
void	setVisibility(int visibility)	设置组件的可见性。
void	setWidth(int width)	设置组件的宽度。
void	showFocusBorder()	已弃用。 此更改自 API 版本 8 起生效。此方法是多余且临时的，因此已弃用。
boolean	simulateClick()	在组件中执行单击事件。
boolean	simulateDrag()	执行组件的拖动事件。
boolean	startDragAndDrop(MimeData data, Component.DragFeedbackProvider shadowProvider)	开始拖动组件。
void	subscribeVoiceEvents(Component.VoiceEvent voiceEvent)	订阅该组件的指定语音事件。
void	unsubscribeVoiceEvents()	一次取消订阅当前组件订阅的所有语音事件。

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

字段详细信息

ACCESSIBILITY_ADAPTABLE

public static final int ACCESSIBILITY_ADAPTABLE

表示可以访问该组件。

ACCESSIBILITY_DISABLE

public static final int ACCESSIBILITY_DISABLE

表示无法访问该组件。

ACCESSIBILITY_ENABLE

public static final int ACCESSIBILITY_ENABLE

表示该组件已启用。

AXIS_X

public static final int AXIS_X

表示 x 轴。

AXIS_Y

public static final int AXIS_Y

表示 y 轴。

CONTOUR_BACKGROUND

public static final Component.ContourRefreshedListener CONTOUR_BACKGROUND

组件的默认 ContourRefreshedListener。 如果背景元素已经设置到当前组件中，则从元素中获取轮廓并设置到组件中。 否则，设置与组件大小相同的透明轮廓。

CONTOUR_BORDER

public static final Component.ContourRefreshedListener CONTOUR_BORDER

提供与组件矩形边框匹配的轮廓。

CONTOUR_PADDING_BORDER

public static final Component.ContourRefreshedListener CONTOUR_PADDING_BORDER

提供与组件的矩形填充边框匹配的轮廓。

DEFAULT_SCALE

public static final float DEFAULT_SCALE

表示缩放组件的默认缩放系数。

DRAG_DOWN

public static final int DRAG_DOWN

表示向下拖动滚动条。

DRAG_HORIZONTAL

public static final int DRAG_HORIZONTAL

表示水平拖动滚动条。

DRAG_HORIZONTAL_VERTICAL

public static final int DRAG_HORIZONTAL_VERTICAL

表示滚动条水平和垂直拖动。

DRAG_LEFT

public static final int DRAG_LEFT

表示向左拖动滚动条。

DRAG_RIGHT

public static final int DRAG_RIGHT

表示向右拖动滚动条。

DRAG_UP

public static final int DRAG_UP

表示向上拖动滚动条。

DRAG_VERTICAL

public static final int DRAG_VERTICAL

表示垂直拖动滚动条。

EVENT_TYPE_COMPONENT_ACCESSIBILITY_FOCUSED

public static final int EVENT_TYPE_COMPONENT_ACCESSIBILITY_FOCUSED

表示一个事件，指示获得了可访问性焦点。

EVENT_TYPE_COMPONENT_ACCESSIBILITY_FOCUSED_CLEAR

public static final int EVENT_TYPE_COMPONENT_ACCESSIBILITY_FOCUSED_CLEAR

表示一个事件，指示清除辅助功能焦点。

EVENT_TYPE_COMPONENT_CLICKED

public static final int EVENT_TYPE_COMPONENT_CLICKED

表示一个指示组件被单击的事件。

EVENT_TYPE_COMPONENT_FOCUSED

public static final int EVENT_TYPE_COMPONENT_FOCUSED

表示一个指示组件获得焦点的事件。

EVENT_TYPE_COMPONENT_LONG_CLICKED

public static final int EVENT_TYPE_COMPONENT_LONG_CLICKED

表示一个指示组件被长按的事件。

EVENT_TYPE_COMPONENT_SCROLLED

public static final int EVENT_TYPE_COMPONENT_SCROLLED

表示一个指示组件滚动的事件。

EVENT_TYPE_COMPONENT_SELECTED

public static final int EVENT_TYPE_COMPONENT_SELECTED

表示一个指示组件被选中的事件。

EVENT_TYPE_COMPONENT_TEXT_UPDATE

public static final int EVENT_TYPE_COMPONENT_TEXT_UPDATE

表示指示 Text 组件中的文本已更改的事件。

EVENT_TYPE_NOTICE

public static final int EVENT_TYPE_NOTICE

表示指示应用程序发送通知的事件。

EVENT_TYPE_NOTIFICATION_STATE_UPDATE

public static final int EVENT_TYPE_NOTIFICATION_STATE_UPDATE

表示指示显示通知的事件。

EVENT_TYPE_TOAST_SHOW

public static final int EVENT_TYPE_TOAST_SHOW

表示指示显示 toast 的事件。

EVENT_TYPE_WINDOW_STATE_UPDATE

public static final int EVENT_TYPE_WINDOW_STATE_UPDATE

表示指示窗口状态已更新的事件。

FOCUS_ADAPTABLE

public static final int FOCUS_ADAPTABLE

组件自行决定可聚焦性。 这是默认状态。 此常量用作 setFocusable(int) 的参数。

FOCUS_DISABLE

public static final int FOCUS_DISABLE

该组件不需要击键。 此常量用作 setFocusable(int) 的参数。

FOCUS_ENABLE

public static final int FOCUS_ENABLE

该组件需要击键。 此常量用作 setFocusable(int) 的参数。

FOCUS_NEXT

public static final int FOCUS_NEXT

将焦点移至下一个可点击项目。 此常量用作 findNextFocusableComponent(int) 的参数。

FOCUS_PREVIOUS

public static final int FOCUS_PREVIOUS

将焦点移到上一个可点击项目。 此常量用作 findNextFocusableComponent(int) 的参数。

FOCUS_SIDE_BOTTOM

public static final int FOCUS_SIDE_BOTTOM

向下移动焦点。 此常量用作 findNextFocusableComponent(int) 的参数。

FOCUS_SIDE_LEFT

public static final int FOCUS_SIDE_LEFT

将焦点移到左侧。 此常量用作 findNextFocusableComponent(int) 的参数。

FOCUS_SIDE_RIGHT

public static final int FOCUS_SIDE_RIGHT

将焦点向右移动。 此常量用作 findNextFocusableComponent(int) 的参数。

FOCUS_SIDE_TOP

public static final int FOCUS_SIDE_TOP

上移焦点。 此常量用作 findNextFocusableComponent(int) 的参数。

HIDE

public static final int HIDE

该组件是不可见的，并且不占用任何用于布局目的的空间。 此常量用作 setVisibility(int) 的参数。

HORIZONTAL

public static final int HORIZONTAL

表示水平方向模式。

ID_DEFAULT

public static final int ID_DEFAULT

组件的默认 ID。 值 -1 表示未设置组件 ID。

INHERITED_MODE

public static final int INHERITED_MODE

表示组件使用其父组件的显示模式。 此常量用作 setMode(int) 的输入参数。

INVISIBLE

public static final int INVISIBLE

该组件是不可见的，但仍为布局目的占用空间。 此常量用作 setVisibility(int) 的参数。

OVAL_MODE

public static final int OVAL_MODE

表示组件内容以椭圆显示。 此常量用作 setMode(int) 的输入参数。

OVAL_SCROLL_BAR_MODE

public static final int OVAL_SCROLL_BAR_MODE

表示滚动条显示为椭圆。 此常量用作 setScrollBarMode(int) 的输入参数。

POSITION_X_INDEX

protected static final int POSITION_X_INDEX

位置数组中的 X 轴坐标。

POSITION_Y_INDEX

protected static final int POSITION_Y_INDEX

位置数组中的 Y 轴坐标。

RECT_MODE

public static final int RECT_MODE

表示组件内容以矩形显示。 此常量用作 setMode(int) 的输入参数。

RECT_SCROLL_BAR_MODE

public static final int RECT_SCROLL_BAR_MODE

指示滚动条显示为矩形。 此常量用作 setScrollBarMode(int) 的输入参数。

SCROLL_AUTO_STAGE

public static final int SCROLL_AUTO_STAGE

表示组件会惯性滚动以响应专用操作（例如，甩动或反弹）。

SCROLL_IDLE_STAGE

public static final int SCROLL_IDLE_STAGE

表示滚动已经结束，组件处于空闲状态。

SCROLL_NORMAL_STAGE

public static final int SCROLL_NORMAL_STAGE

表示组件响应外部操作（例如，用户触摸输入）自然滚动。

UNSPECIFIED_SCROLL_BAR_MODE

public static final int UNSPECIFIED_SCROLL_BAR_MODE

指示滚动条的模式遵循显示组件的模式。 此常量用作 setScrollBarMode(int) 的输入参数。

VERTICAL

public static final int VERTICAL

指示垂直方向模式。

VISIBLE

public static final int VISIBLE

该组件是可见的。 此常量用作 setVisibility(int) 的参数。

mBackgroundElement

protected Element mBackgroundElement

表示在组件背景中绘制的元素对象。

mCanvasForTaskOverContent

protected Canvas mCanvasForTaskOverContent

用于内容和前景之间的自定义绘图任务的画布。

mCanvasForTaskUnderContent

protected Canvas mCanvasForTaskUnderContent

用于背景和内容之间的自定义绘图任务的画布。

mComponentParent

protected ComponentParent mComponentParent

指示组件的父布局。

mContext

protected Context mContext

表示上下文。

mDrawTaskOverContent

protected Component.DrawTask mDrawTaskOverContent

自定义内容和前景之间的绘图任务。

mDrawTaskUnderContent

protected Component.DrawTask mDrawTaskUnderContent

自定义内容和背景之间的绘图任务。

mEstimateSizeListener

protected Component.EstimateSizeListener mEstimateSizeListener

在组件估计尺寸过程中自定义组件的宽度和高度

mForegroundElement

protected Element mForegroundElement

表示在组件前景中绘制的元素对象。

mForwardHoverListener

protected Component.ForwardHoverListener mForwardHoverListener

表示转发鼠标悬停事件时调用的回调。

mHoverEventListener

protected Component.HoverEventListener mHoverEventListener

表示接收到鼠标悬停事件时调用的回调。

mKeyEventListener

protected Component.KeyEventListener mKeyEventListener

表示当焦点组件接收到键事件时调用的回调。

mMouseEventListener

protected Component.MouseEventListener mMouseEventListener

表示接收到鼠标事件时调用的回调。

mPosition

protected float[] mPosition

为位置创建浮点值。

mRotationEventListener

protected Component.RotationEventListener mRotationEventListener

表示接收旋转事件时调用的回调。

mShadowElement

protected ShadowElement mShadowElement

表示以组件的 shadowstyle 绘制的元素对象。

mUnconsumedKeyEventListener

protected Component.UnconsumedKeyEventListener mUnconsumedKeyEventListener

表示接收到未使用的按键事件时调用的回调。

构造函数详细信息

Component

public Component(Context context)

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

参数：

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

Component

public Component(Context context, AttrSet attrSet)

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

参数：

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

Component

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

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

参数：

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

Component

public Component(Context context, AttrSet attrSet, int resId)

用于在 XML 文件解析后根据上下文、属性集和默认主题创建 Component 实例的构造函数。

参数：

参数名称	参数描述
context	指示应用程序上下文。
attrSet	表示属性集。
resId	表示默认主题的资源ID。

方法详情

findComponentHolderById

public ComponentHolder findComponentHolderById(int resId)

使用资源 ID 获取 ComponentHolder 实例。

参数：

参数名称	参数描述
resId	指示要使用的资源 ID。

返回:

返回 ComponentHolder 实例。

draw

public void draw(Canvas canvas)

在画布上绘制此组件及其子组件。

此方法必须在主线程中调用。

参数：

参数名称	参数描述
canvas	表示用于绘图的画布。

startDragAndDrop

public final boolean startDragAndDrop(MimeData data, Component.DragFeedbackProvider shadowProvider)

开始拖动组件。

有一种方法可以打开拖动。 需要为此组件设置 LongClickedListener。 在 TouchEvent#PRIMARY_POINT_UP 之前调用 LongClickedListener 侦听器后，组件已准备好进行 DragAndDrop。 需要在 LongClickedListener#onLongClicked 回调中调用 startDragAndDrop，并创建 DragFeedbackProvider 和 shadowComponent。

参数：

参数名称	参数描述
data	表示被拖动组件携带的数据。
shadowProvider	指示被拖动组件样式的提供者。

返回:

如果组件准备好拖动，则返回 true； 否则返回 false。

getComponentParent

public final ComponentParent getComponentParent()

获取组件的父布局。

每个组件必须在父布局内，或者本身必须是根组件（或布局）。

返回:

返回组件的父布局； 如果组件本身是根组件（或布局），则返回空字符串。

setEstimateSizeListener

protected void setEstimateSizeListener(Component.EstimateSizeListener listener)

在组件的大小估计过程中添加一个侦听器。

参数：

参数名称	参数描述
listener	指定组件的大小估计侦听器。

addDrawTask

public void addDrawTask(Component.DrawTask task)

在前景和组件内容之间添加绘图任务。

该方法调用 addDrawTask(ohos.agp.components.Component.DrawTask,int)，其中 layer 的值为 DrawTask#BETWEEN_CONTENT_AND_FOREGROUND。

参数：

参数名称	参数描述
task	表示要添加的绘图任务。

addDrawTask

public void addDrawTask(Component.DrawTask task, int layer)

添加绘图任务。

每个组件的绘制包括其前景、内容和背景。您可以使用该方法在前景与内容之间或内容与背景之间添加绘制任务。

参数：

参数名称	参数描述
task	表示要添加的绘图任务。
layer	表示绘图任务的位置。 此值只能是 DrawTask#BETWEEN_BACKGROUND_AND_CONTENT 或 DrawTask#BETWEEN_CONTENT_AND_FOREGROUND。

invalidate

public void invalidate()

使组件无效。

该方法主要用于更新组件的绘制任务。 修改组件属性会自动触发组件更新。

setContentEnable

public void setContentEnable(boolean enable)

设置是否为组件绘制内容。

参数：

参数名称	参数描述
enable	指示是否绘制组件的内容。 true 表示绘制组件内容； false 表示不做。

getContentEnable

public boolean getContentEnable()

获取组件的内容是否会被绘制。

返回:

如果组件将被绘制，则返回 true； 否则返回 false。 默认值是true。

setFocusedEffect

public void setFocusedEffect(boolean enabled)

设置此组件获得焦点时是否具有焦点效果。

默认情况下，组件的焦点效果是焦点边框。 一个组件可能有它自己的自定义焦点效果。 例如，按钮的自定义焦点效果可以是圆角的焦点边框。 您还可以设置背景或前景来实现焦点效果。

参数：

参数名称	参数描述
enabled	指定是否启用焦点效果。 值 true（默认值）表示启用焦点效果，false 表示相反。

hasFocusedEffect

public boolean hasFocusedEffect()

检查该组件获得焦点时是否显示焦点效果。

返回:

如果显示焦点效果，则返回 true（默认值）； 否则返回 false。

createAnimatorProperty

public AnimatorProperty createAnimatorProperty()

创建与组件关联的属性动画器对象。

当您使用此方法创建 animator 对象时，当前组件会自动设置为 animator 的目标。 动画师只改变组件的显示和事件捕获区域。 它不会改变组件的布局。

返回:

返回与当前组件关联的新属性 animator 对象。

getContext

public Context getContext()

获取该组件持有的上下文对象。

返回:

返回应用程序上下文。

setPosition

public void setPosition(int coordX, int coordY)

设置组件左上角相对于父布局的位置。

参数：

参数名称	参数描述
coordX	表示 x 轴位置，以像素为单位。
coordY	表示 y 轴位置，以像素为单位。

setPositionX

public void setPositionX(int coordX)

设置组件左上角相对于父布局的 x 坐标。

参数：

参数名称	参数描述
coordX	指示要设置的 x 坐标，以像素为单位。

setPositionY

public void setPositionY(int coordY)

设置组件左上角相对于父布局的 y 坐标。

参数：

参数名称	参数描述
coordY	指示要设置的 y 坐标，以像素为单位。

setContentPosition

public void setContentPosition(float x, float y)

设置绘图和事件监听的位置。

每个组件相对于父布局的位置使用其左上角的位置来指示。 该方法用于改变组件在父布局中的位置，以及组件监听屏幕事件的区域。 此方法不会更改布局。 它应该主要用于动画。

参数：

参数名称	参数描述
x	表示新的 X 轴坐标，以像素为单位。
y	表示新的 Y 轴坐标，以像素为单位。

setContentPositionX

public void setContentPositionX(float x)

设置绘图和事件监听的 x 坐标。

您可以使用此方法：

• 更改组件在父布局中的位置。 每个组件都将其左上角作为其相对于父布局的位置。
• 监听屏幕事件。

调用此方法不会更改布局。 它应该主要用于动画。

参数：

参数名称	参数描述
x	指示要设置的 x 坐标，以像素为单位。

setContentPositionY

public void setContentPositionY(float y)

设置绘图和事件监听的 y 坐标。

您可以使用此方法：

• 更改组件在父布局中的位置。 每个组件都将其左上角作为其相对于父布局的位置。
• 监听屏幕事件。

调用此方法不会更改布局。 它应该主要用于动画。

参数：

参数名称	参数描述
y	指示要设置的 y 坐标，以像素为单位。

getContentPositionX

public float getContentPositionX()

获取 X 轴坐标。

每个组件相对于父布局的位置使用其左上角的位置来指示。 该值与组件左边缘的绝对位置不同。

返回:

返回 X 轴坐标，以像素为单位。

getContentPositionY

public float getContentPositionY()

获取 Y 轴坐标。

每个组件相对于父布局的位置使用其左上角的位置来指示。 此值与组件上边缘的绝对位置不同。

返回:

返回 Y 轴坐标，以像素为单位。

getContentPosition

public float[] getContentPosition()

绘制时获取位置。

每个组件相对于父布局的位置使用其左上角的位置来指示。 这些值与组件左上角的绝对位置不同。

返回:

返回位置数组，该数组的内容为 X 轴和 Y 轴坐标，以像素为单位。

getLocationOnScreen

public int[] getLocationOnScreen()

获取组件在屏幕上的绝对位置。

返回:

返回一个数组，表示组件的绝对位置，以像素为单位。

setWidth

public void setWidth(int width)

设置组件的宽度。

该方法在与组件关联的 LayoutConfig 对象中修改宽度。实际效果因父布局类型而异。

参数：

参数名称	参数描述
width	表示组件的宽度，以像素为单位。 小于 0 的值意味着不会显示组件。

setComponentSize

public void setComponentSize(int width, int height)

设置组件大小。

参数：

参数名称	参数描述
width	指示要设置的组件宽度，以像素为单位。 如果该值小于 0，则不显示该组件。
height	表示组件高度，以像素为单位。 如果该值小于 0，则不显示该组件。

getComponentSize

public DimensFloat getComponentSize()

获取组件大小。

返回:

返回表示组件大小的 DimensFloat，以像素为单位。

getWidth

public int getWidth()

获取组件的宽度。

如果组件已绑定到窗口，则此方法获取组件的实际宽度。 公式：宽度 = 右边缘的位置 - 左边缘的位置。 如果组件未绑定到窗口，则此方法返回其在 LayoutConfig 中记录的宽度。

返回:

返回组件的宽度，以像素为单位。

setHeight

public void setHeight(int height)

设置组件的高度。

此方法修改与组件关联的 LayoutConfig 对象中的高度。 实际效果因父布局类型而异。

参数：

参数名称	参数描述
height	表示组件的高度，以像素为单位。 小于 0 的值意味着不会显示组件。

setRotationSensitivity

public void setRotationSensitivity(float value)

设置组件的旋转灵敏度。 每个支持旋转表冠的组件都提供了介于 ROTATION_SENSITIVITY_LOW 和 ROTATION_SENSITIVITY_HIGH 之间的合适灵敏度范围。 ROTATION_SENSITIVITY_DEFAULT 的旋转灵敏度默认为每个组件设置。 您也可以适当调整旋转灵敏度。

参数：

参数名称	参数描述
value	表示组件的旋转灵敏度。

getRotationSensitivity

public float getRotationSensitivity()

获取组件的旋转灵敏度。

返回:

返回组件的旋转灵敏度。

getHeight

public int getHeight()

获取组件的高度。

如果组件已绑定到窗口，则此方法获取组件的实际高度。 公式：高度 = 上边缘的位置 - 下边缘的位置。 如果组件未绑定到窗口，则此方法返回其在 LayoutConfig 中记录的高度。

返回:

返回组件的高度，以像素为单位。

getLeft

public int getLeft()

获取组件相对于父布局的左边缘位置。

该值是实际布局的左边缘位置。 它与组件显示区域的左边缘不同。

返回:

返回左边缘的相对位置，以像素为单位。

setLeft

public void setLeft(int left)

设置组件相对于父容器的左边缘位置。

此方法只能由布局系统使用。 我们一般不能使用它，因为属性值可以随时被父容器改变。

参数：

参数名称	参数描述
left	表示左边缘的相对位置，以像素为单位。

getRight

public int getRight()

获取组件相对于父布局的右边缘位置。

该值是实际布局的右边缘位置。 它与组件显示区域的右边缘不同。

返回:

返回右边缘的相对位置，以像素为单位。

setRight

public void setRight(int right)

设置组件相对于父容器的右边缘位置。

此方法只能由布局系统使用。 我们一般不能使用它，因为属性值可以随时被父容器改变。

参数：

参数名称	参数描述
right	指示右边缘的相对位置，以像素为单位。

getTop

public int getTop()

获取组件相对于父布局的上边缘位置。

该值是实际布局的上边缘位置。 它与组件显示区域的顶部边缘不同。

返回:

返回顶部边缘的相对位置，以像素为单位。

setTop

public void setTop(int top)

设置组件相对于父容器的顶部边缘位置。

此方法只能由布局系统使用。 我们一般不能使用它，因为父容器可以随时更改属性值。

参数：

参数名称	参数描述
top	表示上边缘的相对位置，以像素为单位。

getBottom

public int getBottom()

获取组件相对于父布局的底部边缘位置。

该值是实际布局的底部边缘位置。 它与组件显示区域的底部边缘不同。

返回:

返回底部边缘的相对位置，以像素为单位。

setBottom

public void setBottom(int bottom)

设置组件相对于父容器的底部边缘位置。

此方法只能由布局系统使用。 我们一般不能使用它，因为属性值可以随时被父容器改变。

参数：

参数名称	参数描述
bottom	指示底部边缘的相对位置，以像素为单位。

setComponentPosition

public void setComponentPosition(int left, int top, int right, int bottom)

设置组件相对于父容器的位置。

此方法只能由布局系统使用。 我们一般不能使用它，因为父容器可以随时更改属性值。

参数：

参数名称	参数描述
left	指示组件左边缘的位置，以像素为单位。
top	指示组件顶部边缘的位置，以像素为单位。
right	指示组件右边缘的位置，以像素为单位。
bottom	指示组件底部边缘的位置，以像素为单位。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果宽度（右 - 左）或高度（下 - 上）值小于 0，则抛出此异常。

setComponentPosition

public void setComponentPosition(Rect rect)

根据 rect 设置组件相对于父容器的位置。

此方法只能由布局系统使用。 我们一般不能使用它，因为父容器可以随时更改属性值。

参数：

参数名称	参数描述
rect	表示要设置的位置。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果宽度（右 - 左）或高度（下 - 上）值小于 0 或 rect 参数值为空，则引发此异常。

setHorizontalPosition

public void setHorizontalPosition(int left, int right)

设置组件相对于父容器的水平位置。

此方法只能由布局系统使用。 我们一般不能使用它，因为属性值可以随时被父容器改变。

参数：

参数名称	参数描述
left	指示组件左边缘的位置，以像素为单位。
right	指示组件右边缘的位置，以像素为单位。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果宽度（右 - 左）值小于 0，则抛出此异常。

setVerticalPosition

public void setVerticalPosition(int top, int bottom)

设置组件相对于父容器的垂直位置。

此方法只能由布局系统使用。 我们一般不能使用它，因为属性值可以随时被父容器改变。

参数：

参数名称	参数描述
top	指示组件顶部边缘的位置，以像素为单位。
bottom	指示组件底部边缘的位置，以像素为单位。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果高度（底部 - 顶部）值小于 0，则引发此异常。

getHorizontalPosition

public int[] getHorizontalPosition()

获取组件相对于父布局的水平位置。

返回:

返回按顺序排列的左右边缘数组，以像素为单位。

getVerticalPosition

public int[] getVerticalPosition()

获取组件相对于父布局的位置。

返回:

以像素为单位按顺序返回顶部和底部边缘的数组。

getComponentPosition

public Rect getComponentPosition()

获取组件相对于父布局的位置。

返回:

返回一个表示组件位置的 Rect，以像素为单位。

setMarginLeft

public void setMarginLeft(int left)

设置此组件的左边距。

参数：

参数名称	参数描述
left	指示要设置的左边距，以像素为单位。

setMarginTop

public void setMarginTop(int top)

设置此组件的上边距。

参数：

参数名称	参数描述
top	指示要设置的上边距，以像素为单位。

setMarginRight

public void setMarginRight(int right)

设置此组件的右边距。

参数：

参数名称	参数描述
right	指示要设置的右边距，以像素为单位。

setMarginBottom

public void setMarginBottom(int bottom)

设置此组件的下边距。

参数：

参数名称	参数描述
bottom	指示要设置的下边距，以像素为单位。

setMarginsLeftAndRight

public void setMarginsLeftAndRight(int left, int right)

设置此组件的水平边距。

参数：

参数名称	参数描述
left	指示要设置的左边距，以像素为单位。
right	指示要设置的右边距，以像素为单位。

setMarginsTopAndBottom

public void setMarginsTopAndBottom(int top, int bottom)

设置此组件的垂直边距。

参数：

参数名称	参数描述
top	指示要设置的上边距，以像素为单位。
bottom	指示要设置的下边距，以像素为单位。

getMarginLeft

public int getMarginLeft()

获取该组件的左边距。

返回:

返回左边距，以像素为单位。

getMarginTop

public int getMarginTop()

获取该组件的上边距。

返回:

返回上边距，以像素为单位。

getMarginRight

public int getMarginRight()

获取该组件的右边距。

返回:

返回右边距，以像素为单位。

getMarginBottom

public int getMarginBottom()

获取该组件的下边距。

返回:

返回下边距，以像素为单位。

getMargins

public int[] getMargins()

获取此组件的左、上、右和下边距。

返回:

返回按顺序排列的左、上、右和下边距的数组，以像素为单位。

getMarginsLeftAndRight

public int[] getMarginsLeftAndRight()

获取该组件的水平边距。

返回:

以像素为单位按顺序返回左右边距的数组。

getMarginsTopAndBottom

public int[] getMarginsTopAndBottom()

获取该组件的垂直边距。

返回:

以像素为单位按顺序返回顶部和底部边距的数组。

setForegroundGravity

@Deprecated public void setForegroundGravity(int foregroundGravity)

已弃用。 此更改从 API 版本 6 开始生效。此方法是多余的，因此已弃用。

设置前景位置。

参数：

参数名称	参数描述
foregroundGravity	表示组件的前景位置。

getForegroundGravity

@Deprecated public int getForegroundGravity()

已弃用。 此更改从 API 版本 6 开始生效。此方法是多余的，因此已弃用。

获取前景位置。

返回:

返回组件的前景位置。

setLayoutConfig

public void setLayoutConfig(ComponentContainer.LayoutConfig config)

设置组件在其父布局中的布局参数。

传入的布局参数的子类因父布局的子类而异。 将包含当前组件的组件树添加到窗口后，系统根据 ComponentContainer.LayoutConfig 参数和组件类型计算组件在父布局中的位置、宽度和高度。 支持以下布局参数的子类：

• StackLayout.LayoutConfig
• DirectionalLayout.LayoutConfig
• DependentLayout.LayoutConfig
• TableLayout.LayoutConfig
• ComponentContainer.LayoutConfig

参数:

参数名称	参数描述
config	表示组件的布局参数。 这些参数不能为空。

getLayoutConfig

public ComponentContainer.LayoutConfig getLayoutConfig()

获取与组件关联的布局参数。

所有组件都应该有布局参数。 它们为组件的父布局提供参数，指定组件的排列方式。 ComponentContainer.LayoutConfig 的子类有很多，对应不同的 ComponentContainer 子类，负责排列子类。 如果组件没有绑定到父ComponentContainer或者调用绑定到父ComponentContainer的组件时发生异常，该方法一定不能返回null。

返回:

返回与组件关联的布局参数； 如果组件未绑定到父 ComponentContainer 或调用时发生异常，则返回 null

setMinHeight

public void setMinHeight(int minHeight)

设置组件的最小高度。

不能保证组件能够达到这个最小高度，例如，如果父布局不支持这个最小高度。

参数：

参数名称	参数描述
minHeight	指示组件的最小可能高度，以像素为单位。

getMinHeight

public int getMinHeight()

获取组件的最小可能高度。

组件可能无法达到此最小高度。

返回:

返回组件的最小高度，以像素为单位。

setMinWidth

public void setMinWidth(int minWidth)

设置组件的最小可能宽度。

不能保证组件能够达到这个最小宽度，例如，如果父布局不支持这个最小宽度。

参数：

参数名称	参数描述
minWidth	指示组件的最小可能宽度，以像素为单位。

getMinWidth

public int getMinWidth()

获取组件的最小可能宽度。

组件可能无法达到此最小宽度。

返回:

返回组件的最小可能宽度，以像素为单位。

setComponentMinSize

public void setComponentMinSize(int minWidth, int minHeight)

设置此组件的最小可能宽度和高度。

参数：

参数名称	参数描述
minWidth	指示要设置的最小可能宽度，以像素为单位。
minHeight	指示要设置的最小可能高度，以像素为单位。

getComponentMinSize

public DimensFloat getComponentMinSize()

获取此组件的可能最小大小。

返回:

返回表示可能的最小大小的 DimensFloat 对象，以像素为单位。

getScrollValue

public int getScrollValue(int direction)

获取该组件的滚动偏移量。

参数：

参数名称	参数描述
direction	指示方向，x 轴或 y 轴。 AXIS_X的值表示要获取x轴的滚动偏移量，AXIS_Y表示要获取y轴的滚动偏移量。

返回:

返回滚动偏移量，以像素为单位。

setVisibility

public void setVisibility(int visibility)

设置组件的可见性。

当参数值为VISIBLE时，组件占用空间，需要渲染。 当参数值为INVISIBLE时，组件占用空间但不需要渲染。 当参数值为HIDE时，组件不占用空间，不需要渲染。

参数：

参数名称	参数描述
visibility	该值为以下之一：可见、不可见或隐藏。

getVisibility

public int getVisibility()

获取组件的可见性。

一个组件可以具有三种可见性状态：

• VISIBLE：组件占用空间，需要渲染。
• INVISIBLE：组件占用空间但不需要渲染。
• HIDE：组件不占用空间，不需要渲染。

返回:

返回组件的可见性状态。 该值可以是以下之一：可见、不可见或隐藏。

release

public void release()

释放资源。

announceAccessibility

public void announceAccessibility(String text)

为 TYPE_ANNOUNCEMENT 类型的可访问性事件设置文本。

参数：

参数名称	参数描述
text	指示要设置的文本。

setAccessibilityDescription

public void setAccessibilityDescription(String description)

设置此组件的可访问性模式的描述。

参数：

参数名称	参数描述
description	指示要设置的可访问性描述。

getAccessibilityDescription

public String getAccessibilityDescription()

获取该组件的可访问性描述。

返回:

返回此组件的可访问性描述。

notifyAccessibility

public void notifyAccessibility(int eventType)

触发此组件指定的可访问性事件。

参数：

参数名称	参数描述
eventType	指示要触发的可访问性事件。 该值可以是以下任意值：0x00000001：单击按钮等组件。0x00000002：长按组件。0x00000004：选择组件。0x00000008：组件处于焦点。0x00000010：更改文本。 0x00000020：窗口内容被改变。0x00001000：组件停止滚动。0x00004000：组件内容被读取。0x00008000：获得辅助功能焦点。0x00010000：辅助功能焦点被清除。0x01000000：组件开始滚动。

setAccessibility

public void setAccessibility(int flag)

设置可访问性状态。

参数：

参数名称	参数描述
flag	指示要设置的可访问性状态，可以是 ACCESSIBILITY_DISABLE、ACCESSIBILITY_AUTO 或 ACCESSIBILITY_ENABLE。

getAccessibility

public int getAccessibility()

获取可访问性状态。

返回:

返回可访问性状态。

isBoundToWindow

public boolean isBoundToWindow()

检查组件是否已绑定到窗口。

每个窗口都会创建一个组件树。 每个需要在窗口中显示的组件都必须绑定到这棵树上。在组件树中添加一个组件，就相当于将一个组件绑定到一个窗口上。

返回:

如果组件已绑定到窗口，则返回 true； 否则返回 false。

isComponentDisplayed

public boolean isComponentDisplayed()

检查组件是否可以显示。

这与组件的可见性不同。 例如，对于可见性状态为 VISIBLE 的组件，如果其大小为 0 或无法显示其父布局，则该组件仍然无法显示在屏幕上。 相反，即使对于完全透明的组件，如果组件可以通过更改其透明度颜色在屏幕上显示，则此方法返回 true。

返回:

如果组件可以显示，则返回 true； 否则返回 false。

setComponentStateChangedListener

public void setComponentStateChangedListener(Component.ComponentStateChangedListener listener)

设置组件状态更改事件的侦听器。

参数：

参数名称	参数描述
listener	表示组件状态变化事件的监听器。

getComponentStateChangedListener

public Component.ComponentStateChangedListener getComponentStateChangedListener()

获取监听该组件状态变化的监听器。

返回:

返回监听器。

setClickedListener

public void setClickedListener(Component.ClickedListener listener)

为组件中的点击事件注册一个监听器。

当点击的位置在组件的显示区域内时，触发点击事件，并通知所有注册的观察者。

参数：

参数名称	参数描述
listener	指示单击事件的侦听器。

getClickedListener

public Component.ClickedListener getClickedListener()

获取监听该组件点击事件的监听器。

返回:

返回监听器。

setEditEventListener

public void setEditEventListener(Component.EditEventListener listener)

注册一个侦听器以观察由键盘快捷键触发并分发到此组件的编辑事件。

参数：

参数名称	参数描述
listener	指示要注册的侦听器。

getEditEventListener

public Component.EditEventListener getEditEventListener()

获取监听由键盘快捷键触发并分发给该组件的编辑事件的监听器。

返回:

返回监听器。

setDoubleClickedListener

public void setDoubleClickedListener(Component.DoubleClickedListener listener)

注册监听该组件的双击事件。

当该组件的显示区域发生双击事件时，调用该方法并通知所有注册的观察者。

参数：

参数名称	参数描述
listener	指示要注册的侦听器。

setScaledListener

public void setScaledListener(Component.ScaledListener listener)

为组件的缩放事件注册一个监听器。

所有注册的观察者都将收到发送到该组件的缩放事件的通知。

参数：

参数名称	参数描述
listener	表示比例监听器。

getScaledListener

public Component.ScaledListener getScaledListener()

获取监听该组件缩放事件的监听器。

返回:

返回监听器。

setGesturePriority

public void setGesturePriority(Component.GestureType gestureType, int priority)

设置手势的优先级。

参数：

参数名称	参数描述
gestureType	手势类型 GestureType。
priority	手势的优先级。 值越大表示优先级越高，默认优先级为 0。

getGesturePriority

public int getGesturePriority(Component.GestureType gestureType)

获取手势的优先级。

参数：

参数名称	参数描述
gestureType	手势类型 GestureType。

返回:

返回手势的优先级。

setOnDragListener

public void setOnDragListener(Component.OnDragListener listener)

为组件中的拖动事件注册一个监听器。

当拖动动作的位置在组件的显示区域内时，触发拖动事件，并通知所有注册的观察者。

参数：

参数名称	参数描述
listener	指示拖动事件的侦听器。

setDraggedListener

public void setDraggedListener(int dragMode, Component.DraggedListener listener)

为组件的拖动事件注册一个监听器。

所有注册的观察者都将收到发送到该组件的拖动事件的通知。 如果 listener 为 null，则拖动事件将被取消。 一个组件可以拥有多个相同的拖动识别器，并且用户定义的拖动识别器优先于内部拖动识别器。

参数：

参数名称	参数描述
dragMode	指示当前的拖动模式。 该值可以是以下之一：DRAG_HORIZONTAL_VERTICAL、DRAG_HORIZONTAL、DRAG_VERTICAL
listener	指示拖动事件的侦听器。

getDraggedListener

public Component.DraggedListener getDraggedListener()

获取监听该组件拖动事件的监听器。

返回:

返回监听器。

setDragAcceptAngle

public void setDragAcceptAngle(float degree)

设置水平或垂直拖动识别器的偏转角度。

偏转角是指拖动方向与主方向之间的夹角，对于水平拖动识别器来说是水平的，对于垂直拖动识别器来说是垂直的。如果投影到主方向的触摸屏上的拖动位移超过预设阈值（8 vp）但小于阈值的两倍，则拖动识别器计算偏角并假设仅当计算的角度小于1时才开始拖动你通过这个方法设置。如果拖动位移超过阈值的两倍，则拖动识别器假定拖动开始，而不管您设置的偏转角度如何。此方法仅对通过 setDraggedListener(int, ohos.agp.components.Component.DraggedListener) 将 dragMode 设置为 DRAG_HORIZONTAL 或 DRAG_VERTICAL 的拖动识别器生效。默认偏角为 26.57 度。

参数：

参数名称	参数描述
degree	表示要设置的偏转角。 取值范围为 15.0 到 75.0 度。

getDragAcceptAngle

public float getDragAcceptAngle()

获取为水平或垂直拖动识别器设置的偏转角。

返回:

返回偏转角度，以度为单位。

onDrag

public boolean onDrag(Component component, DragEvent event)

在将拖动事件分派到组件时调用。

参数：

参数名称	参数描述
component	表示组件。
event	表示拖动事件。

返回:

如果正确处理了拖动事件，则返回 true； 否则返回 false。

setFocusChangedListener

public void setFocusChangedListener(Component.FocusChangedListener listener)

为组件中的焦点更改事件注册一个侦听器。

所有注册的观察者都将收到分派给组件的焦点更改事件的通知。

参数：

参数名称	参数描述
listener	指示焦点更改事件的侦听器。

setKeyEventListener

public void setKeyEventListener(Component.KeyEventListener listener)

为组件中的关键事件注册一个监听器。

所有注册的观察者都将收到派发给组件的关键事件的通知。

参数：

参数名称	参数描述
listener	表示按键事件的监听器。

setUnconsumedKeyEventListener

public void setUnconsumedKeyEventListener(Component.UnconsumedKeyEventListener listener)

为组件中未使用的键事件注册一个侦听器。

所有注册的观察者都将收到未使用的关键事件的通知。

参数：

参数名称	参数描述
listener	表示按键事件的监听器。

setMouseEventListener

public void setMouseEventListener(Component.MouseEventListener listener)

为组件中的鼠标事件注册一个监听器。

所有注册的观察者都将收到发送到组件的鼠标事件的通知。

参数：

参数名称	参数描述
listener	指示鼠标事件的侦听器。

getMouseEventListener

public Component.MouseEventListener getMouseEventListener()

获取监听该组件鼠标事件的监听器。

返回:

返回监听器。

setForwardHoverListener

public void setForwardHoverListener(Component.ForwardHoverListener listener)

注册一个监听器来决定将鼠标悬停事件转发给子组件。

参数：

参数名称	参数描述
listener	指示侦听器转发鼠标悬停事件。

getForwardHoverListener

public Component.ForwardHoverListener getForwardHoverListener()

获取该组件向前鼠标悬停事件的监听器。

返回:

返回监听器。

setHoverEventListener

public void setHoverEventListener(Component.HoverEventListener listener)

为组件中的悬停事件注册一个侦听器。

所有注册的观察者都将收到发送到组件的悬停事件的通知。

参数：

参数名称	参数描述
listener	指示悬停事件的侦听器。

getHoverEventListener

public Component.HoverEventListener getHoverEventListener()

获取监听该组件悬停事件的监听器。

返回:

返回监听器。

setMousePointerStyleListener

public void setMousePointerStyleListener(Component.MousePointerStyleListener listener)

注册鼠标指针样式更改的侦听器。

参数：

参数名称	参数描述
listener	指示要注册的侦听器。

getMousePointerStyleListener

public Component.MousePointerStyleListener getMousePointerStyleListener()

获取鼠标指针样式更改的侦听器。

返回:

返回一个监听器。

getKeyEventListener

public Component.KeyEventListener getKeyEventListener()

获取监听该组件关键事件的监听器。

返回:

返回监听器。

setRotationEventListener

public void setRotationEventListener(Component.RotationEventListener listener)

为组件中的旋转事件注册一个监听器。

所有注册的观察者都将收到发送到组件的旋转事件的通知。

参数：

参数名称	参数描述
listener	指示旋转事件的侦听器。

getRotationEventListener

public Component.RotationEventListener getRotationEventListener()

获取监听该组件旋转事件的监听器。

返回:

返回监听器。

setLongClickedListener

public void setLongClickedListener(Component.LongClickedListener listener)

为组件中的长按事件注册一个监听器（组件被单击并按住）。

所有注册的观察者都会收到发送到组件的长点击事件通知。

参数：

参数名称	参数描述
listener	指示长按事件的侦听器。

setTouchEventListener

public void setTouchEventListener(Component.TouchEventListener listener)

为组件中的触摸事件注册一个监听器。

所有注册的观察者都将收到发送到组件的触摸事件的通知。

参数：

参数名称	参数描述
listener	指示触摸事件的侦听器。

setForwardTouchListener

public void setForwardTouchListener(Component.ForwardTouchListener listener)

注册一个监听器来决定子组件的前向触摸事件。

参数：

参数名称	参数描述
listener	指示侦听器转发触摸事件。

getForwardTouchListener

public Component.ForwardTouchListener getForwardTouchListener()

获取该组件前向触摸事件的监听器。

返回:

返回监听器。

getTouchEventListener

public Component.TouchEventListener getTouchEventListener()

获取监听该组件触摸事件的监听器。

返回:

返回监听器。

requestForceForwardTouchEvent

public void requestForceForwardTouchEvent(boolean forceForward)

当组件希望此父级及其祖先继续转发触摸事件时调用。 该请求将生效，直到接收到下一个主点为止。

参数：

参数名称	参数描述
forceForward	如果子级希望父级继续转发触摸事件，则为真，否则为假

setLayoutRefreshedListener

public void setLayoutRefreshedListener(Component.LayoutRefreshedListener listener)

为组件的重新布局注册一个监听器。

参数：

参数名称	参数描述
listener	指示组件重新布局的侦听器。

getLayoutRefreshedListener

public Component.LayoutRefreshedListener getLayoutRefreshedListener()

获取监听该组件布局刷新的监听器。

返回:

返回监听器。

setContourRefreshedListener

public void setContourRefreshedListener(Component.ContourRefreshedListener listener)

注册一个侦听器以获取组件的 Contour 对象的更新。

参数：

参数名称	参数描述
listener	指示轮廓更新的侦听器。

getContourRefreshedListener

public Component.ContourRefreshedListener getContourRefreshedListener()

获取对组件的 Contour 对象进行更新的侦听器。

返回:

如果获得，则返回轮廓更新的侦听器； 否则返回 null。

setContour

public void setContour(Contour contour)

为组件设置自定义轮廓对象。

参数：

参数名称	参数描述
contour	表示自定义轮廓对象。

getContour

public Contour getContour()

获取当前组件的 Contour 对象。

返回:

返回当前组件的 Contour 对象。

setClipToContourEnabled

public void setClipToContourEnabled(boolean enable)

设置组件的 Contour 对象是否可用于内容裁剪。 仅当 Contour 对象采用直角矩形、圆角矩形或圆形形式时，才支持剪裁。 超出轮廓对象的部分将被裁剪。

参数：

参数名称	参数描述
enable	指示是否支持剪辑。 值为 true 表示支持裁剪； 值 false 表示相反。

isClipToContourEnabled

public boolean isClipToContourEnabled()

检查组件的 Contour 对象是否可用于内容剪辑。

返回:

如果 Contour 对象可用于内容剪辑，则返回 true； 否则返回 false。

refreshContour

public void refreshContour()

刷新组件的当前 Contour 对象并触发 ContourRefreshedListener#onContourRefreshed(Component) 用于设置自定义 Contour 对象。 如果要主动更新组件的 Contour 对象，请使用此方法。

setScrolledListener

public void setScrolledListener(Component.ScrolledListener listener)

为组件中的滚动事件注册一个监听器。

所有注册的观察者都将收到分派给组件的滚动事件的通知。

参数：

参数名称	参数描述
listener	指示滚动事件的侦听器。

addScrolledListener

public void addScrolledListener(Component.ScrolledListener listener)

添加一个监听器来监听组件的滚动阶段或位置发生变化时报告的滚动事件。

当组件报告滚动事件时，注册的侦听器将收到通知。

参数：

参数名称	参数描述
listener	指示滚动事件的侦听器。

removeScrolledListener

public void removeScrolledListener(Component.ScrolledListener listener)

删除一个监听滚动事件的监听器。

参数：

参数名称	参数描述
listener	指示滚动事件的侦听器。

canScroll

public boolean canScroll(int orientation)

检查组件是否可以按指定方向滚动。

参数：

参数名称	参数描述
orientation	指示拖动方向。 该值可以是 DRAG_UP、DRAG_DOWN、DRAG_LEFT 或 DRAG_RIGHT。

返回:

如果组件可以在指定方向滚动，则返回 true； 否则返回 false。

getScrollState

public int getScrollState()

获取组件滚动状态。

返回:

滚动状态。

setCanAcceptScrollListener

public void setCanAcceptScrollListener(Component.CanAcceptScrollListener listener)

simulateClick

public boolean simulateClick()

在组件中执行单击事件。

此方法调用为组件创建的 OnClickListener。 通过 setClickedListener(ohos.agp.components.Component.ClickedListener) 方法注册的观察者会收到通知。 回调执行后，系统会向点击事件监听器传递一个提升事件。

返回:

如果回调函数执行成功，则返回 true。

performScale

public boolean performScale()

在组件中执行缩放事件。

此方法为控件的缩放事件调用回调。 通过 setScaledListener(ohos.agp.components.Component.ScaledListener) 方法注册的观察者会收到通知。 当回调被执行时，系统会将缩放事件传递给缩放监听器。

返回:

如果回调函数执行成功，则返回 true。

simulateDrag

public boolean simulateDrag()

执行组件的拖动事件。

该方法调用控件拖动事件的回调。 通过 setDraggedListener(int,ohos.agp.components.Component.DraggedListener) 方法注册的观察者会收到通知。 当回调被执行时，系统会将拖动事件传递给拖动监听器。

返回:

如果回调函数执行成功，则返回 true。

callOnClick

public boolean callOnClick()

调用分配的 OnClickListener。

与simulateClick()不同的是，该方法只通知使用setClickedListener(ohos.agp.components.Component.ClickedListener)方法注册的观察者，而不会对组件本身进行任何实际操作。

返回:

如果分配的 OnClickListener 被成功调用，则返回 true。

executeLongClick

public boolean executeLongClick()

在组件中执行长按事件。

此方法调用为组件创建的 OnLongClickListener。 通过 setLongClickedListener(ohos.agp.components.Component.LongClickedListener) 方法注册的观察者会收到通知。 回调执行后，系统会向长按事件监听器传递一个提升事件。

返回:

如果回调函数执行成功，则返回 true。

executeDoubleClick

public boolean executeDoubleClick()

执行此组件中发生的双击事件。

此方法调用为此组件创建的 OnDoubleClickListener。 通过 setDoubleClickedListener(ohos.agp.components.Component.DoubleClickedListener) 方法注册的观察者会收到通知。 调用回调后，系统会向 setDoubleClickedListener(ohos.agp.components.Component.DoubleClickedListener) 设置的监听器传递一个双击事件结束的事件。

返回:

如果操作成功，则返回 true； 否则返回 false。

setClickable

public void setClickable(boolean clickable)

启用或禁用组件的点击事件。

如果一个组件是可点击的，它的状态将在每次点击时变为已按下。 子类应将组件设置为可点击，以直观地对用户点击做出反应。 如果一个组件不可点击，它应该不能获得焦点。 如果它已经获得焦点，则应立即清除焦点。

参数：

参数名称	参数描述
clickable	true 表示使组件可点击，false 表示相反。

isClickable

public boolean isClickable()

返回组件是否响应点击事件。

如果一个组件不可点击，它就无法获得焦点。

返回:

如果组件是可点击的，则返回 true； 如果不是，则返回 false。

setEnabled

public void setEnabled(boolean enabled)

设置组件的启用状态。

启用状态的解释因子类而异。 如果未启用组件，则不应获得焦点。

参数：

参数名称	参数描述
enabled	true 表示启用组件，false 表示相反。

setClipEnabled

public void setClipEnabled(boolean enabled)

设置是否允许在组件超出其父布局时自动裁剪。

参数：

参数名称	参数描述
enabled	true 表示允许自动剪辑，false 表示相反。

getClipEnabled

public boolean getClipEnabled()

检查此组件超出其父布局时是否启用自动剪裁。

返回:

如果启用了自动剪辑，则返回 true； 否则返回 false。

isEnabled

public boolean isEnabled()

获取组件的启用状态。 默认状态为启用。

返回:

如果启用了组件，则返回 true； 如果不是，则返回 false。

setFocusable

public void setFocusable(int focusable)

设置组件是否可以接收焦点。

FOCUS_ENABLE 值表示组件可以接收焦点。 FOCUS_ADAPTABLE 值的意思是让框架根据组件的交互性来判断组件是否可以接收焦点。 这是默认值。 FOCUS_DISABLE 值确保组件在触摸模式下也不可聚焦。 每个组件使用一个状态位来指示它是否是可聚焦的。 如果组件不可点击，则无法更改此状态位以指示可聚焦。

参数：

参数名称	参数描述
focusable	指示组件是否可以获得焦点。 该值可以是 FOCUS_DISABLE、FOCUS_ENABLE 或 FOCUS_ADAPTABLE。

showFocusBorder

@Deprecated public void showFocusBorder()

已弃用。 此更改自 API 版本 8 起生效。此方法是多余且临时的，因此已弃用。

显示焦点边框。

hideFocusBorder

@Deprecated public void hideFocusBorder()

已弃用。 此更改自 API 版本 8 起生效。此方法是多余且临时的，因此已弃用。

隐藏焦点边框。

setTouchFocusable

public void setTouchFocusable(boolean focusable)

设置组件在触摸模式下是否可以接收焦点。

将此设置为 true 还将确保组件可聚焦。

参数：

参数名称	参数描述
focusable	指示组件是否可以接收焦点。

getFocusable

public int getFocusable()

获取组件的可聚焦设置。

返回值与 setFocusable(int) 方法设置的值相同。

返回:

返回组件的可聚焦设置。 该值可以是以下任意值：FOCUS_DISABLE、FOCUS_ENABLE 或 FOCUS_ADAPTABLE。

setId

public void setId(int id)

设置组件的唯一 ID。

组件 ID 通常为非负值，默认设置为 -1。

参数：

参数名称	参数描述
id	指示要设置的组件 ID。

getId

public int getId()

获取组件的唯一标识。

默认值为 -1。

返回:

返回组件 ID。

setName

public void setName(String name)

设置组件的名称。

组件名称通常是一个字符串，默认设置为空。

参数：

参数名称	参数描述
name	指示要设置的组件名称。

getName

public String getName()

获取组件的名称。

默认名称为空。

返回:

返回组件名称。

setLongClickable

public void setLongClickable(boolean longClickable)

设置组件是否可长按。

可长按组件对长按事件做出反应，即用户按住按钮的时间比点击的时间长。

参数：

参数名称	参数描述
longClickable	指示组件是否可长时间点击。

isLongClickOn

public boolean isLongClickOn()

返回组件是否可长时间点击。

可长按组件对长按事件做出反应，即用户按住按钮的时间比点击的时间长。

返回:

如果组件是长可点击的，则返回 true； 否则返回 false。

playSound

public void playSound(int soundId)

播放此组件的声音。

参数：

参数名称	参数描述
soundId	指示要播放的声音类型，可以是 0 代表 SOUND_CLICK，1 代表 SOUND_UP，2 代表 SOUND_DOWN，3 代表 SOUND_LEFT，4 代表 SOUND_RIGHT。

setSoundEnable

public void setSoundEnable(boolean enable)

单击此组件时启用或禁用该组件的声音。

参数：

参数名称	参数描述
enable	指定是否为组件启用声音。 值 true 表示启用声音，false 表示相反。

isSoundEnable

public boolean isSoundEnable()

检查单击此组件时是否播放声音。

返回:

如果播放声音，则返回 true； 否则返回 false。

setPadding

public void setPadding(int left, int top, int right, int bottom)

设置组件的填充。

组件在绘制自身之前为所有四种尺寸上的填充保留空间。

参数：

参数名称	参数描述
left	以像素为单位指示左侧填充。
top	以像素为单位指示顶部填充。
right	以像素为单位指示正确的填充。
bottom	以像素为单位指示底部填充。

setPaddingRelative

public void setPaddingRelative(int start, int top, int end, int bottom)

设置组件的相对填充。

目前与setPadding(int,int,int,int)相同。

参数：

参数名称	参数描述
start	以像素为单位指示开始填充。
top	以像素为单位指示顶部填充。
end	以像素为单位指示结束填充。
bottom	以像素为单位指示底部填充。

getPaddingBottom

public int getPaddingBottom()

获取组件的底部填充。

返回:

返回组件的底部填充。

getPaddingEnd

public int getPaddingEnd()

根据解析的布局方向获取组件的结束填充。

返回:

返回组件的结束填充（以像素为单位）。

getPaddingLeft

public int getPaddingLeft()

获取组件的左内边距。

返回:

返回组件的左侧填充（以像素为单位）。

getPaddingRight

public int getPaddingRight()

获取组件的正确填充。

返回:

返回组件的右填充（以像素为单位）。

getPaddingStart

public int getPaddingStart()

根据解析的布局方向获取组件的开始填充。

返回:

返回组件的起始填充（以像素为单位）。

getPaddingTop

public int getPaddingTop()

获取组件的顶部填充。

返回:

返回组件的顶部填充，以像素为单位。

setPaddingTop

public void setPaddingTop(int top)

设置此组件的顶部填充。

参数：

参数名称	参数描述
top	指示要设置的顶部填充，以像素为单位。

setPaddingBottom

public void setPaddingBottom(int bottom)

设置此组件的底部填充。

参数：

参数名称	参数描述
bottom	指示要设置的底部填充，以像素为单位。

setPaddingLeft

public void setPaddingLeft(int left)

设置此组件的左侧填充。

参数：

参数名称	参数描述
left	指示要设置的左侧填充，以像素为单位。

setPaddingRight

public void setPaddingRight(int right)

为此组件设置正确的填充。

参数：

参数名称	参数描述
right	指示要设置的正确填充，以像素为单位。

setHorizontalPadding

public void setHorizontalPadding(int left, int right)

设置此组件的水平填充。

参数：

参数名称	参数描述
left	指示要设置的左侧填充，以像素为单位。
right	指示要设置的正确填充，以像素为单位。

setVerticalPadding

public void setVerticalPadding(int top, int bottom)

设置此组件的垂直填充。

参数：

参数名称	参数描述
top	指示要设置的顶部填充，以像素为单位。
bottom	指示要设置的底部填充，以像素为单位。

getPadding

public int[] getPadding()

获取该组件的内边距。

返回:

返回按顺序排列的左、上、右和下边距的数组，以像素为单位。

getHorizontalPadding

public int[] getHorizontalPadding()

获取此组件的水平填充。

返回:

以像素为单位，按顺序返回左右填充的数组。

getVerticalPadding

public int[] getVerticalPadding()

获取此组件的垂直填充。

返回:

按顺序返回顶部和底部填充的数组，以像素为单位。

setPressState

public void setPressState(boolean pressState)

设置组件的按下状态。

如果已为此类状态设置了不同的外观，则调用此方法可能会更改组件的外观。

参数：

参数名称	参数描述
pressState	表示按下状态。 true 表示将组件的内部状态设置为已按下。

isPressed

public boolean isPressed()

返回组件当前是否处于按下状态。

如果未调用 setPressState(boolean) 函数，则只有可点击组件才能进入按下状态。

返回:

如果组件处于按下状态，则返回 true； 否则返回 false。

setSelected

public void setSelected(boolean selected)

设置组件的选择状态。

可以选择或取消选择组件。 请注意，被选中与焦点不同。 组件通常在像 ListContainer 这样的 AdapterComponent 的上下文中选择； 选定的组件被突出显示。

参数：

参数名称	参数描述
selected	表示组件的选中状态。 true 表示组件被选中。

isSelected

public boolean isSelected()

获取组件的选择状态。

返回:

如果选择了组件，则返回 true； 否则返回 false。

hasFocus

public boolean hasFocus()

返回组件是否有焦点。

返回:

如果组件或其父组件具有焦点，则返回 true； 否则返回 false。

isFocusable

public boolean isFocusable()

返回组件当前是否可以接收焦点。

返回:

如果组件可以接收焦点，则返回 true； 否则返回 false。

isTouchFocusable

public boolean isTouchFocusable()

返回组件是否可以在触摸模式下接收焦点。

返回:

如果组件可以在触摸模式下获得焦点，则返回 true； 否则返回 false。

isFocused

public boolean isFocused()

返回组件是否已获得焦点。

返回:

如果组件有焦点，则返回 true； 否则返回 false。

requestFocus

public boolean requestFocus()

请求当前组件或其子组件之一的焦点。

在以下任何一种情况下，组件将无法真正获得焦点：组件不可聚焦（isFocusable() 返回 false）； 或者组件在触摸模式下不可聚焦（isTouchFocusable() 返回 false）； 或组件不可见、已禁用或未获得绘图空间。

返回:

如果组件或其子组件之一已获得焦点，则返回 true； 否则返回 false。

clearFocus

public void clearFocus()

请求放弃焦点。

postLayout

public void postLayout()

请求重新排列组件的布局。

arrange

public void arrange(int left, int top, int width, int height)

相对于父布局定位组件。

参数：

参数名称	参数描述
left	表示左边缘的相对位置，以像素为单位。
top	表示上边缘的相对位置，以像素为单位。
width	表示组件宽度，以像素为单位。
height	表示组件高度，以像素为单位。

estimateSize

public void estimateSize(int widthEstimatedConfig, int heightEstimatedConfig)

设置组件的宽度和高度尺寸和要求

参数：

参数名称	参数描述
widthEstimatedConfig	横向尺寸要求
heightEstimatedConfig	垂直尺寸要求

setEstimatedSize

protected final void setEstimatedSize(int estimatedWidth, int estimatedHeight)

这应该从 EstimateSizeListener#onEstimateSize(int, int) 调用以设置测量的宽度和高度。

参数：

参数名称	参数描述
estimatedWidth	该组件的估计宽度。
estimatedHeight	该组件的估计高度。

getEstimatedWidth

public final int getEstimatedWidth()

返回组件的估计宽度。

返回:

该组件的估计宽度。

getEstimatedHeight

public final int getEstimatedHeight()

返回组件的估计高度。

返回:

该组件的估计高度。

setBindStateChangedListener

public void setBindStateChangedListener(Component.BindStateChangedListener listener)

添加绑定状态更改的侦听器。

要在屏幕上显示组件，您必须将其添加到窗口的组件树中。 每个组件都有一个实现了 BindStateChangedListener 接口的侦听器列表。 当组件绑定到窗口或从窗口解除绑定时，分别回调该接口的 BindStateChangedListener#onComponentBoundToWindow(Component) 和 BindStateChangedListener#onComponentUnboundFromWindow(Component) 方法。 此方法将输入参数指定的侦听器添加到侦听器列表中。

参数：

参数名称	参数描述
listener	指示要添加的侦听器。

removeBindStateChangedListener

public void removeBindStateChangedListener(Component.BindStateChangedListener listener)

删除绑定状态更改的侦听器。

要在屏幕上显示组件，您必须将其添加到窗口的组件树中。 每个组件都有一个实现了 BindStateChangedListener 接口的侦听器列表。 当组件绑定到窗口或从窗口解绑时，分别回调该接口的BindStateChangedListener#onComponentBoundToWindow(Component)(Component)}和BindStateChangedListener#onComponentUnboundFromWindow(Component)方法。 此方法从侦听器列表中删除由输入参数指定的侦听器。

参数：

参数名称	参数描述
listener	指示要删除的侦听器。

bindCornerMark

public CornerMark bindCornerMark()

将角标记对象设置为显示在组件顶部。

返回:

如果已绑定，则返回角标记对象； 否则返回 null。

getCornerMark

public CornerMark getCornerMark()

获取组件的角标对象。

返回:

返回显示在当前组件顶部的角标记对象。

enableCornerMark

public void enableCornerMark(boolean enable)

启用或禁用当前组件的角标记。

参数：

参数名称	参数描述
enable	指定是否显示组件的角标记。 true 表示显示角标记，false 表示相反的情况。

setBackground

public void setBackground(Element element)

将指定元素设置为组件的背景。

参数：

参数名称	参数描述
element	指示要用作背景的元素。

setForeground

public void setForeground(Element element)

将指定元素设置为组件的前景。

参数：

参数名称	参数描述
element	指示用作前景的元素。

setShadowStyle

public void setShadowStyle(Component.ShadowSize size, Component.ShadowMode mode, Component.ShadowDevice device)

将指定元素设置为组件的阴影样式。

参数：

参数名称	参数描述
size	我们将在圆形方形女巫中绘制阴影的大小是阴影。
mode	我们将在圆形方形女巫中绘制阴影的模式是阴影。
device	设备 我们将在圆形方形矩形中绘制阴影的设备是阴影。

getBackgroundElement

public Element getBackgroundElement()

获取组件背景中的元素。

返回:

返回组件背景中的元素。

getForegroundElement

public Element getForegroundElement()

获取组件前景中的元素。

返回:

返回组件前景中的元素。

setFocusBorderEnable

public void setFocusBorderEnable(boolean enabled)

设置当该组件处于焦点时是否启用焦点边框。

参数：

参数名称	参数描述
enabled	指定是否启用焦点边框。 值 true 表示启用焦点边框，值 false（默认值）表示相反的情况。

setFocusBorderWidth

public void setFocusBorderWidth(int width)

设置焦点边框的宽度。

仅当组件处于焦点状态且启用了焦点边框时，才会显示焦点边框。

参数：

参数名称	参数描述
width	表示要设置的宽度，以像素为单位。 任何小于 0 的值都是无效的。

setFocusBorderPadding

public void setFocusBorderPadding(int padding)

设置焦点边框和此组件之间的填充。

仅当组件处于焦点状态且启用了焦点边框时，才会显示焦点边框。

参数：

参数名称	参数描述
padding	指示要设置的填充，以像素为单位。 任何小于 0 的值都是无效的。

setFocusBorderRadius

public void setFocusBorderRadius(float radius)

设置焦点边框的半径。

仅当组件处于焦点状态且启用了焦点边框时，才会显示焦点边框。

参数：

参数名称	参数描述
radius	表示要设置的半径。 该值必须大于 0，此时焦点边框为圆角矩形或圆形。

setFocusBorderRadius

public void setFocusBorderRadius(float[] radii)

设置焦点边框角的半径。

仅当组件处于焦点状态且启用了焦点边框时，才会显示焦点边框。

参数：

参数名称	参数描述
radii	指示包含焦点边框四个角的半径的数组。 该设置仅在数组长度为 8 时有效。每对值分别代表角的 x 轴半径和 y 轴半径。

getFocusBorderEnable

public boolean getFocusBorderEnable()

检查当该组件处于焦点时是否显示焦点边框。

返回:

如果显示焦点边框，则返回 true； 否则返回 false（默认值）。

getFocusBorderWidth

public int getFocusBorderWidth()

获取焦点边框的宽度。

仅当组件处于焦点状态且启用了焦点边框时，才会显示焦点边框。

返回:

返回焦点边框的宽度，以像素为单位。

getFocusBorderPadding

public int getFocusBorderPadding()

获取焦点边框和此组件之间的填充。

仅当组件处于焦点状态且启用了焦点边框时，才会显示焦点边框。

返回:

返回填充，以像素为单位。

getFocusBorderRadius

public float[] getFocusBorderRadius()

获取焦点边界的四个角的半径。

仅当组件处于焦点状态且启用了焦点边框时，才会显示焦点边框。

返回:

返回一个浮点数组，其中包含焦点边框四个角的半径。

setRotation

public void setRotation(float degree)

设置组件绕 Z 轴旋转的度数。

此方法设置组件相对于其父布局绕 Z 轴旋转的度数（值范围：0 到 360）。

参数：

参数名称	参数描述
degree	指示组件绕 Z 轴旋转的度数。

setPivotX

public void setPivotX(float pivotX)

设置组件旋转和缩放所围绕的点的 X 轴坐标，即枢轴点。

参数：

参数名称	参数描述
pivotX	表示枢轴点的 X 轴坐标。

setPivotY

public void setPivotY(float pivotY)

设置组件旋转和缩放所围绕的点，即枢轴点的 Y 轴坐标。

参数：

参数名称	参数描述
pivotY	表示枢轴点的 Y 轴坐标。

setPivot

public void setPivot(float x, float y)

设置枢轴（点），围绕该组件旋转和缩放。

参数：

参数名称	参数描述
x	指示要设置的枢轴的 x 坐标。
y	指示要设置的枢轴的 y 坐标。

setPivot

public void setPivot(Point point)

设置枢轴（点），此组件基于该点旋转和缩放。

参数：

参数名称	参数描述
point	表示要设置的点。

setScaleX

public void setScaleX(float scaleX)

围绕枢轴点设置组件在 X 方向上的缩放因子。

参数：

参数名称	参数描述
scaleX	表示 X 方向的比例因子。

setScaleY

public void setScaleY(float scaleY)

围绕枢轴点设置组件在 Y 方向上的缩放因子。

参数：

参数名称	参数描述
scaleY	表示 Y 方向的比例因子。

setScale

public void setScale(float x, float y)

围绕枢轴设置组件的比例因子。

缩放因子用于根据组件的原始大小控制组件的缩放效果。

参数：

参数名称	参数描述
x	表示 x 轴方向的比例因子。
y	表示y轴方向的比例因子。

setTranslationX

public void setTranslationX(float translationX)

设置组件相对于其左侧位置的水平位置。

该值是组件相对于 getLeft() 位置水平移动的距离。 需要相应地调整渲染位置。

参数：

参数名称	参数描述
translationX	指示组件相对于其左侧位置的水平移动，以像素为单位。

setTranslationY

public void setTranslationY(float translationY)

设置组件相对于其顶部位置的垂直位置。

该值是组件相对于 getTop() 位置垂直移动的距离。 需要相应地调整渲染位置。

参数：

参数名称	参数描述
translationY	指示组件相对于其顶部位置的垂直移动，以像素为单位。

setTranslationZ

public void setTranslationZ(float translationZ)

设置该组件在垂直于屏幕方向的深度位置变化。

参数：

参数名称	参数描述
translationZ	表示该组件的深度位置变化。

setTranslation

public void setTranslation(float x, float y)

设置组件相对于其左边界的水平平移和相对于其上边界的垂直平移。

参数：

参数名称	参数描述
x	指示要设置的水平平移，以像素为单位。
y	指示要设置的垂直平移，以像素为单位。

getRotation

public float getRotation()

获取组件相对于父布局绕 Z 轴旋转的度数。

返回:

返回旋转的度数。

getPivotX

public float getPivotX()

获取组件旋转缩放所围绕的点，即轴心点的X轴坐标。

这个位置是相对于父布局的。

返回:

返回枢轴点的 X 轴坐标。

getPivotY

public float getPivotY()

获取枢轴点相对于父布局的 Y 轴坐标。

返回:

返回枢轴点的 Y 轴坐标。

getPivot

public Point getPivot()

获取相对于父布局的枢轴。

返回:

返回一个表示枢轴的点。

getScaleX

public float getScaleX()

获取组件在 X 方向上相对于父布局的枢轴点的缩放因子。

返回:

返回比例因子。

getScaleY

public float getScaleY()

获取组件在 Y 方向上相对于父布局的枢轴点的缩放因子。

返回:

返回比例因子。

getScale

public DimensFloat getScale()

获取组件相对于父布局的枢轴周围的比例因子。 缩放因子用于根据组件的原始大小控制组件的缩放效果。

返回:

返回表示比例因子的 DimensFloat。

getTranslationX

public float getTranslationX()

获取组件相对于其左侧位置的水平平移。

返回:

返回以像素为单位的水平平移。

getTranslationY

public float getTranslationY()

获取组件相对于其顶部位置的垂直平移。

返回:

返回以像素为单位的垂直平移。

getTranslationZ

public float getTranslationZ()

获取该组件在垂直于屏幕方向的深度位置变化。

返回:

返回此组件的深度位置变化。

getTranslation

public DimensFloat getTranslation()

获取组件相对于其左边界的水平平移和相对于其上边界的垂直平移。

返回:

返回表示水平和垂直平移的 DimensFloat，以像素为单位。

setAltitude

public void setAltitude(float altitude)

设置此组件在垂直于屏幕的方向上的基本深度位置。

参数：

参数名称	参数描述
altitude	表示该组件的基本深度位置。

getAltitude

public float getAltitude()

获取该组件在垂直于屏幕方向的基本深度位置。

返回:

返回此组件的基本深度位置。

setShadowColor

public void setShadowColor(Color color)

设置组件的阴影颜色。

参数：

参数名称	参数描述
color	指示要设置的颜色。

getShadowColor

public Color getShadowColor()

获取组件的阴影颜色。

返回:

返回阴影的颜色。

getResourceManager

public ResourceManager getResourceManager()

获取与上下文关联的资源管理器。

返回:

返回与上下文关联的资源管理器。

getComponentTreeObserver

public ComponentTreeObserver getComponentTreeObserver()

获取组件的 ComponentTreeObserver。

返回:

返回组件的 ComponentTreeObserver。

scrollTo

public void scrollTo(int x, int y)

设置您希望组件滚动到的目标位置。

参数：

参数名称	参数描述
x	指示要滚动到的 X 轴坐标。
y	指示要滚动到的 Y 轴坐标。

scrollBy

public void scrollBy(int x, int y)

设置组件滚动的偏移量。

参数：

参数名称	参数描述
x	指示要滚动的 X 轴距离。
y	指示要滚动的 Y 轴距离。

getSelfVisibleRect

public boolean getSelfVisibleRect(Rect rect)

允许获取本地可见的 Rect（与组件的父级相关）

参数：

参数名称	参数描述
rect	用于保存可见 Rect 值的 Rect 容器

返回:

如果组件包含可见的 Rect，则为 true，否则为 false

getVisibleRectOnScreen

public boolean getVisibleRectOnScreen(Rect rect, int[] position)

获取组件相对于屏幕左上角的可见矩形区域。 可见区域是组件中未被其父组件裁剪的区域。

注意，使用该方法得到的可见区域是当前帧的可见区域。 如果要获取下一帧的可见区域，需要在LayoutRefreshedListener#onRefreshed(Component)中调用该方法。

参数：

参数名称	参数描述
rect	表示可见的矩形区域。 当该方法返回true时，该参数保存组件的可见矩形区域相对于屏幕的左上角。 当该方法返回false时，可见矩形的上、下、左、右坐标全部为0。
position	表示位置。 当此方法返回 true 时，此参数保存组件相对于屏幕左上角的坐标。 当该方法返回false时，该参数中保存的坐标全部为0。

返回:

如果当前组件在其父组件上有一个可见的矩形区域，则返回 true； 否则返回 false。

getMatrix

public Matrix getMatrix()

获取当前组件的转换矩阵。 矩阵包含组件的旋转、平移和缩放等信息。

返回:

返回当前组件的转换矩阵。

isIdentityMatrix

public boolean isIdentityMatrix()

检查当前组件的转换矩阵是否为单位矩阵。 您可以使用此方法检查组件是否已平移、旋转或缩放。

返回:

如果当前组件是单位矩阵，则返回 true； 否则返回 false。

getWindowVisibleRect

public boolean getWindowVisibleRect(Rect visibleRect)

获取组件所在窗口的可见矩形。 可见矩形是窗口可以向用户显示内容的区域，可以通过状态栏、导航栏和输入法来改变。

窗口的可见rect只能通过切片中的root Component获取。

参数：

参数名称	参数描述
visibleRect	矩形容器保存窗口的可见矩形值

返回:

如果组件包含可见的 Rect，则为 true，否则为 false

setAlpha

public void setAlpha(float alpha)

设置组件的 alpha 值。

0.0f 表示组件完全透明，1.0f 表示组件完全不透明。

参数：

参数名称	参数描述
alpha	表示组件的 alpha 值，范围为 0.0f 到 1.0f。

getAlpha

public float getAlpha()

获取组件的 alpha 值。

0.0f 表示组件完全透明，1.0f 表示组件完全不透明。

返回:

返回组件的 alpha 值，范围从 0.0f 到 1.0f。

setComponentDescription

public void setComponentDescription(CharSequence componentDescription)

设置组件中内容的描述。

参数：

参数名称	参数描述
componentDescription	表示组件中内容的描述。

getComponentDescription

public CharSequence getComponentDescription()

获取组件中内容的描述。

返回:

返回组件中内容的描述。

findComponentById

public <T extends Component> T findComponentById(int id)

查找具有给定 ID 的组件。

如果当前组件本身的 ID 与给定 ID 匹配，则返回当前组件。 否则，返回 null。

参数：

参数名称	参数描述
id	表示组件的唯一标识符。

返回:

返回 ID 与给定 ID 匹配的组件； 如果没有找到组件，则返回 null。

findFocus

public Component findFocus()

获取当前在其后代组件和自身中具有焦点的组件。

如果组件是简单组件并且当前具有焦点，则返回该组件。 否则，返回 null。 如果组件具有后代并且其中一个后代具有焦点，则返回获得焦点的后代。 如果没有后代有焦点，则返回 null。

返回:

返回焦点组件； 如果找不到焦点组件，则返回 null。

findNextFocusableComponent

public Component findNextFocusableComponent(int direction)

查找下一个要关注的组件。

该方法从当前具有焦点的组件返回给定方向上的下一个可聚焦组件。 如果未指定下一个可聚焦组件，则返回给定方向上最近的同级组件。

参数：

参数名称	参数描述
direction	指示焦点移动方向。 该值可以是以下之一：FOCUS_SIDE_LEFT、FOCUS_SIDE_TOP、FOCUS_SIDE_RIGHT、FOCUS_SIDE_BOTTOM、FOCUS_NEXT 或 FOCUS_PREVIOUS。

返回:

返回下一个接收焦点的组件，如果找不到这样的组件，则返回 null。

findRequestNextFocus

public boolean findRequestNextFocus(int side)

找到下一个获得焦点的组件并为其请求焦点。

此方法从当前聚焦的组件在给定方向上查找下一个可聚焦的组件。 如果没有找到下一个可聚焦组件，则返回给定方向上最近的兄弟组件。

参数：

参数名称	参数描述
side	指示焦点移动方向。 该值可以是：FOCUS_SIDE_LEFT、FOCUS_SIDE_TOP、FOCUS_SIDE_RIGHT、FOCUS_SIDE_BOTTOM、FOCUS_NEXT 或 FOCUS_PREVIOUS。

返回:

如果组件或其子组件之一获得焦点，则返回 true； 否则返回 false。

setUserNextFocus

public void setUserNextFocus(int side, int id)

设置要关注的下一个组件。

下一个要关注的组件必须是同一父级的另一个子级。 否则，调用 findNextFocusableComponent(int) 时会得到一个空指针。

参数：

参数名称	参数描述
side	指示焦点移动方向。 该值可以是以下之一：FOCUS_SIDE_LEFT、FOCUS_SIDE_TOP、FOCUS_SIDE_RIGHT、FOCUS_SIDE_BOTTOM、FOCUS_NEXT 或 FOCUS_PREVIOUS。
id	指示要关注的下一个组件的 ID。

getUserNextFocus

public int getUserNextFocus(int side)

获取下一个要关注的组件的 ID。

参数：

参数名称	参数描述
side	指示焦点移动方向。 该值可以是以下之一：FOCUS_SIDE_LEFT、FOCUS_SIDE_TOP、FOCUS_SIDE_RIGHT、FOCUS_SIDE_BOTTOM、FOCUS_NEXT 或 FOCUS_PREVIOUS。

返回:

返回下一个要关注的组件的 ID； 如果未设置此类组件，则返回 -1。

subscribeVoiceEvents

public void subscribeVoiceEvents(Component.VoiceEvent voiceEvent)

订阅该组件的指定语音事件。

参数：

参数名称	参数描述
voiceEvent	表示语音事件。

unsubscribeVoiceEvents

public void unsubscribeVoiceEvents()

一次取消订阅当前组件订阅的所有语音事件。

setSpeechEventListener

public void setSpeechEventListener(Component.SpeechEventListener listener)

设置此组件中语音事件的侦听器。

参数：

参数名称	参数描述
listener	指示要为语音事件设置的侦听器。

getSpeechEventListener

public Component.SpeechEventListener getSpeechEventListener()

获取 setSpeechEventListener(ohos.agp.components.Component.SpeechEventListener) 设置的监听器。

返回:

返回监听器。

setTag

public void setTag(Object tag)

设置与组件关联的标签。

参数：

参数名称	参数描述
tag	表示组件的标签。

getTag

public Object getTag()

获取组件的标签。

返回:

返回组件的标签。

enableScrollBar

public void enableScrollBar(int direction, boolean enabled)

设置是否为此组件启用滚动条。

参数：

参数名称	参数描述
direction	指示滚动方向，AXIS_X 表示水平滚动，AXIS_Y 表示垂直滚动。
enabled	指定是否启用滚动条。 值 true 表示启用滚动条，值 false（默认值）表示相反的情况。

isScrollBarOn

public boolean isScrollBarOn(int direction)

检查是否为此组件启用了滚动条。

参数：

参数名称	参数描述
direction	指示滚动方向，AXIS_X 表示水平滚动，AXIS_Y 表示垂直滚动。

返回:

如果启用了滚动条，则返回 true； 否则返回 false。

setScrollbarFadingEnabled

@Deprecated public void setScrollbarFadingEnabled(boolean enabled)

已弃用。 此更改从 API 版本 6 开始生效。替换为 enableFadeEffect(FadeEffectEnum) 或 disableFadeEffect(FadeEffectEnum)

设置组件不滚动时是否隐藏滚动条。

参数：

参数名称	参数描述
enabled	指定是否隐藏滚动条。 true 表示滚动条将被隐藏； false 表示相反的情况。

isScrollbarFadingOn

@Deprecated public boolean isScrollbarFadingOn()

已弃用。 此更改从 API 版本 6 开始生效。替换为 isFadeEffected(FadeEffectEnum)

检查滚动条是否会消失。

返回:

如果滚动条会消失，则返回 true； 否则返回 false。

enableFadeEffect

public void enableFadeEffect(Component.FadeEffectEnum fadeEffectEnum)

当组件未滚动时，启用滚动条或边界指示器的淡出效果。

参数：

参数名称	参数描述
fadeEffectEnum	指示要设置的组件指示器。

disableFadeEffect

public void disableFadeEffect(Component.FadeEffectEnum fadeEffectEnum)

当组件未滚动时，禁用滚动条或边界指示器的淡出效果。

参数：

参数名称	参数描述
fadeEffectEnum	指示要设置的组件指示器。

isFadeEffected

public boolean isFadeEffected(Component.FadeEffectEnum fadeEffectEnum)

检查是否为滚动条或边界指示器启用了淡出效果。

参数：

参数名称	参数描述
fadeEffectEnum	表示组件指示器。

返回:

如果启用淡出效果，则返回 true； 否则返回 false（默认值）。

setScrollbarFadingDelay

public void setScrollbarFadingDelay(int delay)

设置滚动条消失之前的延迟。

参数：

参数名称	参数描述
delay	指示滚动条消失之前的延迟，以毫秒为单位。

setScrollbarRoundRect

public void setScrollbarRoundRect(boolean isRoundRect)

设置滚动条的形状。

参数：

参数名称	参数描述
isRoundRect	指定滚动条是否为圆形。 true 表示圆角边框，false 表示矩形边框。

setScrollbarRadius

public void setScrollbarRadius(float radius)

设置滚动条圆角边框的半径。

参数：

参数名称	参数描述
radius	表示要设置的半径。

getScrollbarRoundRect

public boolean getScrollbarRoundRect()

获取滚动条的圆角边框。

返回:

如果滚动条有圆角边框，则返回 true； 如果滚动条具有矩形边框，则返回 false。

getScrollbarRadius

public float getScrollbarRadius()

获取滚动条圆角边框的半径。

返回:

返回滚动条圆角边框的半径。

getScrollbarFadingDelay

public int getScrollbarFadingDelay()

获取滚动条消失之前的延迟。

返回:

返回滚动条消失之前的延迟（以毫秒为单位）。 默认值为 500 毫秒。

setScrollbarFadingDuration

public void setScrollbarFadingDuration(int duration)

设置滚动条的淡出持续时间。

参数：

参数名称	参数描述
duration	指示滚动条的淡出持续时间，以毫秒为单位。

getScrollbarFadingDuration

public int getScrollbarFadingDuration()

获取滚动条的淡出持续时间。

返回:

返回滚动条淡出持续时间，以毫秒为单位。 默认值为 300 毫秒。

setScrollbarColor

public void setScrollbarColor(Color color)

设置滚动条的颜色。

参数：

参数名称	参数描述
color	指示滚动条的颜色。

getScrollbarColor

public Color getScrollbarColor()

获取滚动条的颜色。

返回:

返回滚动条的颜色。

setScrollbarBackgroundColor

public void setScrollbarBackgroundColor(Color color)

设置滚动条的背景颜色。

参数：

参数名称	参数描述
color	指示滚动条的背景颜色。

getScrollbarBackgroundColor

public Color getScrollbarBackgroundColor()

获取滚动条的背景颜色。

返回:

返回滚动条的背景颜色。

setScrollbarThickness

public void setScrollbarThickness(int thickness)

设置滚动条的粗细。

参数：

参数名称	参数描述
thickness	指示滚动条的粗细。

getScrollbarThickness

public int getScrollbarThickness()

获取滚动条的粗细。

返回:

返回滚动条的粗细。

setScrollbarStartAngle

public void setScrollbarStartAngle(float start)

设置圆形滚动条的起始角度。 此方法仅在使用 OVAL_MODE 时适用。

参数：

参数名称	参数描述
start	指示圆形滚动条的起始角度。

getScrollbarStartAngle

public float getScrollbarStartAngle()

获取圆形滚动条的起始角度。 此方法仅在使用 OVAL_MODE 时适用。

返回:

返回圆形滚动条的起始角度。

setScrollbarSweepAngle

public void setScrollbarSweepAngle(float sweep)

设置圆形滚动条的扫角。 此方法仅在使用 OVAL_MODE 时适用。

参数：

参数名称	参数描述
sweep	指示圆形滚动条的扫角。

getScrollbarSweepAngle

public float getScrollbarSweepAngle()

获取圆形滚动条的扫角。 此方法仅在使用 OVAL_MODE 时适用。

返回:

返回圆形滚动条的扫描角度。

setScrollbarOverlapEnabled

public void setScrollbarOverlapEnabled(boolean enabled)

设置滚动条是否与内容重叠。 默认情况下，滚动条与内容重叠。

参数：

参数名称	参数描述
enabled	指示滚动条是否与内容重叠。 true 表示滚动条与内容重叠； false 表示其他情况。

setVibrationEffectEnabled

public void setVibrationEffectEnabled(boolean enabled)

设置是否开启震动效果。

参数：

参数名称	参数描述
enabled	指示是否启用振动效果。

isVibrationEffectEnabled

public boolean isVibrationEffectEnabled()

检查是否启用了振动效果。

返回:

如果启用了振动效果，则返回 true； 否则返回 false。

isScrollbarOverlapEnabled

public boolean isScrollbarOverlapEnabled()

检查滚动条是否与内容重叠。

返回:

如果滚动条与内容重叠，则返回 true； 否则返回 false。

isRtl

public boolean isRtl()

检查组件是否从右到左布局。

默认情况下，组件的布局是从左到右，从上到下。

返回:

如果组件从右到左布局，则返回 true； 否则返回 false。

setCentralScrollMode

public void setCentralScrollMode(boolean centralMode)

设置是否启用中央滚动模式以始终在组件中心显示组件项。

参数：

参数名称	参数描述
centralMode	指定是否启用中央滚动模式。 默认值 false 表示将禁用中央滚动模式，值 true 表示启用。

getCentralScrollMode

public boolean getCentralScrollMode()

获取中央滚动模式的状态。

返回:

返回中央滚动模式的状态。

setMode

public void setMode(int mode)

设置此组件的显示模式。

当参数值为INHERITED_MODE（默认值）时，使用父组件的显示模式。 当参数值为RECT_MODE时，该组件的内容显示在一个矩形中。 当参数值为 OVAL_MODE 时，该组件的内容以椭圆显示。

参数：

参数名称	参数描述
mode	表示该组件的显示方式。

getMode

public int getMode()

获取该组件的显示方式。

返回:

展示模式。 值之一：INHERITED_MODE、RECT_MODE、OVAL_MODE

setScrollBarMode

public void setScrollBarMode(int scrollBarMode)

设置正在显示的滚动条的模式。 如果没有为滚动条设置模式，则使用显示组件的模式。

当 scrollBarMode 设置为 UNSPECIFIED_SCROLL_BAR_MODE 时，滚动条使用与显示组件相同的模式。 当此参数设置为 RECT_SCROLL_BAR_MODE 时，滚动条显示为矩形。 当此参数为 OVAL_SCROLL_BAR_MODE 时，滚动条显示为椭圆。

参数：

参数名称	参数描述
scrollBarMode	指示要设置的滚动条的模式。

getScrollBarMode

public int getScrollBarMode()

获取正在显示的滚动条的模式。

返回:

返回滚动条模式，可以是 UNSPECIFIED_SCROLL_BAR_MODE、RECT_SCROLL_BAR_MODE 或 OVAL_SCROLL_BAR_MODE。

getModeResolved

public int getModeResolved()

获取持有该组件的设备的显示模式。

返回:

返回显示模式，RECT_MODE 或 OVAL_MODE。

setCenterZoomFactor

public void setCenterZoomFactor(float scaleX, float scaleY)

设置缩放中心组件项目的缩放系数。

该值可以是DEFAULT_SCALE，大于1，小于1，分别代表默认的缩放系数、缩小系数和放大系数。

参数：

参数名称	参数描述
scaleX	表示在 X 轴上缩放中心组件项的缩放系数。
scaleY	表示在 Y 轴上缩放中心组件项的缩放系数。

getCenterZoomFactor

public float[] getCenterZoomFactor()

获取缩放中心组件项的缩放系数。

返回:

返回缩放因子的 X 轴和 Y 轴坐标的数组。

informConfigurationChanged

public void informConfigurationChanged(Configuration config)

调度配置更改事件。 事件处理逻辑由 onAttributeConfigChanged(ohos.global.configuration.Configuration) 实现。

参数：

参数名称	参数描述
config	表示最新配置。

onAttributeConfigChanged

protected void onAttributeConfigChanged(Configuration config)

更改配置时调用。

参数：

参数名称	参数描述
config	表示最新配置。

setLayoutDirection

public void setLayoutDirection(Component.LayoutDirection layoutDirection)

设置此组件的布局方向。

参数：

参数名称	参数描述
layoutDirection	指示要设置的布局方向。

getLayoutDirection

public Component.LayoutDirection getLayoutDirection()

获取该组件的布局方向。

返回:

返回布局方向。 有关可用值的详细信息，请参阅 LayoutDirection。

getLayoutDirectionResolved

public Component.LayoutDirection getLayoutDirectionResolved()

获取该组件的解析布局方向。

返回:

如果布局方向为 RTL，则返回 LayoutDirection#RTL； 如果布局方向是 LTR，则返回 LayoutDirection#LTR。

setFadeEffectBoundaryWidth

public void setFadeEffectBoundaryWidth(int width)

设置组件的淡入淡出效果区域的边界宽度。

参数：

参数名称	参数描述
width	指示要设置的边界宽度，以像素为单位。

getFadeEffectBoundaryWidth

public int getFadeEffectBoundaryWidth()

获取组件淡化效果区域的边界宽度。

返回:

返回边界宽度，以像素为单位。

setFadeEffectColor

public void setFadeEffectColor(Color color)

设置产生淡入淡出效果时显示的颜色。

参数：

参数名称	参数描述
color	指示要设置的颜色。

getFadeEffectColor

public Color getFadeEffectColor()

获取产生淡入淡出效果时显示的颜色。

返回:

返回颜色。

onRtlChanged

protected void onRtlChanged(Component.LayoutDirection layoutDirection)

在更改任何 RTL 属性时调用。

参数：

参数名称	参数描述
layoutDirection	表示当前布局方向的值。

setBoundaryFadeEffectEnable

@Deprecated public void setBoundaryFadeEffectEnable(boolean enable)

已弃用。 此更改从 API 版本 6 开始生效。替换为 enableFadeEffect(FadeEffectEnum) 或 disableFadeEffect(FadeEffectEnum)

设置是否显示组件淡化效果区域的边界。

参数：

参数名称	参数描述
enable	指定是否显示组件的淡入淡出效果区域的边界。 true 表示显示边界，false 表示相反的情况。

isBoundaryFadeEffectEnable

@Deprecated public boolean isBoundaryFadeEffectEnable()

已弃用。 此更改从 API 版本 6 开始生效。替换为 isFadeEffected(FadeEffectEnum)

检查组件的淡入淡出效果区域的边界是否被绘制。

返回:

如果边界被绘制，则返回 true； 否则返回 false（默认值）。

getBoundaryFadeEffectLeftRate

public float getBoundaryFadeEffectLeftRate()

获取速率乘以基本边界宽度，得到组件淡化效果区域的左边界宽度。

返回:

返回乘以得到左边界宽度的速率。 默认值为 0.0f。

getBoundaryFadeEffectTopRate

public float getBoundaryFadeEffectTopRate()

获取速率乘以基本边界宽度，得到组件淡化效果区域的顶部边界宽度。

返回:

返回乘以获取顶部边界宽度的速率。 默认值为 0.0f。

getBoundaryFadeEffectRightRate

public float getBoundaryFadeEffectRightRate()

获取速率乘以基本边界宽度，得到组件淡化效果区域的右边界宽度。

返回:

返回乘以获得右边界的速率。 默认值为 0.0f。

getBoundaryFadeEffectBottomRate

public float getBoundaryFadeEffectBottomRate()

获得率乘以基本边界宽度，得到组件淡化效果区域的底部边界宽度。

返回:

返回速率相乘以获得底部边界。 默认值为 0.0f。

enableSaveState

public void enableSaveState(boolean isEnabled)

设置此组件及其子组件是否可以保存其状态。

参数：

参数名称	参数描述
isEnabled	指定此组件及其子组件是否可以保存其状态。 值 true 表示它们可以保存状态，false 表示相反。

isSaveStateEnabled

public boolean isSaveStateEnabled()

检查此组件及其子组件是否可以保存其状态。

返回:

如果此组件及其子组件可以保存它们的状态，则返回 true； 否则返回 false。

onSaveState

protected Sequenceable onSaveState()

当要保存此组件及其子组件的状态时调用。

如果子类想要保存特定状态，您可以重写此方法。

返回:

返回包含状态信息的 Sequenceable 对象。

onRestoreState

protected void onRestoreState(Sequenceable state)

当要恢复此组件及其子组件的状态时调用。

如果子类想要恢复到特定的状态，你可以重写这个方法。

参数：

参数名称	参数描述
state	表示保存状态信息的 Sequenceable 对象。

dispatchSaveState

protected void dispatchSaveState(PlainArraySequenceable stateContainer)

分发状态保存过程，保存该组件及其子组件的状态。

参数：

参数名称	参数描述
stateContainer	指示保存状态信息的容器。

dispatchRestoreState

protected void dispatchRestoreState(PlainArraySequenceable stateContainer)

分发状态恢复过程来恢复该组件及其子组件的状态。

参数：

参数名称	参数描述
stateContainer	表示保存待恢复状态信息的容器。

saveComponentTreeState

public void saveComponentTreeState(PlainArraySequenceable stateContainer)

将此组件及其子组件的状态保存到给定容器中。

参数：

参数名称	参数描述
stateContainer	指示保存状态信息的容器。

restoreComponentTreeState

public void restoreComponentTreeState(PlainArraySequenceable stateContainer)

从给定容器中恢复此组件及其子组件的状态。

参数：

参数名称	参数描述
stateContainer	表示保存要恢复的状态的 PlainArray 对象。

setTransitionSymbol

public void setTransitionSymbol(String symbol)

设置过渡符号。

参数：

参数名称	参数描述
symbol	指示要设置的转换符号。

getTransitionSymbol

public String getTransitionSymbol()

获取过渡符号。

返回:

返回符号 指示要设置的转换符号。

getBaseLine

public int getBaseLine()

获取从文本基线到组件顶部的高度。

返回:

返回从文本基线到组件顶部的高度； 如果组件不支持基线对齐，则返回 -1。

hasOverlaps

public boolean hasOverlaps()

检查此组件是否有重叠内容。

返回:

如果组件有重叠的内容，则返回 true； 否则返回 false。