ISetPane

​

Interface ISetPane

interface ISetPane

Extends com.amazon.apmf.IStandard This interface is used to describe the properties of an element that represents a significant portion of UI. This interface is deprecated. Replaced by ISetPane2.

​

Methods

​

title()

void title(TextChunk[] title)

Set the title of this pane. This list of text chunks represents the title of this pane. It should only be included if the pane’s title is displayed on-screen.

​

Parameters

title

TextChunk[] — Required the title of this pane

---

​

caption()

void caption(TextChunk[] caption)

Set the caption of this pane. This list of text chunks includes this pane’s caption.

​

Parameters

caption

TextChunk[] — Required a list of TextChunks containing a caption for this pane.

---

​

modal()

void modal(bool modal)

Sets whether this pane is modal. This property indicates whether this pane is modal, and user interaction should be prevented from leaving it.

​

Parameters

modal

bool — Required true if this element is modal.

---

​

orientationText()

void orientationText(string orientationText)

Set the orientation text for this pane. This optional string property describes how a user should interact with content inside this pane. It should only be included when the understanding of the visual lay-out of content is essential to navigating it successfully.

​

Parameters

orientationText

string — Required the orientation text for this pane.

---