Back

CreateList

Hello World
Content:
- Methods

A manipulation of the DroidScript list object.

lst = MUI.CreateList( list, width, height, options ) → Object

Example - Basic

cfg.Light
cfg.MUI

function OnStart()
{
    color = MUI.colors.teal
    app.InitializeUIKit(color.teal)

    lay = MUI.CreateLayout("Linear", "FillXY,VCenter")

        var list = ["Downloads", "Images", "Videos"]
        lst = MUI.CreateList(list, 0.95, 0.4)
        lst.SetOnTouch(OnTouch)
        lay.AddChild(lst)

    app.AddLayout(lay)
}

function OnTouch(title)
{
    app.ShowPopup(title)
}
Copy All       Run      

Example - With-Icon

cfg.Light
cfg.MUI

function OnStart()
{
    color = MUI.colors.teal
    app.InitializeUIKit(color.teal)

    lay = MUI.CreateLayout("Linear", "FillXY")

        var list = ["Downloads:[fa-cloud-download]", "Images:[fa-image]", "Videos:[fa-youtube-play]"]
        lst = MUI.CreateList(list, 0.95, 0.4)
        lst.SetOnTouch(OnTouch)
        lay.AddChild(lst)

    app.AddLayout(lay)
}

function OnTouch(title)
{
    app.ShowPopup(title)
}
Copy All       Run      

Example - Dark With Body & Icon

cfg.Dark
cfg.MUI

function OnStart()
{
    color = MUI.colors.teal
    app.InitializeUIKit(color.teal)

    lay = MUI.CreateLayout("Linear", "FillXY,VCenter")

        var list = [
            "Downloads:Some body text:[fa-cloud-download]",
            "Images:Some body text:[fa-image]",
            "Videos:Some body text:[fa-youtube-play]"
        ]
        lst = MUI.CreateList(list, 0.95, 0.4)
        lst.SetOnTouch(OnTouch)
        lay.AddChild(lst)

    app.AddLayout(lay)
}

function OnTouch(title, body)
{
    app.ShowPopup(title+" : "+body)
}
Copy All       Run      

Methods

The following methods are available on the List object:

Focus()
GetAbsHeight() → Number: integer
GetAbsWidth() → Number: integer
GetHeight( options ) → Number
GetItem( title ) → Object
GetItemByIndex( index ) → Object
GetLeft( options ) → Number
GetLength() → Number: integer
GetList( delim ) → Object
GetParent() → app object
GetPosition( options ) → Object: { left, top, right, bottom }
GetTextSize( mode ) → Number
GetTop( options ) → Number
GetType() → String: “List”
GetVisibility() → String: “Show” or “Hide” or “Gone”
GetWidth( options ) → Number
Gone()
Hide()
IsEnabled() → Boolean
IsOverlap( obj, depth ) → Boolean
IsVisible() → Boolean
Method( name, types, p1, p2, p3, p4 ) → all types
SetScale( x, y )
Show()
Boolean
app object
Number
String
unknown
Number: factor
Number: fraction (0..1)
Number: integer
Number: milliseconds
Number: -180..180
Number: -100..100
Number: 0..100
Number: 0..0.99 or 1..256
String:
  hexadecimal: “#rrggbb”, “#aarrggbb”
  colourName: “red”, “green”, ...
String: comma “,” separated
String: path to file ( “/absolute/...” or “relative/...” )
String: “NewsPaper” or “Jelly” or “Flash” or “RubberBand” or “Swing” or “TaDa” or “Bounce” or “Fall” or “FallRotate” or
String: “px”
String: “screen”, “px”
String: “left-right” or “right-left” or “top-bottom” or “bottom-top” or “bl-tr” or “br-tl” or “tl-br” or “tr-bl”
String: “repeat”
String: “Add” or “Multiply” or “clear” or “darken” or “lighten” or “overlay” or “screen” or “xor” or “src_in” or “src_out” or “src_atop” or “src_over” or “dst_in” or “dst_out” or “dst_atop” or “dst_over”
String: “start” or “middle” or “end”
String: “px” or “sp” or “dip” or “mm” or “pt”
String: “px” or “sp” or “dip” or “dp” or “mm” or “pt”
String: “px” or “dip” or “sp” or “mm” or “pt” or pl or ps
String: “Show” or “Hide” or “Gone”
String: “Linear.None” or “Quadratic.In/Out” or “Cubic.In/Out” or “Quartic.In/Out” or “Quintic.In/Out” or “Sinusoidal.In/Out” or “Exponential.In/Out” or “Circular.In/Out” or “Elastic.In/Out” or “Back.In/Out” or “Bounce.In/Out”
Object: { x, y, w, w, sw, sh, rot }
List: boolean,char,byte,short,int,long,float,double,String,CharSequence,...
function( type )
function( src )
function()
lst.AddItem
Add item
lst.AdjustColor
Adjust the visual color effect of the control by setting the Hue (by angle in degrees in a color circle), the saturation, brightness and contrast of the control.
lst.Animate
Animates the control.

There are
    “in”-Animations which are used to show objects from hidden state
    “out”-animations which are used to hide objects in visible state and
    “static”-animations which keep the visible state.
