IDescribeElement2

​

Interface IDescribeElement2

interface IDescribeElement2

Extends IDescribeElement Extended element description interface.

​

Methods

​

addWindow2()

ISetWindow2* addWindow2()

Add the IWindow interface to this element.

​

Returns

ISetWindow2* the ISetWindow2 interface

---

​

locale()

void locale(com.amazon.apmf.Locale* locale)

Set the locale for this element, which allows assistive technologies such as screen readers to invoke the correct pronunciation while presenting the element’s label, value, and hint. The value should be in the format of BCP 47. The BCP 47 language subtag is required. Other subtags are optional. For example, en is for English, and es-ES is for Spanish as spoken in Spain. If this property is not set, the locale of the element is considered as the same with the device locale.

​

Parameters

locale

com.amazon.apmf.Locale* — Required the locale of this element

---

​

removeLocale()

void removeLocale()

Remove the locale from this element.

---

​

addBusy()

ISetBusy* addBusy()

Add the IBusy interface to this element.

​

Returns

ISetBusy* the ISetBusy interface

---

​

removeBusy()

void removeBusy()

Remove the IBusy interface from this element.

---

​

addWeb()

ISetWeb* addWeb()

Add the IWeb interface to this element.

​

Returns

ISetWeb* the ISetWeb interface

---

​

removeWeb()

void removeWeb()

Remove the IWeb interface from this element.

---

​

text2()

void text2(TextChunk2*[] text)

Provide the on-screen text of this element. This list contains the text chunks displayed in this component. If the text is descriptive, and is not displayed on-screen, it should be set with setDescription instead.

​

Parameters

text

TextChunk2*[] — Required a list of TextChunk2 objects containing the on-screen text of this element.

---

​

attributedDescription()

void attributedDescription(TextChunk2* description)

Set the description of this element with rich text information. This allows setting description text with language specification and semantic interpretation type for assistive technologies.

​

Parameters

description

TextChunk2* — Required the rich text description of this element

---

​

removeAttributedDescription()

void removeAttributedDescription()

remove the attributed description from this element.

---

​

addLiveRegion2()

ISetLiveRegion2* addLiveRegion2()

Add the ILiveRegion interface trait to this element.

​

Returns

ISetLiveRegion2* the ISetLiveRegion2 interface

---

​

grouping()

void grouping(bool enabled)

Marks this element as a grouped accessibility item. When enabled, this element and all of its descendants are treated as a single logical accessibility item. Descendant elements:

• are not individually focusable or touchable
• do not appear as separate nodes to assistive technologies

This element becomes responsible for exposing any relevant information (e.g. role, state, and actions) derived from its descendants. Note: Actions defined on descendant elements are not automatically exposed. If users need to perform a descendant-specific action, this element must explicitly expose a corresponding accessibility action.

​

Parameters

enabled

bool — Required true to treat this element and all descendants as a single accessibility item; false to restore normal behavior.

---

​

removeGrouping()

void removeGrouping()

remove the grouping prop from this element.

---

​

addCollectionInfo2()

ISetCollectionInfo2* addCollectionInfo2()

Add the ICollectionInfo interface to this element.

​

Returns

ISetCollectionInfo2* the ISetCollectionInfo2 interface

---

​

addPane2()

ISetPane2* addPane2()

Add the IPane interface to this element.

​

Returns

ISetPane2* the ISetPane2 interface

---