Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Extends MaskGroup.

Description

The RowList node is a list of independently scrollable rows of posters. Each item in the list contains a row of posters that can be scrolled left/right independently of the other rows. The posters in any single row must be the same size, but the posters in different rows of the list can have different sizes. In addition to the posters, each row may contain a right-justified title label and a left-justified label that displays a "1 of N" message, indicating which poster in the row currently has the focus.

There are two horizontal scrolling options for the RowList node controlled by the rowFocusAnimationStyle field. Setting the rowFocusAnimationStyle field to "floatingFocus" causes the focus indicator to float left or right until it reaches the end of the row, at which point the focus will stay fixed on the first or last item in the row and the items will scroll left or right. Setting the rowFocusAnimationStyle field to "fixedFocusWrap" cause each row to wrap around when navigation 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 will float left and right.

Fields

FieldTypeDefaultUse
contentContentNodenone

Specifies the content for the list. The content should be a single ContentNode that has one child ContentNode for each row in the RowList. These child ContentNode's for each row should themselves contains child ContentNode's for each item in the row.

See the Data Bindings section below for more details. 

rowItemSelectedarray of integer[ ](read only) When an item is selected, rowItemSelected is 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[ ](read only) When an item gains the key focus, rowItemFocused is 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.
itemSelectedinteger0(read only) When an item is selected, itemSelected is set to the index of the selected row.
itemFocusedinteger0(read only) When a row gains the key focus, itemFocused is set to the index of the focused row.
itemUnfocusedinteger0(read only) When a row loses the key focus, itemFocused is set to the index of the unfocused row.
jumpToIteminteger0(write-only) When set to a valid item index, this causes the list to immediately update so that the specified row moves into the focus position
animateToIteminteger0(write-only) When set to a valid item index, this causes the list to quickly scroll so that the specified row moves into the focus position
itemSizeVector2D[0, 0]Specifies 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]A vector specifying the spacing between rows in the list. The y-component of the vector (i.e. array index 1) specifies the vertical spacing between rows. the x-component of the vector is ignored.
numRowsinteger0Specifies 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's content.
rowHeightsarray of floats[ ]

When specified, the rowHeights field specifies the heights of each row of the list. This allows the height of each row of the grid to vary from row to row.

The rowHeights values override the height specified in element 1 of the itemSize field. If the rowHeights array contains fewer elements than the number of rows in the data model, element 1 of the itemSize field is used as the height of the excess rows.

rowSpacingsarray of floats[ ]

When specified, the rowSpacings field specifies the spacing after each row of the list. This allows the spacing between rows to vary from row to row.

The rowSpacings values override the vertical spacing specified in element 1 of the itemSpacing field. If the rowSpacings array contains fewer elements than the number of rows in the data model, element 1 of the itemSpacing field is used as the spacing after the excess rows.

rowPosterSizearray of Vector2D's[ ]

Specifies the width and height of the posters 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 excess rows.

rowPosterSpacingarray of Vector2D's[ ]

Specifies the spacing between posters in each row. The x-component (i.e. array index 0) of each Vector2D in the array specified the horizontal spacing between posters 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 excess rows. If the array contains no values, no space will be included between posters in all rows.

focusXOffsetarray of floats[ ]

Specifies the X offset of the first fully visible poster in each row relative to the left edge of the list.

In most cases, the first fully visible poster 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 offset for the excess rows. If the array contains no values, the default X offset of 0.0, is used.

rowLabelOffsetarray of Vector2D's[ ]

Specifies the offset of the row label for each row. The X component specifies the horizontal offset of the label from the left edge of the row. The Y component specifies the vertical spacing between the label and the posters 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 labesl of the excess rows. If the array contains no values, an offset of [ 0, 0 ] is used.

showRowLabelarray of boolean's[ ]

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 excess rows. If the array contains no values, no row labels are displayed.

showRowCounterarray of boolean's[ ]

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 value for that row is 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 excess rows. If the array contains no values, no "1 of N" labels are displayed.

rowFocusAnimationStylestring"floatingFocus"

Specifies the scrolling behavior for each row of the grid.

Setting the rowFocusAnimationStyle field to "floatingFocus" causes the focus indicator to float left or right until it reaches the end of the row, at which point the focus will stay fixed on the first or last item in the row and the items will scroll left or right.

Setting the rowFocusAnimationStyle field to "fixedFocusWrap" cause each row to wrap around when navigation 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 will float left and right.

rowLabelColorColor0xFFFFFFFFSpecifies the color of the row and "1 on N" labels
rowLabelFontFontThe theme's DefaultText fontSpecifies the font for the row and "1 of N" labels
drawFocusFeedbackOnTopbooleanfalseSpecifies whether the focus indicator bitmap is drawn below or on top of the list items
drawFocusFeedbackbooleantrueSpecifies whether or not the focus indicator bitmap is displayed
focusBitmapUriBitmaptheme:LabelListFocusBitmapSpecifies 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.
focusFootprintBitmapUristringtheme:LabelListFocusFootprintBitmapSpecifies 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.
imageWellBitmapUristring""Specifies the bitmap file to use to suggest where images would appear for empty lists.
wrapDividerBitmapUristringtheme:ListDividerBitmapSpecifies 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.
wrapDividerHeightfloattheme:LabelListDividerHeight

Specifies the height of the divider. The wrapDividerBitmap will be scaled to this height.

The width of the wrap divider is set to the width of the list items (i.e. itemSize[0]) 

loadingBitmapUristring""Specifies a bitmap file to display while a grid item's poster is loading.
loadingBitmapOpacityfloat1.0Specifies an opacity value used to render the loading bitmap
failedBitmapUristring""Specifies a bitmap file to display when a grid item's poster fails to load
failedBitmapOpacityfloat1.0Specifies an opacity value used to render the failed bitmap

Theme Attributes

TBD Need to fill out this table TBD

Data Bindings

TBD Need to add a table of the data bindings here TBD

  • No labels