This component interface is deprecated.
Beginning July 1st, 2017, any new channels using this component will be rejected during certification.
Beginning January 1st, 2018, any updates to existing channels using this component will be rejected during certification.
|Table of Contents|
Description of Methods
SetContent(contentList as Object) as Void
Sets the list of content to be displayed on the screen. The caller passes an roArray of roAssociativeArrays (Content Meta-Data objects) representing the information for each item to be displayed on screen. See “Content Meta-Data” for details on the attributes for each element. The screen is responsible for fetching the poster art from the URL’s specified.
AddContent(item as Object) as Void
Adds an item to the end of the list to be displayed on screen. The caller passes an roAssociativeArray (Content Meta-Data object) representing the information of the item.
SetItem(index as Integer, item as Object) as Void
Updates the content of an item at the given index with the content given in the parameter. The caller passes the index of the item and an roAssociativeArray (Content Meta-Data object) representing the information of the item.
If the index parameter is not within the range of 0 – list size, this function has no effect.
ClearContent() as Void
Clears all the content in the list and displays an empty screen.
RemoveContent(index as Integer) as Void
Removes a list item at the given index. The screen refreshes immediately if the item is visible.
If the index parameter not withing the range of 0 – list size, this function has no effect.
SetFocusedListItem(index as Integer) as Void
Sets the focused list item to the given index. If the item is not visible, focus jumps to the item and item becomes visible.
SetHeader(header as String) as Void
Sets the header text of the screen. The header is a one line text displayed on top of the screen below the overhang. It can be used as an information text for the screen.
SetTitle(title as String) as Void
Sets the title of the screen. The title is displayed on the top right corner of the screen on the overhang.
Show() as Boolean
Display or refresh the screen after initial creation or state changes.
Close() as Void
Close the screen and delete the associated object. Useful for avoiding screen flicker when the display order of your screens does not resemble a stack.
SetBreadcrumbText(breadcrumb1 as String, breadcrumb2 as String) as Void
Set the breadcrumb values. This can be used as an alternative to SetTitle() so that the breadcrumb text alignment is consistent with other screens.
SetupBehaviorAtTopRow(behavior as String) as Void
behavior is a string that controls how the remote "up" key behaves when pressed once the topmost list item is selected. Valid values:
- stop - stop scrolling up, and stay on the list screen (default behavior)
- exit - exit the list screen