类: UiObject

更新: 2026/9/29 字数: 0 字 时长: 0 分钟

ui_object.UiObject

目录

构造函数

• constructor

Properties

• depth
• indexInParent
• javaObject
• parent
• root

Accessors

• accessibilityFocused
• availableExtraData
• boundsInScreen
• canOpenPopup
• checkable
• checked
• childCount
• children
• className
• clickable
• contentInvalid
• contextClickable
• desc
• dismissable
• drawingOrder
• editable
• enabled
• error
• focusable
• focused
• fullId
• hintText
• id
• inputType
• isHeading
• isImportantForAccessibility
• isMultiLine
• isPassword
• isTextEntryKey
• liveRegion
• longClickable
• maxTextLength
• originalText
• packageName
• paneTitle
• screenReaderFocusable
• scrollable
• selected
• showingHintText
• text
• textSelectionEnd
• textSelectionStart
• tooltipText
• visibleToUser
• windowId

方法

• accessibilityFocus
• clearAccessibilityFocus
• clearFocus
• clearSelection
• click
• collapse
• contextClick
• copy
• cut
• dismiss
• expand
• focus
• longClick
• pageDown
• pageLeft
• pageRight
• pageUp
• paste
• recycle
• refresh
• scrollBackward
• scrollDown
• scrollForward
• scrollLeft
• scrollRight
• scrollToPosition
• scrollUp
• select
• setSelection
• setText
• showOnScreen
• tree

构造函数

constructor

• new UiObject(javaObject, depth, indexInParent, root?, parent?): UiObject

构造UI控件。

参数

名称	类型	描述
javaObject	any	Java中的控件对象。
depth	number	获取控件的深度。
indexInParent	number	获取控件在父控件中的索引。从0开始。
root	undefined	UiObject
parent	undefined	UiObject

返回值

UiObject

Properties

depth

• Readonly depth: number

---

indexInParent

• Readonly indexInParent: number

---

javaObject

• Protected javaObject: any

---

parent

• Optional Readonly parent: UiObject

---

root

• Readonly root: UiObject

Accessors

accessibilityFocused

• get accessibilityFocused(): boolean

控件是否处于无障碍焦点。

返回值

boolean

---

availableExtraData

• get availableExtraData(): string[]

控件可用的额外数据。

返回值

string[]

---

boundsInScreen

• get boundsInScreen(): Rect

控件在屏幕中的边框位置。

返回值

Rect

---

canOpenPopup

• get canOpenPopup(): boolean

控件是否可打开弹窗。

返回值

boolean

---

checkable

• get checkable(): boolean

控件是否可被勾选。

返回值

boolean

---

checked

• get checked(): boolean

控件是否已被勾选。

返回值

boolean

---

childCount

• get childCount(): number

子控件的数量

返回值

number

---

children

• get children(): UiObject[]

子控件的列表。

返回值

UiObject[]

---

className

• get className(): string

控件的类名

返回值

string

---

clickable

• get clickable(): boolean

控件是否可被点击。

返回值

boolean

---

contentInvalid

• get contentInvalid(): boolean

控件的内容是否无效。例如，日期格式不正确。

返回值

boolean

---

contextClickable

• get contextClickable(): boolean

控件是否可在上下文中点击

返回值

boolean

---

desc

• get desc(): string

控件的描述信息

返回值

string

---

dismissable

• get dismissable(): boolean

控件是否可以关闭。

返回值

boolean

---

drawingOrder

• get drawingOrder(): number

控件在父控件中的绘制顺序。通常可用于区分同一个层次的控件。

返回值

number

---

editable

• get editable(): boolean

控件是否可编辑。

返回值

boolean

---

enabled

• get enabled(): boolean

控件是否已启用。大多数控件都是启用的状态(enabled为true)，处于“禁用”状态通常是灰色并且不可点击。

返回值

boolean

---

error

• get error(): string

控件的错误信息文本。

返回值

string

---

focusable

• get focusable(): boolean

控件是否可获取焦点。

返回值

boolean

---

focused

• get focused(): boolean

控件是否已获取焦点。

返回值

boolean

---

fullId

• get fullId(): string
  控件的完整id。在前方会有应用的页面信息。

返回值

string

---

hintText

• get hintText(): string

控件的提示文本。

返回值

string

---

id

• get id(): string

控件的id。

返回值

string

---

inputType

• get inputType(): number

控件的输入类型。

参见

inputType

返回值

number

---

isHeading

• get isHeading(): boolean

控件是否代表标题

返回值

boolean

---

isImportantForAccessibility

• get isImportantForAccessibility(): boolean

控件自认为是否关键。

返回值

boolean

---

isMultiLine

• get isMultiLine(): boolean

控件是否为多行可编辑文本。

返回值

boolean

---

isPassword

• get isPassword(): boolean

输入类型是否为密码。密码输入框中内容会用星号代替。

返回值

boolean

---

isTextEntryKey

• get isTextEntryKey(): boolean

控件是否为键盘或小键盘中的文本输入键。

返回值

boolean

---

liveRegion

• get liveRegion(): number

获取节点的活动区域模式。

• 活动区域是包含用户重要信息的区域，当它发生变化时，会通知用户。
• 例如，在带有显示“密码错误”通知的 TextView 的登录屏幕中，控件会标记活动区域为 View#ACCESSIBILITY_LIVE_REGION_POLITE

返回值

number

---

