public class AccessibilityNode

Object
AccessibilityNode

Mutable semantic configuration for a lightweight component or virtual child.

Component-owned nodes are obtained with Component.getSemantics(). Applications can create standalone nodes for an AccessibilityChildProvider; virtual nodes must have a stable virtual key.

Constructors

`public AccessibilityNode()`
`public AccessibilityNode(String virtualKey)`
`public AccessibilityNode(Component owner)`	Internal constructor used by `Component`.
`public AccessibilityNode(Component owner, String label)`	Internal constructor used by `Component` to seed a node from the component’s accessibility text.

Methods

`public` `Component getOwner()`
`public` `String getVirtualKey()`
`public` `AccessibilityNode setVirtualKey(String virtualKey)`
`public` `String getIdentifier()`
`public` `AccessibilityNode setIdentifier(String identifier)`
`public` `String getLabel()`
`public` `AccessibilityNode setLabel(String label)`
`public` `String getHint()`
`public` `AccessibilityNode setHint(String hint)`
`public` `String getDescription()`
`public` `AccessibilityNode setDescription(String description)`
`public` `String getValue()`
`public` `AccessibilityNode setValue(String value)`
`public` `String getValidationError()`
`public` `AccessibilityNode setValidationError(String error)`
`public` `String getPaneTitle()`
`public` `AccessibilityNode setPaneTitle(String paneTitle)`
`public` `String getRoleDescription()`
`public` `AccessibilityNode setRoleDescription(String roleDescription)`
`public` `AccessibilityRole getRole()`
`public` `AccessibilityNode setRole(AccessibilityRole role)`
`public` `AccessibilityCheckedState getChecked()`
`public` `AccessibilityNode setChecked(AccessibilityCheckedState checked)`
`public` `AccessibilityLiveRegion getLiveRegion()`
`public` `AccessibilityNode setLiveRegion(AccessibilityLiveRegion liveRegion)`
`public` `AccessibilityGrouping getGrouping()`
`public` `AccessibilityNode setGrouping(AccessibilityGrouping grouping)`
`public` `AccessibilityRange getRange()`
`public` `AccessibilityNode setRange(AccessibilityRange range)`
`public` `AccessibilityCollectionInfo getCollectionInfo()`
`public` `AccessibilityNode setCollectionInfo(AccessibilityCollectionInfo info)`
`public` `AccessibilityCollectionItemInfo getCollectionItemInfo()`
`public` `AccessibilityNode setCollectionItemInfo(AccessibilityCollectionItemInfo info)`
`public` `AccessibilityChildProvider getChildProvider()`
`public` `AccessibilityNode setChildProvider(AccessibilityChildProvider provider)`
`public` `Rectangle getBounds()`
`public` `AccessibilityNode setBounds(Rectangle bounds)`
`public` `Boolean getSelected()`
`public` `AccessibilityNode setSelected(Boolean selected)`
`public` `Boolean getExpanded()`
`public` `AccessibilityNode setExpanded(Boolean expanded)`
`public` `Boolean getEnabled()`
`public` `AccessibilityNode setEnabled(Boolean enabled)`
`public` `Boolean getInvalid()`
`public` `AccessibilityNode setInvalid(Boolean invalid)`
`public` `Boolean getBusy()`
`public` `AccessibilityNode setBusy(Boolean busy)`
`public` `Boolean getReadOnly()`
`public` `AccessibilityNode setReadOnly(Boolean readOnly)`
`public` `Boolean getRequired()`
`public` `AccessibilityNode setRequired(Boolean required)`
`public` `Boolean getMultiline()`
`public` `AccessibilityNode setMultiline(Boolean multiline)`
`public` `Boolean getObscured()`
`public` `AccessibilityNode setObscured(Boolean obscured)`
`public` `Boolean getPressed()`
`public` `AccessibilityNode setPressed(Boolean pressed)`
`public` `Boolean getCurrent()`
`public` `AccessibilityNode setCurrent(Boolean current)`
`public boolean isModal()`
`public` `AccessibilityNode setModal(boolean modal)`
`public int getHeadingLevel()`
`public` `AccessibilityNode setHeadingLevel(int level)`
`public double getSortKey()`
`public` `AccessibilityNode setSortKey(double sortKey)`
`public` `Component getTraversalBefore()`
`public` `AccessibilityNode setTraversalBefore(Component component)`
`public` `Component getTraversalAfter()`
`public` `AccessibilityNode setTraversalAfter(Component component)`
`public` `AccessibilityNode addAction(AccessibilityAction action)`
`public` `AccessibilityNode removeAction(String id)`
`public` `List<AccessibilityAction> getActions()`
`public` `AccessibilityNode addChild(AccessibilityNode child)`
`public` `AccessibilityNode clearChildren()`
`public` `List<AccessibilityNode> getChildren()`
`public boolean hasExplicitConfiguration()`

Inherited methods

From Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait, clone

Constructor details

AccessibilityNode

public AccessibilityNode()

AccessibilityNode

public AccessibilityNode(String virtualKey)

AccessibilityNode

public AccessibilityNode(Component owner)

Internal constructor used by Component.

AccessibilityNode

