Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added corrected focus animation style

...

FieldTypeDefaultSimple/ComponentUse
itemComponentNamestring""componentSpecifies the name of an XML component for the items in each row. An instance of this component is created on demand for each visible item of each row. The XML component must define a specific interface as detailed in RowList XML Component below.
contentContentNodenoneboth

Specifies the content for the list. The content should be a single ContentNode that has one child ContentNode for each row. These child ContentNodes for each row should themselves contains child ContentNodes for each item in the row. See Data Bindings below for more details. 

itemSizevector2d[0,0]bothSpecifies the width and height of rows in the list. Note that this the width of the entire row, not the width of the posters in the row.
itemSpacingvector2d[0,0]bothSpecifies the spacing between rows in the list. The y-dimension of the vector specifies the vertical spacing between rows, and the x-dimension is ignored.
numRowsinteger0bothSpecifies the number of visible rows in the list. Note that the actual number of rows may be more or less than the number of visible rows depending on the number of items in the list content.
rowHeightsarray of floats[ ]both

Specifies the heights of each row of the list. This allows the height of each row of the list to vary from row to row. The values override the height specified in the y-dimension value of the itemSize field. If the array contains fewer elements than the number of rows in the data model, the y-dimension value of the itemSize field is used as the height of the extra rows.

rowSpacingsarray of floats[ ]both

Specifies the spacing after each row of the list. This allows the spacing between rows to vary from row to row. The values override the vertical spacing specified in y-dimension value of the itemSpacing field. If the array contains fewer elements than the number of rows in the data model, the y-dimension value of the itemSpacing field is used as the spacing after the extra rows.

rowItemSizearray of vector2d[ ]both

Specifies the width and height of the items in each row. The array of values must include at least one element. If the array contains fewer elements than the number of rows in the data model, the last value in the array is used as the size for the extra rows.

rowItemSpacingarray of vector2d[ ]both

Specifies the spacing between items in each row. The x-dimension of each array value specifies the horizontal spacing between list items in the corresponding row. If the array contains fewer elements than the number of rows in the data model, the last value in the array is used as the spacing for the extra rows. If the array contains no values, no space will be included between list items in all rows.

focusXOffsetarray of floats[ ]both

Specifies the x-dimension offset of the first fully visible item in each row relative to the left edge of the list. In most cases, the first fully visible item in each row will be positioned at the left edge of the list, so this field does not need to be specified. If the array contains fewer elements than the number of rows in the data model, the last value in the array is used as the x-dimension offset for the extra rows. If the array contains no values, the default x-dimension offset of 0.0 is used.

rowLabelOffsetarray of vector2d[0,0]both

Specifies the offset of the row label for each row. The x-dimension specifies the horizontal offset of the label from the left edge of the row. The y-dimension component specifies the vertical spacing between the label and the list items in the row. If the array contains fewer elements than the number of rows in the data model, the last value in the array is used as the offset for the labels of the extra rows. If the array specified contains no values, a default offset value of [0,0] is used.

showRowLabelarray of Boolean[ ]both

Specifies whether the row label on the left edge of each row is displayed. If the array contains fewer elements than the number of rows in the data model, the last value in array is used to control the display of the row label for the extra rows. If the array contains no values, no row labels are displayed.

showRowCounterarray of Boolean[ ]both

Specifies whether the "1 of N" label on the right edge of each row is displayed. Note that the "1 of N" label is only displayed for the focused row even if the showRowCounter field value for that row is set to true. If the array contains fewer elements than the number of rows in the data model, the last value in array is used to control the display of the "1 of N" label for the extra rows. If the array contains no values, no "1 of N" labels are displayed.

rowFocusAnimationStylestring"floatingFocus"both

Specifies the scrolling behavior for each how the focus indicator moves in a row of the grid. Setting the field value to floatingFocus causes items in response to the remote direction pad Left and Right key presses. The possible values are: 

OptionEffect
floatingFocusCauses the focus indicator to float left or right until it reaches the end of the row, at which point the focus indicator will stay fixed on the first or last item in the row, and the items will scroll left or right
. Setting the field value to fixedFocusWrap causes each
if there were items that were not visible.
fixedFocusWrapCauses the row to wrap around when
navigation
the focus indicator reaches the first or last item in the row, as long as the row contains enough items to fill the row. If the row does not contain enough items to fill the row, the focus indicator will float left and right.

 

rowLabelColorcolorsystem defaultbothSpecifies the color of the row and "1 on N" labels.
rowLabelFontfont

system default

bothSpecifies the font for the row and "1 of N" labels.
drawFocusFeedbackOnTopBooleanfalsebothSpecifies whether the focus indicator bitmap is drawn below or on top of the list items.
drawFocusFeedbackBooleantruebothSpecifies whether or not the focus indicator bitmap is displayed.
imageWellBitmapUriURI string""simpleSpecifies the bitmap file to use to suggest where images would appear for empty lists.
focusBitmapUriURI string""bothSpecifies the bitmap file used for the focus indicator when the list has focus. In most cases, this should be a 9-patch image that specifies both expandable regions as well as margins. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap.
focusFootprintBitmapUriURI string""bothSpecifies the bitmap file used for the focus indicator when the list does not have focus. In most cases, this should be a 9-patch image that specifies both expandable regions as well as margins. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap.
loadingBitmapUriURI string""simpleSpecifies a bitmap file to display while a list item poster is loading. TBD is there a default? probably TBD
loadingBitmapOpacityfloat1.0simpleSpecifies an opacity value used to render the loading bitmap.
failedBitmapUriURI string""simpleSpecifies a bitmap file to display when a list item poster fails to load. TBD is there a default? probably TBD
failedBitmapOpacityfloat1.0simpleSpecifies an opacity value used to render the failed bitmap.
wrapDividerBitmapUriURI string""bothSpecifies the bitmap file to use as a visual separator between the last and first list items when the list wraps. In most case, this should be a 9-patch image that specifies both expandable regions. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap.
wrapDividerHeightfloatsystem defaultboth

Specifies the height of the divider. The wrap divider bitmap will be scaled to this height. The width of the wrap divider is set to the width of the list items (that is, the x-dimension value of the itemSize field).  

rowItemSelectedarray of integer[ ]bothRead-Only
When an item is selected, set to a 2-element array, where element 0 contains the index of the row containing the selected item, and element 1 contains the index of the selected item in that row.
rowItemFocusedarray of integer[ ]both Read-Only
When an item gains the key focus, set to a 2-element array, where element 0 contains the index of the focused row, and element 1 contains the index of the focused item in that row.
itemSelectedinteger0bothRead-Only
When an item is selected, set to the index of the selected row.
itemFocusedinteger0bothRead-Only
When a row gains the key focus, set to the index of the focused row.
itemUnfocusedinteger0bothRead-Only
When a row loses the key focus, set to the index of the unfocused row.
jumpToIteminteger0bothWrite-Only
When set to a valid item index, causes the list to immediately update so that the specified row moves into the focus position.
animateToIteminteger0bothWrite-Only
When set to a valid item index, causes the list to quickly scroll so that the specified row moves into the focus position.

...