longClickable

• get longClickable(): boolean

控件是否可被长按

返回值

boolean

---

maxTextLength

• get maxTextLength(): number

控件的最大文本长度。

返回值

number

---

originalText

• get originalText(): string

控件的原始文本

返回值

string

---

packageName

• get packageName(): string

控件所在应用的包名

返回值

string

---

paneTitle

• get paneTitle(): boolean

控件所在窗口的标题。

返回值

boolean

---

screenReaderFocusable

• get screenReaderFocusable(): boolean

屏幕阅读器是否应将该控件视为可聚焦单元。

返回值

boolean

---

scrollable

• get scrollable(): boolean

控件是否可滑动。

返回值

boolean

---

selected

• get selected(): boolean

控件是否选中。被选中指的是，例如QQ聊天界面点击下方的"表情按钮"时，会出现自己收藏的表情，这时"表情按钮"便处于选中状态，其selected属性为true。

返回值

boolean

---

showingHintText

• get showingHintText(): boolean

控件是否正显示提示文本。

返回值

boolean

---

text

• get text(): string

控件的文本内容

返回值

string

---

textSelectionEnd

• get textSelectionEnd(): number

控件中选中文本的结束位置。

返回值

number

---

textSelectionStart

• get textSelectionStart(): number

控件中选中文本的起始位置。

返回值

number

---

tooltipText

• get tooltipText(): string

控件的工具提示文本。

返回值

string

---

visibleToUser

• get visibleToUser(): boolean

控件是否可见。

返回值

boolean

---

windowId

• get windowId(): number

控件所在的窗口id。

返回值

number

---

方法

accessibilityFocus

• accessibilityFocus(): boolean

获取无障碍焦点。

返回值

boolean 是否获取成功。

---

clearAccessibilityFocus

• clearAccessibilityFocus(): boolean

清除无障碍焦点

返回值

boolean 是否清除成功。

---

clearFocus

• clearFocus(): boolean

清除焦点。

返回值

boolean 是否清除成功。

---

clearSelection

• clearSelection(): boolean

取消选用该控件

返回值

boolean 是否取消选中成功。

---

click

• click(): boolean

点击该控件。

如果该函数返回false，可能是该控件不可点击(clickable为false)，当前界面无法响应该点击等（这种情况下可以使用clickCenter()代替）。

返回值

boolean 是否点击成功。

---

collapse

• collapse(): boolean

折叠控件

返回值

boolean 是否折叠成功。

---

contextClick

• contextClick(): boolean

点击上下文。

返回值

boolean 是否点击成功。

---

copy

• copy(): boolean

将当选选中文本复制到剪贴板。

返回值

boolean 是否复制成功。

---

cut

• cut(): boolean

将当前选中文本剪切到剪贴板。

返回值

boolean 是否剪切成功。

---

dismiss

• dismiss(): boolean

关闭控件。

返回值

boolean 是否关闭成功。

---

expand

• expand(): boolean

展开控件。

返回值

boolean 是否展开成功。

---

focus

• focus(): boolean

获取焦点。

返回值

boolean 是否获取成功。

---

longClick

• longClick(): boolean

长按该控件。

返回值

boolean 是否长按成功。

---

pageDown

• pageDown(): boolean

向下翻页。

返回值

boolean 是否翻页成功。

---

pageLeft

• pageLeft(): boolean

向左翻页。

返回值

boolean 是否翻页成功。

---

pageRight

• pageRight(): boolean

向右翻页。

返回值

boolean 是否翻页成功。

---

pageUp

• pageUp(): boolean

向上翻页。

返回值

boolean 是否翻页成功。

---

paste

• paste(): boolean

粘贴内容到该控件。

返回值

boolean 是否粘贴成功。

---

recycle

• recycle(): void

回收控件。

返回值

void

---

refresh

• refresh(): void

刷新控件

返回值

void

---

scrollBackward

• scrollBackward(): boolean

向后滚动。(一般为向上或向左)

返回值

boolean 是否滚动成功。

---

scrollDown

• scrollDown(): boolean

向下滚动

返回值

boolean 是否滚动成功。

---

scrollForward

• scrollForward(): boolean

向前滚动。(一般为向下或向右)

返回值

boolean 是否滚动成功。

---

scrollLeft

• scrollLeft(): boolean

向左滚动

返回值

boolean 是否滚动成功。

---

scrollRight

• scrollRight(): boolean

向右滚动

返回值

boolean 是否滚动成功。

---

scrollToPosition

• scrollToPosition(position: number): boolean

滚动到指定位置。

参数

名称	类型	描述
position	number	需滚动到的位置

返回值

boolean 是否滚动成功。

---

scrollUp

• scrollUp(): boolean

向上滚动

返回值

boolean 是否滚动成功。

---

select

• select(): boolean

选用该控件

返回值

boolean 是否选中成功。

---

setSelection

• setSelection(start: number, end: number): boolean

选中文本

参数

名称	类型	描述
start	number	选中的开始位置
end	number	选中的结束位置

返回值

boolean 是否选中成功。

---

setText

• setText(text: string): boolean

输入文本。

参数

名称	类型	描述
text	string	要输入的文本内容。

返回值

boolean 是否输入成功。

showOnScreen

• showOnScreen(): boolean

显示到屏幕上。

返回值

boolean 是否显示成功。

---

tree

• tree(): UiObject[]

返回值

UiObject[]