IAccessibilityContext

​

Interface IAccessibilityContext

interface IAccessibilityContext

Extends com.amazon.apmf.IStandard The IAccessibilityContext interface for creating Trait builders and retrieving setter APIs to publish accessibility metadata. This will publish the accessibility information for the current view by default, if not specified explicitly using the publishForView API These APIs target VegaUIFramework customers and internally rely on UCC APIs. UI Framework authors who do not use VegaUIFramework as a UI Toolkit can directly use the lower level UCC APIs for publishing Accessibility information.

​

Methods

​

getView()

IView* getView()

Returns the view associated with the accessibility context.

​

Returns

IView* pointer to the view.

---

​

publishForView()

void publishForView(IView* view)

Updates the current context to publish accessibility metadata for the passed view. This will ensure that the setter APIs called afterwards will publish for the user passed view. Note: If this API is called, no accessibility info will be published for the current view but only for the passed view and the current view will not be visible in the accessibility tree. By default, if this API is not called, accessibility metadata will be published for the current view The user passed view other than the current view is expected to be one of it’s ancestors (parent views)

​

Parameters

view

IView* — Required IView The view for which children accessibility information needs to be emitted.

---

​

makeEditableTraitBuilder()

IEditableTraitBuilder* makeEditableTraitBuilder()

Factory function to create an instance of IEditableTraitBuilder.

​

Returns

IEditableTraitBuilder* Pointer to a newly created IEditableTraitBuilder instance.

---

​

makeExpandableTraitBuilder()

IExpandableTraitBuilder* makeExpandableTraitBuilder()

Factory function to create an instance of IExpandableTraitBuilder.

​

Returns

IExpandableTraitBuilder* Pointer to a newly created IExpandableTraitBuilder instance.

---

​

makeScrollableTraitBuilder()

IScrollableTraitBuilder* makeScrollableTraitBuilder()

Factory function to create an instance of IScrollableTraitBuilder.

​

Returns

IScrollableTraitBuilder* Pointer to a newly created IScrollableTraitBuilder instance.

---

​

makeSelectableTraitBuilder()

ISelectableTraitBuilder* makeSelectableTraitBuilder()

Factory function to create an instance of ISelectableTraitBuilder.

​

Returns

ISelectableTraitBuilder* Pointer to a newly created ISelectableTraitBuilder instance.

---

​

makeSwitchableTraitBuilder()

ISwitchableTraitBuilder* makeSwitchableTraitBuilder()

Factory function to create an instance of ISwitchableTraitBuilder.

​

Returns

ISwitchableTraitBuilder* Pointer to a newly created ISwitchableTraitBuilder instance.

---

​

makeRelationshipsTraitBuilder()

IRelationshipsTraitBuilder* makeRelationshipsTraitBuilder()

Factory function to create an instance of IRelationshipsTraitBuilder.

​

Returns

IRelationshipsTraitBuilder* Pointer to a newly created IRelationshipsTraitBuilder instance.

---

​

makeVoiceAssistantTraitBuilder()

IVoiceAssistantTraitBuilder* makeVoiceAssistantTraitBuilder()

Factory function to create an instance of IVoiceAssistantTraitBuilder.

​

Returns

IVoiceAssistantTraitBuilder* Pointer to a newly created IVoiceAssistantTraitBuilder instance.

---

​

makeTableTraitBuilder()

ITableTraitBuilder* makeTableTraitBuilder()

Factory function to create an instance of ITableTraitBuilder.

​

Returns

ITableTraitBuilder* Pointer to a newly created ITableTraitBuilder instance.

---

​

makeValueTraitBuilder()

IValueTraitBuilder* makeValueTraitBuilder()

Factory function to create an instance of IValueTraitBuilder.

​

Returns

IValueTraitBuilder* Pointer to a newly created IValueTraitBuilder instance.

---

​

makeHintsTraitBuilder()

IHintsTraitBuilder* makeHintsTraitBuilder()

Factory function to create an instance of IHintsTraitBuilder.

​

Returns

IHintsTraitBuilder* Pointer to a newly created IHintsTraitBuilder instance.

---

​

makePageableTraitBuilder()

IPageableTraitBuilder* makePageableTraitBuilder()

Factory function to create an instance of IPageableTraitBuilder.

​

Returns

IPageableTraitBuilder* Pointer to a newly created IPageableTraitBuilder instance.

---

​

makeTableCellTraitBuilder()

ITableCellTraitBuilder* makeTableCellTraitBuilder()

Factory function to create an instance of ITableCellTraitBuilder.

​

Returns

ITableCellTraitBuilder* Pointer to a newly created ITableCellTraitBuilder instance.

---

​

makeVisibilityTraitBuilder()

IVisibilityTraitBuilder* makeVisibilityTraitBuilder()

Factory function to create an instance of IVisibilityTraitBuilder.

​

Returns

IVisibilityTraitBuilder* Pointer to a newly created IVisibilityTraitBuilder instance.

---

​

makeAdjustableTraitBuilder()

IAdjustableTraitBuilder* makeAdjustableTraitBuilder()

Factory function to create an instance of IAdjustableTraitBuilder.

​

Returns

IAdjustableTraitBuilder* Pointer to a newly created IAdjustableTraitBuilder instance.

---

​

makePaneTraitBuilder()

IPaneTraitBuilder* makePaneTraitBuilder()

