User Tools

Site Tools


built_in:lists

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
built_in:lists [2015/03/07 18:39]
octazid [Methods]
built_in:lists [2019/09/01 00:10] (current)
Line 1: Line 1:
 ====== Lists ====== ====== Lists ======
-===== Create ===== + 
-Create List objects using the CreateList method of the app object:+//(Information and examples taken from the DroidScript documentation)// 
 + 
 +===== Description ===== 
 +Create List objects using the **CreateList** method of the **[[built_in:app|app]]** object:
 <code>lst = app.CreateList( list, width, height, options );</code> <code>lst = app.CreateList( list, width, height, options );</code>
-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( "Linear", "VCenter,FillXY" ); 
 + 
 +  lst = app.CreateList( "Fred,Bill,Jim", 0.8, 0.4 ); 
 +  lst.SetOnTouch( lst_OnTouch ); 
 +  lst.SetOnLongTouch( lst_OnLongTouch ); 
 +  lay.AddChild( lst ); 
 + 
 +  app.AddLayout( lay ); 
 +
 + 
 +function lst_OnTouch( item ) 
 +
 +  app.ShowPopup( "Item = " + item, "Short" ); 
 +
 +function lst_OnLongTouch( item ) 
 +
 +  app.ShowPopup( "Long Touch = " + item, "Short" ); 
 +
 +</code> 
 + 
 +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/pattern or background gradient for the List using the **SetBackground** and **SetBackGradient** functions. 
 + 
 +====Example - Gray on white==== 
 +<code javascript> 
 +function OnStart() 
 +
 +  lay = app.CreateLayout( "Linear", "VCenter,FillXY" ); 
 + 
 +  lst = app.CreateList( "Fred,Bill,Jim", 0.8, 0.4 ); 
 +  lst.SetTextColor( "#ff666666" ); 
 +  lst.SetBackColor( "#ffffffff" ); 
 +  lst.SetOnTouch( lst_OnTouch ); 
 +  lay.AddChild( lst ); 
 + 
 +  app.AddLayout( lay ); 
 +
 + 
 +function lst_OnTouch( item ) 
 +
 +  app.ShowPopup( "Touched Item = " + item ); 
 +
 +</code> 
 + 
 +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 ':' (colon) character. If you need to use a colon character in your item text then use this character sequence: ^c^. 
 + 
 +You can have one icon and one or two lines of text using the following formats: 
 + 
 +  * title : icon 
 +  * title : body : icon 
 + 
 +The available icons types are displayed using the following key words: 
 + 
 +  * "folder" 
 +  * "audiofolder" 
 +  * "photofolder" 
 +  * "videofolder" 
 +  * "audio" 
 +  * "photo" 
 +  * "video" 
 +  * "playlist"  
 + 
 +You can also use resource images or images from your sdcard instead of the keywords, for example:- "Img/MyIcon.png" or "/sdcard/images/image1.jpg" 
 +   
 + 
 +====Example - Title + Icon==== 
 +<code javascript> 
 +function OnStart() 
 +
 +  lay = app.CreateLayout( "Linear", "VCenter,FillXY" ); 
 + 
 +  var data = "Folder:folder,Audio:audio,Photo:photo,Video:video"; 
 +  lst = app.CreateList( data, 0.8, 0.4 ); 
 +  lst.SetOnTouch( lst_OnTouch ); 
 +  lay.AddChild( lst ); 
 + 
 +  app.AddLayout( lay ); 
 +
 + 
 +function lst_OnTouch( item ) 
 +
 +  app.ShowPopup( "Touched Item = " + item ); 
 +
 +</code> 
 + 
 +====Example - Title + Body==== 
 +<code javascript> 
 +function OnStart() 
 +
 +  lay = app.CreateLayout( "Linear", "VCenter,FillXY" ); 
 + 
 +  var data = "The Hobbit:Author^c^ J.R.R. Tolkien:null"; 
 +  data += ",Watership Down:Author^c^ Richard Adams:null"; 
 +  lst = app.CreateList( data, 0.8, 0.4 ); 
 +  lst.SetOnTouch( lst_OnTouch ); 
 +  lay.AddChild( lst ); 
 + 
 +  app.AddLayout( lay ); 
 +
 + 
 +function lst_OnTouch( item ) 
 +
 +  app.ShowPopup( "Touched Item = " + item ); 
 +
 +</code> 
 + 
 +You can also create lists items that look like **buttons** by using one of the following options:  
 + 
 +  * "AlumButton" 
 +  * "GreenButton" 
 +  * "OrangeButton" 
 + 
 +====Example - Orange Buttons==== 
 +<code javascript> 
 +function OnStart() 
 +
 +  lay = app.CreateLayout( "Linear", "VCenter,FillXY" ); 
 + 
 +  var data = "Button 1,Button 2,Button 3,Button 4"; 
 +  lst = app.CreateList( data, 0.8, 0.8, "OrangeButton" ); 
 +  lst.SetBackColor( "#ffffff" ); 
 +  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( "Touched Item = " + item ); 
 +}  
 +</code> 
 + 
 +Or create lists with **Gradient** backgrounds like this: 
 + 
 +====Example - Gradient Background==== 
 +<code javascript> 
 +function OnStart() 
 +
 +  lay = app.CreateLayout( "Linear", "VCenter,FillXY" ); 
 + 
 +  var data = ""; 
 +  for( var i=1; i<=30; i++) 
 +  { 
 +    if( i>1 ) data += ","; 
 +    data += "Item "+i+":Details for item "+i+":null"; 
 +  } 
 +  lst = app.CreateList( data, 1, 1, "WhiteGrad" ); 
 +  lst.SetTextColor1( "#ff555558"); 
 +  lst.SetTextColor2( "#ff555558" ); 
 +  lst.SetTextMargins( 0.04, 0, 0, 0 ); 
 +  lst.SetOnTouch( lst_OnTouch ); 
 +  lay.AddChild( lst ); 
 + 
 +  app.AddLayout( lay ); 
 +
 + 
 +function lst_OnTouch( item ) 
 +
 +  app.ShowPopup( "Touched Item = " + item ); 
 +
 +</code> 
 + 
 + 
 +====Example - HTML Font Color==== 
 +<code javascript> 
 +function OnStart() 
 +
 +    //Create a layout with objects vertically centered. 
 +    lay = app.CreateLayout( "linear", "VCenter,FillXY" );     
 + 
 +    //Create a list and add it to layout. 
 +    var data = 
 +    "<font color='#ff0000'>Red</font>,"
 +    "<font color='#00ff00'>Green</font>,"
 +    "<font color='#0000ff'>Blue</font>" 
 +    lst = app.CreateList( data,-1,-1,"html" ); 
 +    lay.AddChild( lst ); 
 +     
 +    //Add layout to app.     
 +    app.AddLayout( lay ); 
 +
 +</code> 
 +---- 
 ===== Methods ===== ===== Methods =====
 Some controls use the same methods.\\ Some controls use the same methods.\\
 For examples of the **[[same methods]]** look here. For examples of the **[[same methods]]** look here.
-^Method ^Description ^ +^ Method                                                           ^ Description                                                                       
-|ListView.AddItem( title,body,image ) | | +List.AddItem( title,body,image )                                                                                                               
-|ListView.Destroy() | | +List.GetAbsHeight()                                                                                                                            
-|ListView.GetAbsHeight() | | +List.GetAbsWidth()                                                                                                                             
-|ListView.GetAbsWidth() | | +List.GetHeight()                                                                                                                               
-|ListView.GetHeight() | | +List.GetItemByIndexindex                                                                                                                   
-|ListView.GetList( delim ) | string = list.GetList(",");+List.GetLength()                                                                                                                               | 
-|ListView.GetPosition() | | +| List.GetList( delimeter                                    | string = list.GetList(","); \\ List.GetList() with no params returns object list  
-|ListView.GetTextSize( mode ) | | +List.GetPosition()                                                                                                                             
-|ListView.GetType() | | +List.GetTextSize( mode )                                                                                                                       
-|ListView.GetVisibility() | | +List.GetType()                                                                                                                                 
-|ListView.GetWidth() | | +List.GetVisibility()                                                                                                                           
-|ListView.Release() | | +List.GetWidth()                                                                                                                                
-|ListView.RemoveItem( title ) | | +List.InsertItem(index,title,body,image                                                                                                       
-|ListView.ScrollToItem( name,body ) | | +List.RemoveAll()                                                                                                                               | 
-|ListView.SelectItem( title,body,scrollTo ) | | +| List.RemoveItem( title )                                     |                                                                                   | 
-|ListView.SelectItemByIndex( index,scroll ) | index is a number, \\ scroll could be true or false | +| List.RemoveItemByIndex( index )                                                                                                                
-|ListView.SetBackColor( color ) | | +List.ScrollToItem( name,body )                                                                                                                 
-|ListView.SetBackGradient( color1,color2,color3,p4,p5,p6,p7 ) | | +List.ScrollToItemByIndex( index )                            |                                                                                   | 
-|ListView.SetBackGradientRadial( x,y,r,color1,color2,color3,p7 ) | | +| List.SelectItem( title,body,scrollTo )                                                                                                         
-|ListView.SetBackground( imagefile,options ) | | +List.SelectItemByIndex( index,scroll )                       | index is a number, \\ scroll could be true or false                               
-|ListView.SetDivider( height,color ) | | +List.SetBackColor( colorCode                                                                                                                 
-|ListView.SetEllipsize( mode ) | | +List.SetBackGradient( color1,color2,color3,p4,p5,p6,p7 )                                                                                       
-|ListView.SetEllipsize1( mode ) | | +List.SetBackGradientRadial( x,y,r,color1,color2,color3,p7 )                                                                                    
-|ListView.SetEllipsize2( mode ) | | +List.SetBackground( imagefile,options )                                                                                                        
-|ListView.SetFontFile( file ) | | +List.SetDivider( height,color )                                                                                                                
-|ListView.SetHiTextColor1( color ) | | +List.SetEllipsize( mode )                                                                                                                      
-|ListView.SetHiTextColor2( color ) | | +List.SetEllipsize1( mode )                                                                                                                     
-|ListView.SetItem( title,newTitle,newBody,newImage ) | | +List.SetEllipsize2( mode )                                                                                                                     
-|ListView.SetList( list,delimeter ) | | +List.SetFontFile( file )                                                                                                                       
-|ListView.SetMargins( left,top,right,bottom ) | | +List.SetHiTextColor1( colorCode                                                                                                              
-|ListView.SetOnLongTouch( callback ) |sets the function called when list is long-touched | +List.SetHiTextColor2( colorCode                                                                                                              
-|ListView.SetOnTouch( callback ) |sets the function called when list is touched | +List.SetItem( title,newTitle,newBody,newImage )                                                                                                | 
-|ListView.SetPadding( left,top,right,bottom ) | | +| List.SetItemByIndex( index,newTitle,newBody,newImage )                                                                                         
-|ListView.SetPosition( left,top,width,height ) | | +List.SetList( list,delimeter )                                                                                                                 
-|ListView.SetScale( x,y ) | | +List.SetMargins( left,top,right,bottom )                                                                                                       
-|ListView.SetSize( width,height ) | | +List.SetOnLongTouch( callback )                              | sets the function called when list is long-touched                                
-|ListView.SetTextColor( color ) | | +List.SetOnTouch( callback )                                  | sets the function called when list is touched                                     
-|ListView.SetTextColor1( color ) | | +List.SetPadding( left,top,right,bottom )                                                                                                       
-|ListView.SetTextColor2( color ) | | +List.SetPosition( left,top,width,height )                                                                                                      
-|ListView.SetTextMargins( left,top,right,bottom ) | | +List.SetScale( x,y )                                                                                                                           
-|ListView.SetTextShadow( radius,dx,dy,color ) | | +List.SetSize( width,height )                                                                                                                   
-|ListView.SetTextShadow1( radius,dx,dy,color ) | | +List.SetTextColor( colorCode                                                                                                                 
-|ListView.SetTextShadow2( radius,dx,dy,color ) | | +List.SetTextColor1( colorCode                                                                                                                
-|ListView.SetTextSize( size,mode ) | | +List.SetTextColor2( colorCode                                                                                                                
-|ListView.SetVisibility( ShowHide ) | | +List.SetTextMargins( left,top,right,bottom )                                                                                                   
 +List.SetTextShadow( radius,dx,dy,color )                                                                                                       
 +List.SetTextShadow1( radius,dx,dy,color )                                                                                                      
 +List.SetTextShadow2( radius,dx,dy,color )                                                                                                      
 +List.SetTextSize( size,mode )                                                                                                                  
 +List.SetVisibility( ShowHide )                                                                                                                 |
  
-===== Options =====+===== Available Options =====
  
-^Option ^Description ^ +^ Option        ^ Description                                                 ^ 
-|FontAwesome|Use this to display Icons \\ from this inbuilt font|+| AlumButton    | Use this to display the list \\ as buttons                  | 
 +| FontAwesome   | Use this to display Icons \\ from this inbuilt font         | 
 +| GreenButton   | Use this to display the list \\ as buttons                  | 
 +| Html          | Use this option to display html formated code               | 
 +| OrangeButton  | Use this to display the list \\ as buttons                  | 
 +| WhiteGrad     | Use this to display the list \\ with a gradient background  |
  
 ===== Sample callbacks ===== ===== Sample callbacks =====
 +
 <code javascript> <code javascript>
 function lst_OnTouch( title, body, type, index )  function lst_OnTouch( title, body, type, index ) 
Line 66: Line 270:
  
 </code> </code>
 +
 <code javascript> <code javascript>
 function lst_OnLongTouch( title, body, type, index )  function lst_OnLongTouch( title, body, type, index ) 
Line 72: Line 277:
 } }
 </code> </code>
 +
 <code javascript> <code javascript>
 function lst_OnTouch( title, body, type, index ) function lst_OnTouch( title, body, type, index )
Line 79: Line 285:
 } }
 </code> </code>
 +
 <code javascript> <code javascript>
 function lst_OnTouch( item ) function lst_OnTouch( item )
Line 86: Line 293:
 } }
 </code> </code>
 +
 +----
 +
built_in/lists.1425753540.txt.gz · Last modified: 2015/03/08 02:39 (external edit)