public AccessibilityNode(Component owner, String label)

Internal constructor used by Component to seed a node from the component’s accessibility text.

The label is assigned directly rather than through setLabel(String) because this runs the first time anything reads the node – typically the tree walk that is describing the component right now. Reporting it as a change would make describing a tree invalidate that same tree, so a refresh pass that re-posts itself whenever work is queued would never run out of work, and on a surface that keeps making components it would spin the event thread. Creating a node to read it is not news to whoever asked to read it.

Method details

getOwner

public Component getOwner()

getVirtualKey

public String getVirtualKey()

setVirtualKey

public AccessibilityNode setVirtualKey(String virtualKey)

getIdentifier

public String getIdentifier()

setIdentifier

public AccessibilityNode setIdentifier(String identifier)

getLabel

public String getLabel()

setLabel

public AccessibilityNode setLabel(String label)

getHint

public String getHint()

setHint

public AccessibilityNode setHint(String hint)

getDescription

public String getDescription()

setDescription

public AccessibilityNode setDescription(String description)

getValue

public String getValue()

setValue

public AccessibilityNode setValue(String value)

getValidationError

public String getValidationError()

setValidationError

public AccessibilityNode setValidationError(String error)

getPaneTitle

public String getPaneTitle()

setPaneTitle

public AccessibilityNode setPaneTitle(String paneTitle)

getRoleDescription

public String getRoleDescription()

setRoleDescription

public AccessibilityNode setRoleDescription(String roleDescription)

getRole

public AccessibilityRole getRole()

setRole

public AccessibilityNode setRole(AccessibilityRole role)

getChecked

public AccessibilityCheckedState getChecked()

setChecked

public AccessibilityNode setChecked(AccessibilityCheckedState checked)

getLiveRegion

public AccessibilityLiveRegion getLiveRegion()

setLiveRegion

public AccessibilityNode setLiveRegion(AccessibilityLiveRegion liveRegion)

getGrouping

public AccessibilityGrouping getGrouping()

setGrouping

public AccessibilityNode setGrouping(AccessibilityGrouping grouping)

getRange

public AccessibilityRange getRange()

setRange

public AccessibilityNode setRange(AccessibilityRange range)

getCollectionInfo

public AccessibilityCollectionInfo getCollectionInfo()

setCollectionInfo

public AccessibilityNode setCollectionInfo(AccessibilityCollectionInfo info)

getCollectionItemInfo

public AccessibilityCollectionItemInfo getCollectionItemInfo()

setCollectionItemInfo

public AccessibilityNode setCollectionItemInfo(AccessibilityCollectionItemInfo info)

getChildProvider

public AccessibilityChildProvider getChildProvider()

setChildProvider

public AccessibilityNode setChildProvider(AccessibilityChildProvider provider)

getBounds

public Rectangle getBounds()

setBounds

public AccessibilityNode setBounds(Rectangle bounds)

getSelected

public Boolean getSelected()

setSelected

public AccessibilityNode setSelected(Boolean selected)

getExpanded

public Boolean getExpanded()

setExpanded

public AccessibilityNode setExpanded(Boolean expanded)

getEnabled

public Boolean getEnabled()

setEnabled

public AccessibilityNode setEnabled(Boolean enabled)

getInvalid

public Boolean getInvalid()

setInvalid

public AccessibilityNode setInvalid(Boolean invalid)

getBusy

public Boolean getBusy()

setBusy

public AccessibilityNode setBusy(Boolean busy)

getReadOnly

public Boolean getReadOnly()

setReadOnly

public AccessibilityNode setReadOnly(Boolean readOnly)

getRequired

public Boolean getRequired()

setRequired

public AccessibilityNode setRequired(Boolean required)

getMultiline

public Boolean getMultiline()

setMultiline

public AccessibilityNode setMultiline(Boolean multiline)

getObscured

public Boolean getObscured()

setObscured

public AccessibilityNode setObscured(Boolean obscured)

getPressed

public Boolean getPressed()

setPressed

public AccessibilityNode setPressed(Boolean pressed)

getCurrent

public Boolean getCurrent()

setCurrent

public AccessibilityNode setCurrent(Boolean current)

isModal

public boolean isModal()

setModal

public AccessibilityNode setModal(boolean modal)

getHeadingLevel

public int getHeadingLevel()

setHeadingLevel

public AccessibilityNode setHeadingLevel(int level)

getSortKey

public double getSortKey()

setSortKey

public AccessibilityNode setSortKey(double sortKey)

getTraversalBefore

public Component getTraversalBefore()

setTraversalBefore

public AccessibilityNode setTraversalBefore(Component component)

getTraversalAfter

public Component getTraversalAfter()

setTraversalAfter

public AccessibilityNode setTraversalAfter(Component component)

addAction

public AccessibilityNode addAction(AccessibilityAction action)

removeAction

public AccessibilityNode removeAction(String id)

getActions

public List<AccessibilityAction> getActions()

addChild

public AccessibilityNode addChild(AccessibilityNode child)

clearChildren

public AccessibilityNode clearChildren()

getChildren

public List<AccessibilityNode> getChildren()

hasExplicitConfiguration

public boolean hasExplicitConfiguration()