Back

CreateScroller

Hello World
Content:
- Methods

If you have much data to display which doesn't fit in the area availabe, you probably want to use a Scroller.

scr = app.CreateScroller( width, height, options ) → app object: Scroller

The options for the Scroller are the same as the LinearLayout fill options, which set how a Scroller sizes within it's parent:- “FillX”, “FillY” and “FillXY”. By default Scrollers will auto-size to wrap their contents.

To add other controls to your scroller you need to put them in a scroller layout first, which you can then add to the scroller object.

Example - Example

function OnStart()
{
    lay = app.CreateLayout( "Linear", "FillXY" );

    scroll = app.CreateScroller( 1.0, 1.0 );
    lay.AddChild( scroll );

    layScroll = app.CreateLayout( "Linear", "Left" );
    scroll.AddChild( layScroll );

    img = app.CreateImage( "/Sys/Img/Hello.png", 2.0, 2.0 );
    layScroll.AddChild( img );


    app.AddLayout( lay );
}
    Copy     Copy All       Run      

Methods

The following methods are available on the Scroller object:

Focus()
GetAbsHeight() → Number: integer
GetAbsWidth() → Number: integer
GetParent() → app object
GetPosition( options ) → Object: { left, top, right, bottom }
GetScrollX() → Number: fraction (0..1)
GetScrollY() → Number: fraction (0..1)
GetType() → String: “Scroller”
GetVisibility() → String: “Show” or “Hide” or “Gone”
Gone()
Hide()
Method( name, types, p1, p2, p3, p4 ) → all types
ScrollBy( x, y )
ScrollTo( x, y )
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: comma “,” separated: “FillX” or “FillY” or “FillXY”, “Horizontal” or “Vertical”, “NoScrollBar”, “ScrollFade”
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: “px” or “sp” or “dip” or “mm” or “pt”
String: “px” or “sp” or “dip” or “dp” or “mm” or “pt”
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, h, sw, sh, rot }
app object: Layout
List: boolean,char,byte,short,int,long,float,double,String,CharSequence,...
function( type )
function()
scr.AddChild
Add a layout to the scroller.
scr.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.
scr.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.
scr.ClearFocus
Removes the focus of the control so that the user no longer has immediate access to it.
scr.DestroyChild
Removes and releases a child object.
scr.Focus
Set the focus to the control so that the user can interact with it immediately.
scr.GetAbsHeight
Get the absolute height of the control in pixels.
scr.GetAbsWidth
Get the absolute width of the control in pixels.
scr.GetHeight
Get the height of the control as screen height relative float or in pixels with the px option.
scr.GetLeft
Get the distance from the control to the left parent border as width relative float or in pixels with the px option.
scr.GetParent
Returns the parent control object where the object was added to - commonly a layout.
scr.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.
scr.GetScrollX
Returns the horizontal scroll bar position.
scr.GetScrollY
Returns the vertical scroll bar position.
scr.GetTop
Get the distance from the control to the upper parent border as height relative float or in pixels with the px option.
scr.GetType
Returns the control class name.
scr.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
scr.GetWidth
Get the width of the control as screen width relative float or in pixels with the px option.
scr.Gone
Hides the control without consuming any more layout space as if it were never there.
scr.Hide
Hide the control but keep the layout space free.
scr.IsEnabled
Returns whether the control is currently useable by the user.
scr.IsOverlap
Returns whether the control overlaps with another by a given distance.
scr.IsVisible
Returns whether the control is currently visible to the user, ignoring overlaying controls.
scr.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.
scr.RemoveChild
Removes a scroller layout from the scroller.
scr.ScrollBy
Scrolls relatively to the current scroll bar positions.
scr.ScrollTo
Scrolls to a given fixed position.
scr.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)
scr.SetBackColor
Changes the background color of the control.
scr.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.
scr.SetBackGradientRadial
Define a radial color gradient for the background of control.
scr.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!
scr.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.
scr.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.
scr.SetMargins
Define a distance to other controls on each side of the control.
scr.SetPadding
Define distances that elements within the control are to maintain from the control borders.
scr.SetPosition
Defines the position and size for the control if the parent is an absolute layout.
scr.SetScale
Scales the control along with its contents by the factors passed to the function.
scr.SetSize
Change the size of the control in either screen relative values or in pixels if the px option was given.
scr.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
scr.Show
Set the visibility of the control to “Show”.
scr.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!