This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
built_in:lists [2014/12/28 18:53] stevegarman add callback samples |
built_in:lists [2015/04/18 11:15] octazid [Example - HTML Font Color] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Lists ====== | ====== Lists ====== | ||
- | ===== Create | + | |
- | Create List objects using the CreateList method of the app object: | + | // |
+ | |||
+ | ===== Description | ||
+ | Create List objects using the **CreateList** method of the **[[built_in: | ||
< | < | ||
- | Use the SetOnTouch and SetOnLongTouch methods of the List object to set the name of a function you want to be called when a list item is selected. The selected item is passed into your OnTouch callback function as a parameter every time an item is selected or long touched. | + | Use the **SetOnTouch** and **SetOnLongTouch** methods of the List object to set the name of a function you want to be called when a list item is selected. The selected item is passed into your OnTouch callback function as a parameter every time an item is selected or long touched. |
+ | |||
+ | ====Example - Simple==== | ||
+ | <code javascript> | ||
+ | function OnStart() | ||
+ | { | ||
+ | lay = app.CreateLayout( " | ||
+ | |||
+ | lst = app.CreateList( " | ||
+ | lst.SetOnTouch( lst_OnTouch ); | ||
+ | lst.SetOnLongTouch( lst_OnLongTouch ); | ||
+ | lay.AddChild( lst ); | ||
+ | |||
+ | app.AddLayout( lay ); | ||
+ | } | ||
+ | |||
+ | function lst_OnTouch( item ) | ||
+ | { | ||
+ | app.ShowPopup( "Item = " + item, " | ||
+ | } | ||
+ | function lst_OnLongTouch( item ) | ||
+ | { | ||
+ | app.ShowPopup( "Long Touch = " + item, " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | You can change the look of a List using the **SetBackColor** and **SetTextColor** functions on the list object. You can also set a background image/ | ||
+ | |||
+ | ====Example - Gray on white==== | ||
+ | <code javascript> | ||
+ | function OnStart() | ||
+ | { | ||
+ | lay = app.CreateLayout( " | ||
+ | |||
+ | lst = app.CreateList( " | ||
+ | lst.SetTextColor( "# | ||
+ | lst.SetBackColor( "# | ||
+ | lst.SetOnTouch( lst_OnTouch ); | ||
+ | lay.AddChild( lst ); | ||
+ | |||
+ | app.AddLayout( lay ); | ||
+ | } | ||
+ | |||
+ | function lst_OnTouch( item ) | ||
+ | { | ||
+ | app.ShowPopup( " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | The List object also supports **multi-line** list items and can show certain types of **icon**. Multi-line items are created by dividing each list item up using the ':' | ||
+ | |||
+ | You can have one icon and up to three lines of text using the following formats: | ||
+ | |||
+ | * title : icon | ||
+ | * title : body : icon | ||
+ | * title : body : extra : icon | ||
+ | |||
+ | The available icons types are displayed using the following key words: | ||
+ | |||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | |||
+ | ====Example - Title + Icon==== | ||
+ | <code javascript> | ||
+ | function OnStart() | ||
+ | { | ||
+ | lay = app.CreateLayout( " | ||
+ | |||
+ | var data = " | ||
+ | lst = app.CreateList( data, 0.8, 0.4 ); | ||
+ | lst.SetOnTouch( lst_OnTouch ); | ||
+ | lay.AddChild( lst ); | ||
+ | |||
+ | app.AddLayout( lay ); | ||
+ | } | ||
+ | |||
+ | function lst_OnTouch( item ) | ||
+ | { | ||
+ | app.ShowPopup( " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ====Example - Title + Icon==== | ||
+ | <code javascript> | ||
+ | function OnStart() | ||
+ | { | ||
+ | lay = app.CreateLayout( " | ||
+ | |||
+ | var data = "The Hobbit: | ||
+ | data += ", | ||
+ | lst = app.CreateList( data, 0.8, 0.4 ); | ||
+ | lst.SetOnTouch( lst_OnTouch ); | ||
+ | lay.AddChild( lst ); | ||
+ | |||
+ | app.AddLayout( lay ); | ||
+ | } | ||
+ | |||
+ | function lst_OnTouch( item ) | ||
+ | { | ||
+ | app.ShowPopup( " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | You can also create lists items that look like **buttons** by using one of the following options: | ||
+ | |||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | |||
+ | ====Example - Orange Buttons==== | ||
+ | <code javascript> | ||
+ | function OnStart() | ||
+ | { | ||
+ | lay = app.CreateLayout( " | ||
+ | |||
+ | var data = " | ||
+ | lst = app.CreateList( data, 0.8, 0.8, " | ||
+ | lst.SetBackColor( "# | ||
+ | lst.SetPadding( 0.1, 0.1, 0.1, 0.1 ); | ||
+ | lst.SetOnTouch( lst_OnTouch ); | ||
+ | lay.AddChild( lst ); | ||
+ | |||
+ | app.AddLayout( lay ); | ||
+ | } | ||
+ | |||
+ | function lst_OnTouch( item ) | ||
+ | { | ||
+ | app.ShowPopup( " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | Or create lists with **Gradient** backgrounds like this: | ||
+ | |||
+ | ====Example - Gradient Background==== | ||
+ | <code javascript> | ||
+ | function OnStart() | ||
+ | { | ||
+ | lay = app.CreateLayout( " | ||
+ | |||
+ | var data = ""; | ||
+ | for( var i=1; i<=30; i++) | ||
+ | { | ||
+ | if( i>1 ) data += ","; | ||
+ | data += "Item " | ||
+ | } | ||
+ | lst = app.CreateList( data, 1, 1, " | ||
+ | lst.SetTextColor1( "# | ||
+ | lst.SetTextColor2( "# | ||
+ | lst.SetTextMargins( 0.04, 0, 0, 0 ); | ||
+ | lst.SetOnTouch( lst_OnTouch ); | ||
+ | lay.AddChild( lst ); | ||
+ | |||
+ | app.AddLayout( lay ); | ||
+ | } | ||
+ | |||
+ | function lst_OnTouch( item ) | ||
+ | { | ||
+ | app.ShowPopup( " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ====Example - HTML Font Color==== | ||
+ | <code javascript> | ||
+ | function OnStart() | ||
+ | { | ||
+ | // | ||
+ | lay = app.CreateLayout( " | ||
+ | |||
+ | // | ||
+ | var data = | ||
+ | "< | ||
+ | "< | ||
+ | "< | ||
+ | lst = app.CreateList( data, | ||
+ | lay.AddChild( lst ); | ||
+ | |||
+ | // | ||
+ | app.AddLayout( lay ); | ||
+ | } | ||
+ | </ | ||
+ | ---- | ||
===== Methods ===== | ===== Methods ===== | ||
+ | Some controls use the same methods.\\ | ||
+ | For examples of the **[[same methods]]** look here. | ||
^Method ^Description ^ | ^Method ^Description ^ | ||
|ListView.AddItem( title, | |ListView.AddItem( title, | ||
- | |ListView.Destroy() | | | ||
|ListView.GetAbsHeight() | | | |ListView.GetAbsHeight() | | | ||
|ListView.GetAbsWidth() | | | |ListView.GetAbsWidth() | | | ||
|ListView.GetHeight() | | | |ListView.GetHeight() | | | ||
- | |ListView.GetList( | + | |ListView.GetItemByIndex( index ) | | |
+ | |ListView.GetList( | ||
|ListView.GetPosition() | | | |ListView.GetPosition() | | | ||
|ListView.GetTextSize( mode ) | | | |ListView.GetTextSize( mode ) | | | ||
Line 17: | Line 210: | ||
|ListView.GetVisibility() | | | |ListView.GetVisibility() | | | ||
|ListView.GetWidth() | | | |ListView.GetWidth() | | | ||
- | |ListView.Release() | | | ||
|ListView.RemoveItem( title ) | | | |ListView.RemoveItem( title ) | | | ||
+ | |ListView.RemoveItemByIndex( index ) | | | ||
|ListView.ScrollToItem( name,body ) | | | |ListView.ScrollToItem( name,body ) | | | ||
- | |ListView.SelectItem( | + | |ListView.ScrollToItemByIndex( index ) | | |
- | |ListView.SelectItemByIndex( index, | + | |ListView.SelectItem( |
- | |ListView.SetBackColor( | + | |ListView.SelectItemByIndex( index, |
- | |ListView.SetBackGradient( | + | |ListView.SetBackColor( |
- | |ListView.SetBackGradientRadial( | + | |ListView.SetBackGradient( |
- | |ListView.SetBackground( | + | |ListView.SetBackGradientRadial( |
+ | |ListView.SetBackground( | ||
|ListView.SetDivider( height, | |ListView.SetDivider( height, | ||
|ListView.SetEllipsize( mode ) | | | |ListView.SetEllipsize( mode ) | | | ||
Line 31: | Line 225: | ||
|ListView.SetEllipsize2( mode ) | | | |ListView.SetEllipsize2( mode ) | | | ||
|ListView.SetFontFile( file ) | | | |ListView.SetFontFile( file ) | | | ||
- | |ListView.SetHiTextColor1( | + | |ListView.SetHiTextColor1( |
- | |ListView.SetHiTextColor2( | + | |ListView.SetHiTextColor2( |
|ListView.SetItem( title, | |ListView.SetItem( title, | ||
- | |ListView.SetList( list,delim ) | | | + | |ListView.SetItemByIndex( index, |
+ | |ListView.SetList( list,delimeter | ||
|ListView.SetMargins( left, | |ListView.SetMargins( left, | ||
- | |ListView.SetOnLongTouch( callback ) |sets the function called when list is touched | | + | |ListView.SetOnLongTouch( callback ) |sets the function called when list is long-touched | |
- | |ListView.SetOnTouch( callback ) |sets the function called when list is long-touched | | + | |ListView.SetOnTouch( callback ) |sets the function called when list is touched | |
- | |ListView.SetPadding( | + | |ListView.SetPadding( |
- | |ListView.SetPosition( | + | |ListView.SetPosition( |
|ListView.SetScale( x,y ) | | | |ListView.SetScale( x,y ) | | | ||
- | |ListView.SetSize( | + | |ListView.SetSize( |
- | |ListView.SetTextColor( | + | |ListView.SetTextColor( |
- | |ListView.SetTextColor1( | + | |ListView.SetTextColor1( |
- | |ListView.SetTextColor2( | + | |ListView.SetTextColor2( |
- | |ListView.SetTextMargins( | + | |ListView.SetTextMargins( |
|ListView.SetTextShadow( radius, | |ListView.SetTextShadow( radius, | ||
|ListView.SetTextShadow1( radius, | |ListView.SetTextShadow1( radius, | ||
|ListView.SetTextShadow2( radius, | |ListView.SetTextShadow2( radius, | ||
|ListView.SetTextSize( size,mode ) | | | |ListView.SetTextSize( size,mode ) | | | ||
- | |ListView.SetVisibility( | + | |ListView.SetVisibility( |
+ | |||
+ | ===== Available Options ===== | ||
+ | |||
+ | ^ Option | ||
+ | | AlumButton | ||
+ | | FontAwesome | ||
+ | | GreenButton | ||
+ | | Html | Use this option to display html formated code | | ||
+ | | OrangeButton | ||
+ | | WhiteGrad | ||
===== Sample callbacks ===== | ===== Sample callbacks ===== | ||
+ | |||
<code javascript> | <code javascript> | ||
function lst_OnTouch( title, body, type, index ) | function lst_OnTouch( title, body, type, index ) | ||
Line 59: | Line 265: | ||
} | } | ||
</ | </ | ||
+ | |||
<code javascript> | <code javascript> | ||
function lst_OnLongTouch( title, body, type, index ) | function lst_OnLongTouch( title, body, type, index ) | ||
Line 65: | Line 272: | ||
} | } | ||
</ | </ | ||
+ | |||
+ | <code javascript> | ||
+ | function lst_OnTouch( title, body, type, index ) | ||
+ | { | ||
+ | //Shows the index of the touched item | ||
+ | app.ShowPopup(index) | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | <code javascript> | ||
+ | function lst_OnTouch( item ) | ||
+ | { | ||
+ | //Shows the touched item | ||
+ | app.ShowPopup(item) | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ |