PolyList

Typewidget
Dictionarywidget.polylist
LibraryPolyList
Associationscom.livecode.widget.polylist
Summary

This widget that allows us to display our data as a list.

Description

PolyList is a widget that allows us to display data in a list format. This widget has enormous power when it comes to displaying data, with customization being one of its most powerful features. Allowing you to create multiple layouts with it using the same control type and even multiple layouts for the same control.

TypeNameSummarySyntax
messageitemFirstDraw

This message is sent when a list item is showed the first time.

itemFirstDraw <pItemIndex>

- - -selectionChanged

This message is sent when the selection is changed.

selectionChanged (pPreviousSelectionIndex,pNewSelectionIndex)

- - -subItemClick

This message is sent when the user clicks a subitem.

subItemClick (pItemIndex,pSubItemname)

- - -subItemMouseEnter

This message is sent when the mouse enters a subitem's rect.

subItemMouseEnter (pItemIndex,pSubItemname)

- - -subItemMouseLeave

This message is sent when the mouse leaves a subitem's rect.

subItemMouseLeave (pItemIndex,pSubItemname)

- - -subItemMouseMove

This message is sent when the mouse is moved over a subitem.

subItemMouseMove (pItemIndex,pSubItemname)

propertyaddData

A method for adding data to the list.

set the addData of widget to <List>

- - -addSingleItem

A method for adding an item to the list.

set the addSingleItem of widget to <Array>

- - -borderWidth

Specifies the thickness with which borders are drawn on the PolyList.

set the borderWidth of widget to <integer>

get the borderWidth of widget

- - -columnWidth

Establish the column width of the list.

set the columnWidth of widget to <integer>

get the columnWidth of widget

- - -csvData

The csvData property reflects the content in CSV format.

set the csvData of widget to <CSV>

get the csvData of widget

- - -dataContent

Get or set the data array that the PolyList will display.

set the dataContent of widget to <DataArray>

get the dataContent of widget

- - -dataHeight

Reports the height needed by an object to display its full contents without scrolling.

get the dataHeight of widget

- - -dataLayout

Defines how each item in the list is drawn.

set the dataLayout of widget to <Array>

get the dataLayout of widget

- - -enableItemCache

Use cache when rendering list items.

set the enableItemCache of widget to <Boolean>

get the enableItemCache of widget

- - -firstItemInView

The first visible or partially visible item of the list.

get the firstItemInView of widget

- - -hilitedItemData

Get or set the array of selected data corresponding to the selected item in the PolyList.

set the hilitedItemData of widget to <DataArray>

get the hilitedItemData of widget

- - -hilitedItemIndex

Specifies the item that will be hilited on a PolyList control.

set the hilitedItemIndex of widget to <integer>

get the hilitedItemIndex of widget

- - -hoverWithMouse

Defines if the PolyList highlights the item on which the mouse is.

set the hoverWithMouse of widget to {true | false}

get the hoverWithMouse of widget

- - -itemContent

Gets and sets the value of the content of an item in list.

set the itemContent of widget to <Array>

get the itemContent of widget

- - -itemHeight

Establish the height of the item of the list.

set the itemHeight of widget to <integer>

get the itemHeight of widget

- - -itemPointer

It's a pointer to tell the itemContent property about which item to act on.

set the itemPointer of widget to <integer>

get the itemPointer of widget

- - -itemRect

Gets the rect of a list item.

get the itemRect of widget

- - -lastItemInView

The last visible or partially visible item of the list.

get the lastItemInView of widget

- - -Margin

Specifies the margin that all the elements of a list will have in the PolyList.

set the margin of widget to <integer>

get the margin of widget

- - -mouseHoverHilite

Show the mouse item when the mouse is moved

set the mouseHoverHilite of widget to {true | false}

get the mouseHoverHilite of widget

- - -numberOfColumns

Set up and get the number of columns displayed in the PolyList

set the numberOfColumns of widget to {<integer>}

get the numberOfColumns of widget

- - -numberOfElements

Reports the total number of elements in a PolyList.

set the numberOfElements of widget to 20

get the numberOfElements of widget

- - -plBackgroundColor

Specifies the background color of list.

set the plBackgroundColor of widget to <RGBA Color>

get the plBackgroundColor of widget

- - -plBorderColor

Defines the color with which the borders are drawn in PolyList.

set the plBorderColor of widget to <RGBA Color>

get the plBorderColor of widget

- - -plHiliteColor

The color of the highlighted item of list.

set the plHiliteColor of widget to <RGBA Color>

get the plHiliteColor of widget

- - -plHoverColor

The color of the item the mouse is over.

set the plHoverColor of widget to <RGBA Color>

get the plHoverColor of widget

- - -plItemColor

Defines the background color of the list items.

set the plItemColor of widget to <RGBA Color>

get the plItemColor of widget

- - -roundedRadius

The radius of the corners of the elements in the list.

set the roundedRadius of widget to <integer>

get the roundedRadius of widget

- - -scroll

Specifies the vertical scroll of a PolyList.

set the scroll of widget to {<integer>}

get the scroll of widget

- - -scrollbarWidth

Get or set the width of the scrollbar

set the scrollbarWidth of widget to <integer>

get the scrollbarWidth of widget

- - -strokeBody

Specifies whether to draw the borders of the PolyList body.

set the strokeBody of widget to {true| false}

get the strokeBody of widget

- - -strokeItems

Specifies whether to draw the borders of the PolyList elements.

set the strokeItems of widget to {true| false}

get the strokeItems of widget

- - -subItemContent

Gets and sets the value of the content of an item in list.

set the subItemContent of widget to <Array>

get the subItemContent of widget

- - -subItemPointer

It's a pointer to tell the subItemContent property about which item to act on.

set the subItemPointer of widget to <String>

get the subItemPointer of widget

- - -touchScrolling

Specifies if the PolyList widget will respond to mouse scrolling gestures

set the touchScrolling of widget to {true | false}

get the touchScrolling of widget

- - -tsvData

The tsvData property reflects the content in TSV format.

set the tsvData of widget to <TSV>

get the tsvData of widget

- - -useOverlays

Draws the rectangle that indicates that an element is selected on top of the item.

set the useOverlays of widget to {true | false}

get the useOverlays of widget

- - -vScrollBar

Show or hide built-in vertical scrollbar.

set the vScrollBar of widget to <String>

get the vScrollBar of widget

widgetPolyList

This widget that allows us to display our data as a list.

set the vScrollBar of widget to <String>

get the vScrollBar of widget