Roku SDK Documentation : ifGridScreen

Implemented By

• roGridScreen

Supported Methods

Description of Methods

SetupLists(count as Integer) as Void

Set the number of rows in the grid.  The number of rows must be set before calling other functions to populate grid data.

SetListNames(names as Object) as Void

Set the list of row titles, where names must be an roArray of strings. The first name is displayed for the first row, the second name for the second row, etc.

The list should contain as many titles as the number of rows in the grid.

SetListName(rowIndex as Integer, name as String) as Void

Set the row title for the specified row.  Row indexes are zero-based.

SetContentList(rowIndex as Integer, contentList as Object) as Void

Set the content list for the specified row.  Row indexes are zero-based.

The content list must be an roArray of items.  Each item must be an roAssociativeArray containing the content meta-data used to display the item, such as Title, Description, SDPosterUrl, and HDPosterUrl.  See Content Meta-Data for details.

SetContentListSubset(rowIndex as Integer, contentList as Object, offset as Integer, length as Integer) as Void

Set or update items in the content list for the specified row.  Row indexes are zero-based.

Enables performance improvements when dealing with your backend services by asking only for only a screenful worth of data at a time, and then update the rest of the content list content in the background.

Parameters offset and length specify the sublist of the row's content list that should be updated from the contentList parameter.

See SetContentList for a description of content lists and items.

SetListOffset(rowIndex as Integer, itemIndex as Integer) as Void

The grid populates poster screens in a background thread.

SetListOffset enables a developer to change the current position (both row and column) of the downloading thread in populating image posters of the grid.

The downloading thread will reprioritize poster downloads based on the new list offset.

SetListVisible(rowIndex as Integer, visible as Boolean) as Void

Sets the visibility of the specified row.  Row indexes are zero-based.

SetFocusedListItem(rowIndex as Integer, itemIndex as Integer) as Void

Set the focus to the specified row and item.  Row and item indexes are zero-based.

SetDisplayMode(displayMode as String) as Void

Sets the mode for displaying images in the grid screen. This allows images to be either scaled to completely fill the poster frame (scale-to-fill) or scaled to fit inside the poster frame (scale-to-fit) while maintaining aspect ratio.

Valid display modes are:

• scale-to-fill – scale image to completely fill the rectangle of the bounding frame (Default)
• scale-to-fit – scale image to fit horizontally or vertically as appropriate while still maintaining aspect ratio. Note that scale-to-fit may result in pillar-box or letter-box display of images.
• zoom-to-fill – scales and crops image to maintain aspect ratio and completely fill the rectangle of the bounding frame.
• photo-fit – Uses several methods to fit the image with a different aspect ratio to the screen. First, it will asymmetrically scale up to a maximum of 5%. Second, for landscape images, if vertical cropping is necessary, it will remove two lines off the bottom for every one line off the top up to a maximum of 30% of the image. For all images, if horizontal cropping is necessary it will crop an equal amount from both sides.

ShowMessage(message as String) as Void

Displays a semi-transparent popup message box to the user in the center of the screen over the poster screen. Generally used for error messages.

ClearMessage() as Void

Clears the message from the previous ShowMessage call.

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.

SetGridStyle(style as String) as Void

Sets the style or theme for displaying images in the grid screen. This allows different appearances of the overall grid for different sized images:

• flat-movie – movie posters as seen in the Netflix channel (Default)
  • Image sizes: SD 110x150 HD 210x270
  • SD 5 posters across, by 2 rows
  • HD 5 posters across, by 2 rows
• flat-portrait
  • Image sizes: SD 110x140 HD 210x300
  • SD 5 posters across, by 2 rows
  • HD 5 posters across, by 2 rows
• flat-landscape
  • Image sizes: SD 140x94 HD 210x158
  • SD 4 posters across, by 3 rows
  • HD 5 posters across, by 3 rows
• flat-square – note that SD has non-square pixels so the dimensions below appear as square on the screen
  • Image sizes: SD 96x86 HD 132x132
  • SD 6 posters across, by 3 rows
  • HD 7 posters across, by 3 rows
• flat-16x9
  • Image sizes: SD 140x70 HD 210x118
  • SD 4 posters across, by 3 rows
  • HD 5 posters across, by 3 rows

• two-row-flat-landscape-custom
  
  • Image sizes: SD 138x77 HD 266x150
  • SD 4 posters across, by 2.5 rows
  • HD 4 posters across, by 2 rows

  mixed-aspect-ratio

  • Images sizes - dependent on the list poster style for the row
    • HD
      • landscape - 192 x 144
      • portrait - 192 x 274
      • square - 192 x 192
    • SD 
      • landscape -  140 x 94
      • portrait - 140 x 180
      • square - 140 x 126
  • SD 4 posters across depending on list poster style for the row

  • HD 5 posters across depending on list poster style for the row

  four-column-flat-landscape

  • Image sizes: SD 140x70 HD 210x118
  • SD 4 posters across, by 3.5 rows
  • HD 4 posters across, by 3 rows

SetListPosterStyles(styles as Object) as Void

Used in conjunction with the mixed-apect-ratio grid style, this function sets the images size and orientation for each row in the grid.

There are three styles supported: landscape, portrait, and square. 

For example, passing the array ["landscape", "portrait", "landscape"] configures a mixed-aspect-ratio grid to use landscape images for row 1, portrait images for row 2, and landscape images for row 3.

SetBreadcrumbEnabled(enabled as Boolean) as Void

If enabled is true, display the breadcrumb text specified with SetBreadcrumbText.

SetBreadcrumbText(Location1 as String, Location2 as String) as Void

If SetBreadcrumbEnabled() is true, display Location1 and Location2 in the right of the overhang.

SetUpBehaviorAtTopRow(behavior as String) as Void

Behavior is a string that controls how the remote "up" key behaves when pressed with the top row selected.

The default behavior, "stop", is to stop scrolling but stay on the roGridScreen.

Valid values:

• stop - stop scrolling up, and stay on the roGridScreen (default behavior)
• exit - exit the roGridScreen

SetLoadingPoster(sdPosterUrl as String, hdPosterUrl as String) as Void

This function lets you specify the default images to show in the grid while the grid screen content is loading.

SetErrorPoster(sdPosterUrl as String, hdPosterUrl as String) as Void

This function lets you specify the default images to show in the grid when the grid screen content fails to load.

SetCounterVisible(visible as Boolean) as Void

Sets whether the item counter should be displayed.  The item counter shows the focused item number and count of items in the row.

SetDescriptionVisible(visible as Boolean) as Void

Set whether the description box is displayed for the focused item. When it is false, the description box is not displayed.

The description box is the callout box that displays detailed information about the focused item.

SetFocusRingVisible(visible as Boolean) as Void

Sets whether the focus ring should be displayed for the focused item.