lst.ClearFocus
Removes the focus of the control so that the user no longer has immediate access to it.
lst.Focus
Set the focus to the control so that the user can interact with it immediately.
lst.GetAbsHeight
Get the absolute height of the control in pixels.
lst.GetAbsWidth
Get the absolute width of the control in pixels.
lst.GetHeight
Get the height of the control as screen height relative float or in pixels with the px option.
lst.GetItem
Get item
lst.GetItemByIndex
Get item by index
lst.GetLeft
Get the distance from the control to the left parent border as width relative float or in pixels with the px option.
lst.GetLength
Get length
lst.GetList
Get list
lst.GetParent
Returns the parent control object where the object was added to - commonly a layout.
lst.GetPosition
Returns data about the position and size of the control.
If the screen option is given the position on the screen will be returned. Otherwise relative to the parent control.
The px options turns the relative values into pixels.
lst.GetTextSize
Returns the current size of the contained text. If the px option is given the size will be retured in pixels.
lst.GetTop
Get the distance from the control to the upper parent border as height relative float or in pixels with the px option.
lst.GetType
Get type
lst.GetVisibility
Returns the current visibility state of the control. The Values are:
Show: visible
Hide: invisible but still consuming space
Gone: invisible and not consuming space
lst.GetWidth
Get the width of the control as screen width relative float or in pixels with the px option.
lst.Gone
Hides the control without consuming any more layout space as if it were never there.
lst.Hide
Hide the control but keep the layout space free.
lst.InsertItem
Insert item
lst.IsEnabled
Returns whether the control is currently useable by the user.
lst.IsOverlap
Returns whether the control overlaps with another by a given distance.
lst.IsVisible
Returns whether the control is currently visible to the user, ignoring overlaying controls.
lst.Method
Allows access to other functions defined on the object in Java via reflection.

Note: This function is a premium feature. Please consider subscribing to Premium to use this feature and support DroidScript in its further development.
lst.RemoveAll
Remove all
lst.RemoveItem
Remove item
lst.RemoveItemByIndex
Remove item by index
lst.ScrollToItem
Scroll to item
lst.ScrollToItemByIndex
Scroll to item by index
lst.SelectItem
Select item
lst.SelectItemByIndex
Select item by index
lst.SetBackAlpha
Set the transparency of the background by an alpha value between 0 (no transparency) and 0.99 (full transparent) or 1 (no transparency) and 256 (full transparent)
lst.SetBackColor
Changes the background color of the control.
lst.SetBackGradient
Define the background color of the control with a gradient. The default gradient direction is from top to bottom, but you can change it from left to right and the reversed versions of course.
lst.SetBackGradientRadial
Define a radial color gradient for the background of control.
lst.SetBackground
Changes the background to an image which can be repeated using the repeat option.
An image which is often used with that option is '/res/drawable/pattern_carbon' - try it out!
lst.SetColorFilter
Adjust the visual color effect with a color and a given BlendMode. More information about BlendMode can be found in the Android Developer page.
lst.SetColumnWidths
Set column widths
lst.SetDivider
Set divider
lst.SetEllipsize
Will cause the inner text to be broken with ... at the start or the end if it cannot fit in the control.
lst.SetEllipsize1
Set ellipsize1
lst.SetEllipsize2
Set ellipsize2
lst.SetEnabled
En/Disable the control physically and visually so that the user can/can not access the control. Events like OnTouch will still be fired.
lst.SetFontFile
Change the font style by defining a font file.
lst.SetHiTextColor1
Set hi text color1
lst.SetHiTextColor2
Set hi text color2
lst.SetIconMargins
Set icon margins
lst.SetIconSize
Set icon size
lst.SetItem
Set item
lst.SetItemByIndex
Set item by index
lst.SetList
Set list
lst.SetMargins
Define a distance to other controls on each side of the control.
lst.SetOnLongTouch
Define a callback function which is called when the object has been long pressed.
lst.SetOnTouch
Define a callback function that is called when the user touches the control.
lst.SetPadding
Define distances that elements within the control are to maintain from the control borders.
lst.SetPosition
Defines the position and size for the control if the parent is an absolute layout.
lst.SetScale
Scales the control along with its contents by the factors passed to the function.
lst.SetSize
Change the size of the control in either screen relative values or in pixels if the px option was given.
lst.SetTextColor
Change the text color of the contained text.
lst.SetTextColor1
Set text color1
lst.SetTextColor2
Set text color2
lst.SetTextMargins
Set text margins
lst.SetTextShadow
Define a shadow displayed around the control.
The sun is always shining so there has to be one. Always.
lst.SetTextShadow1
Set text shadow1
lst.SetTextShadow2
Set text shadow2
lst.SetTextSize
Change the size of the contained text.
lst.SetTextSize1
Set text size1
lst.SetTextSize2
Set text size2
lst.SetVisibility
Change the visibility of the control to one of the available modes:
Show: visible
Hide: invisible but still consuming space
Gone: invisible and not consuming space
lst.Show
Set the visibility of the control to “Show”.
lst.Tween
Performs an animation on the control.
The target object is for the position, size and rotation that the control has at the end of the animation.

The type specifies the behavior and the speed of the animation. Separated by a dot, you must also specify whether you want to apply this behavior to the beginning (In), end (Out), or to both (InOut) times of the animation.

With the amount of repeats you can control how many times you want to play the animation.

If you have jojo activated, the animation will alternate between forward and backward playback, so that if the repetition value is odd, the control will be at the start position again at the end of the animation.

Finally the callback function will be called after the animation has finished. Well, it's about time!