Factory function to create an instance of IPaneTraitBuilder.

​

Returns

IPaneTraitBuilder* Pointer to a newly created IPaneTraitBuilder instance.

---

​

makeHeadingTraitBuilder()

IHeadingTraitBuilder* makeHeadingTraitBuilder()

Factory function to create an instance of IHeadingTraitBuilder.

​

Returns

IHeadingTraitBuilder* Pointer to a newly created IHeadingTraitBuilder instance.

---

​

makeCheckableTraitBuilder()

ICheckableTraitBuilder* makeCheckableTraitBuilder()

Factory function to create an instance of ICheckableTraitBuilder.

​

Returns

ICheckableTraitBuilder* Pointer to a newly created ICheckableTraitBuilder instance.

---

​

makeFocusableTraitBuilder()

IFocusableTraitBuilder* makeFocusableTraitBuilder()

Factory function to create an instance of IFocusableTraitBuilder.

​

Returns

IFocusableTraitBuilder* Pointer to a newly created IFocusableTraitBuilder instance.

---

​

makeEnableableTraitBuilder()

IEnableableTraitBuilder* makeEnableableTraitBuilder()

Factory function to create an instance of IEnableableTraitBuilder.

​

Returns

IEnableableTraitBuilder* Pointer to a newly created IEnableableTraitBuilder instance.

---

​

makeCompoundComponentTraitBuilder()

ICompoundComponentTraitBuilder* makeCompoundComponentTraitBuilder()

Factory function to create an instance of ICompoundComponentTraitBuilder.

​

Returns

ICompoundComponentTraitBuilder* Pointer to a newly created ICompoundComponentTraitBuilder instance.

---

​

makeLiveTraitBuilder()

ILiveTraitBuilder* makeLiveTraitBuilder()

Factory function to create an instance of ILiveTraitBuilder.

​

Returns

ILiveTraitBuilder* Pointer to a newly created ILiveTraitBuilder instance.

---

​

makeHiddenTraitBuilder()

IHiddenTraitBuilder* makeHiddenTraitBuilder()

Factory function to create an instance of IHiddenTraitBuilder.

​

Returns

IHiddenTraitBuilder* Pointer to a newly created IHiddenTraitBuilder instance.

---

​

setTrait()

void setTrait(ITrait* accessibilityTrait)

Set the Accessibility trait for current/user specified view. The given ITrait object can represent any Trait Data Object which was built using the corresponding builder. Note: Multiple calls for setting the same trait will override the previous values.

​

Parameters

accessibilityTrait

ITrait* — Required The ITrait object that represents a trait data object built using the trait specific builder. For e.g. Editable Trait; Checkable Trait; etc.

---

​

clearTrait()

void clearTrait(TraitType* TraitType)

Clear the give accessibility trait from the current/user specified view.

​

Parameters

TraitType

TraitType* — Required The TraitType representing the trait to be removed from the view. For e.g. EDITABLE; CHECKABLE; etc.

---

​

setAccessibilityActions()

void setAccessibilityActions(com.amazon.kepler.ucc.v1_0.common.IAction*[] actions)

Set actions property of a view. Actions are custom listeners which a view can expose to allow a client to trigger its functionality. Exposing the functionality through the standard set of traits is preferred over this. The actions property is a list of IAction objects. To add actions to a view, the user must create an object that implements the IAction interface Note: Multiple calls for setting actions will override the previous values.

​

Parameters

actions

com.amazon.kepler.ucc.v1_0.common.IAction*[] — Required A list of IAction objects representing standard/custom actions this view supports

---

​

clearActionsByName()

void clearActionsByName(string name)

Remove actions from a view.

​

Parameters

name

string — Required the name of the action to remove

---

​

clearAllActions()

void clearAllActions()

Remove all actions from a view.

---

​

setDescription()

void setDescription(string text)

Set human readable description of a view. Note: Multiple calls to this API will override the previous values set for Description.

​

Parameters

text

string — Required String of human readable description of the view

---

​

setRole()

void setRole(com.amazon.kepler.ucc.v1_0.common.Role* role)

Set role for a view which provides further descriptive information, beyond what can be derived from the traits alone. Note: Multiple calls to this API will override the previous values set for Role.

​

Parameters

role

com.amazon.kepler.ucc.v1_0.common.Role* — Required Role for the view.

---

​

setText()

void setText(com.amazon.kepler.ucc.v1_0.common.TextChunk[] chunks)

Set the on-screen text of the view. This list contains the text chunks displayed in this view. If the text is descriptive, and is not displayed on-screen, it should be set with setDescription instead. Note: Multiple calls to this API will override the previous values set for Text.

​

Parameters

chunks

com.amazon.kepler.ucc.v1_0.common.TextChunk[] — Required The list of TextChunks containing the on-screen text of the view

---

​

setNames()

void setNames(string[] names)

Set names for a view; which is a list of human or machine readable names for the view. These would be used to identify this view. Note: Multiple calls to this API will override the previous values set for Names.

​

Parameters

names

string[] — Required A string list of names which identify the view

---

​

setTestId()

void setTestId(string testId)

Set test_id for a view; which allows clients to reliably remember and find particular instances of views on-screen. Note: Multiple calls to this API will override the previous values set for TestId.

​

Parameters

testId

string — Required string containing the unique ID of the view within the application

---