ISetEditable

​

Interface ISetEditable

interface ISetEditable

Extends com.amazon.apmf.IStandard This interface allows describing an editable text field.

​

Methods

​

startEditingFunction()

void startEditingFunction(ICallbackFunction* func)

Set the function to call when the client requests to start editing this field. This function can be called by UCC clients to ensure that the keyboard is visible and available for editing text.

​

Parameters

func

ICallbackFunction* — Required the function to call to start editing this field.

---

​

selection()

void selection(i32 start, i32 end)

Set the text selection or cursor position. selectionStart and selectionEnd represent integer character offsets at which the text selection begins and ends respectively. If they are equal, they represent the position of the editing cursor. If not available, these properties may be omitted or set to -1.

​

Parameters

start

i32 — Required the selection start

end

i32 — Required the selection end

---

​

textSelection()

void textSelection(ISetTextSelection* func)

Set the function to call when clients request to set the text selection.

​

Parameters

func

ISetTextSelection* — Required the ISetTextSelection to use.

---

​

hidden()

void hidden(bool hidden)

Indicate that the text in this field is hidden.

​

Parameters

hidden

bool — Required true if the text is hidden.

---

​

searchField()

void searchField(bool isSearchField)

Indicate that this field is a search field.

​

Parameters

isSearchField

bool — Required true if this field is a search field.

---

​

searchResults()

void searchResults(ElementId id)

Set the ID of the results container if this is a search field.

​

Parameters

id

ElementId — Required the element ID of the container displaying search results if this is a search field.

---

​

multiLine()

void multiLine(bool multiLine)

Indicate that this field can contain multi-line text.

​

Parameters

multiLine

bool — Required true if this field can contain multi-line text.

---

​

showingHintText()

void showingHintText(bool show)

Indicate that this field is currently showing hint text. This supports the pattern introduced by Google in Android by which the hint for a field is shown when the field is empty.

​

Parameters

show

bool — Required true if this field is currently showing hint text.

---

​

contentInvalid()

void contentInvalid(bool invalid)

Indicates that the contents of this field are currently invalid.

​

Parameters

invalid

bool — Required true if the contents are currently invalid.

---

​

inputType()

void inputType(InputType* inputType)

Set the input type for this field.

​

Parameters

inputType

InputType* — Required the InputType.

---