ListPanel Class Reference

List widget with multiple rows. More...

Inheritance diagram for ListPanel:
ContainerWidget Widget

List of all members.

Public Member Functions

 ListPanel ()
 Constructor.
void SetListItemCreator (ListItemCreator creator)
 Registers the method of creating items.
void SetListItemUpdater (ListItemUpdater updater)
 Registers the method of updating items.
void Move (float moveDistance)
 Moves a specified distance.
void UpdateItems ()
 Updates all currently displayed items.
ListPanelItem GetListItem (int index)
 Obtains the specified index item.
ListPanelItem GetListItem (int sectionIndex, int indexInSection)
 Obtains the specified index item.

Protected Member Functions

internal override void OnResetState ()
 Status reset handler.
internal override void OnPreviewKeyEvent (KeyEvent keyEvent)
 Advance key event handler.
internal override void OnTouchEvent (TouchEventCollection touchEvents)
 Touch event handler.
override void OnUpdate (float elapsedTime)
 Update processing.

Properties

override float Width [get, set]
 Obtains and sets the width.
override float Height [get, set]
 Obtains and sets the height.
UIColor BackgroundColor [get, set]
 Obtains and sets the background color.
ListSectionCollection Sections [get, set]
 Obtains and sets the collection of a section.
int AllItemCount [get]
 Obtains the total number of items.
bool ShowSection [get, set]
 Obtains and sets whether to display a section.
bool ShowEmptySection [get, set]
 Obtains and sets whether to display empty sections.
bool ShowItemBorder [get, set]
 Obtains and sets whether to display the border images of an item.
ScrollBarVisibility ScrollBarVisibility [get, set]
 Obtains and sets the scroll bar view.
UIFont SectionFont [get, set]
 Obtains and sets the section font.
UIColor SectionTextColor [get, set]
 Obtains and sets the section text color.
UIColor SectionBackgroundColor [get, set]
 Obtains and sets the section background color.

Events

EventHandler
< ListPanelItemSelectChangedEventArgs
SelectItemChanged
 Event called when item is selected.

Detailed Description

List widget with multiple rows.

A grouping feature and index feature are available. Item details can be customized.


Member Function Documentation

ListPanelItem GetListItem ( int  index)

Obtains the specified index item.

If an index outside the display range is specified, null is returned.

Parameters:
indexItem index for all lists
Returns:
Item
ListPanelItem GetListItem ( int  sectionIndex,
int  indexInSection 
)

Obtains the specified index item.

If an index outside the display range is specified, null is returned.

Parameters:
sectionIndexIndex of section
indexInSectionItem index within section
Returns:
Item
void Move ( float  moveDistance)

Moves a specified distance.

Moves up when a negative number is specified, and moves down when a positive number is specified.

Parameters:
moveDistanceTravel distance (pixels)
internal override void OnPreviewKeyEvent ( KeyEvent  keyEvent) [protected, virtual]

Advance key event handler.

Parameters:
keyEventKey event

Reimplemented from Widget.

internal override void OnTouchEvent ( TouchEventCollection  touchEvents) [protected, virtual]

Touch event handler.

Parameters:
touchEventsTouch event

Reimplemented from Widget.

override void OnUpdate ( float  elapsedTime) [protected, virtual]

Update processing.

Parameters:
elapsedTimeElapsed time from previous update (ms)

Reimplemented from Widget.

void SetListItemCreator ( ListItemCreator  creator)

Registers the method of creating items.

Parameters:
creatorMethod of creating items
void SetListItemUpdater ( ListItemUpdater  updater)

Registers the method of updating items.

Parameters:
updaterMethod of updating items