Moscrif API Docs for: 2012q3
Show:

Moscrif.ScrollView Class

Library: ui

A Scroll View creates a scrollable part of content. The scroll view contains more views which can scroll vertically or horizontally.

Methods

this

(
  • [name=null]
)
ScrollView

Create new ScrollView object.

Parameters:

  • [name=null] String optional

    Name of object. Use null for unnamed control.

Returns:

ScrollView:

Example:

var layout = new Moscrif.StackLayout();
layout.align = #start;
layout.pack = #start;
layout.orientation = #vert;

container = new Moscrif.ScrollView("container");
container.scrollMode = #vert;
container.dockContent = #top;
container.layout = layout;
…. left, top, width, height ….
app.add(container);

add

(
  • view
  • [order]
)
ScrollView chainable

Function adds existing view object into ScrollView.

Parameters:

  • view View

    View to add. View/ScrollView/TextView are supported.

  • [order] Symbol optional

    Default is.

        * #front
    * #back

Returns:

ScrollView: Return instance of itself.

find

(
  • name
)
View

Search for child view, which name is same as name from function's param.

Parameters:

  • name String

    Name of the child view to search

Returns:

View: Instance of found child view, or null if not found.

Example:

var container = new Moscrif.ScrollView("container");

var itemA = new Moscrif.View("itemA");
container.add(itemA);

var itemB = new Moscrif.View("itemB");
container.add(itemB);
…...
// find view by name
var item = container.find("itemA");
// detach them
item.detach();

getChildrenBounds

() Multivalue

Get children bounds

Returns:

Multivalue:

getChildrenSize

() Multivalue

Get children size

Returns:

Multivalue:

hasFocus

() Boolean

Returns true if ScrollView has focus. Otherwise, function returns false.

Returns:

Boolean:

invalidate

(
  • [left]
  • [top]
  • [right]
  • [bottom]
)

This function ensure redrawing a rectangle, determined by parameters. If no parameters are set, whole object will be redraw. Redrawing manages the function, which is set to onDraw event.

Parameters:

  • [left] Boolean optional

    Left border of the rectangle to be invalidated.

  • [top] Boolean optional

    Top border of the rectangle to be invalidated.

  • [right] Boolean optional

    Right border of the rectangle to be invalidated.

  • [bottom] Boolean optional

    Bottom border of the rectangle to be invalidated.

performLayout

() Window

Perform (force) layer calculation.

Returns:

Window:

removeAll

() chainable

Removes all views from the object.

resumeLayout

() Window

Resume layer's recalculating.

Returns:

Window:

Example:

list.native.suspendLayout();
for (var i = 0; i <100; i++) {
    items[i] = new ListViewItem(null,null,i.toString());
    list.add(items[i]);
}
list.native.resumeLayout();

scrollBy

(
  • dx
  • dy
)
ScrollView chainable

Function scrolls elements by coordinates (dx and dy). However, this function scrolls only in adjusted set scroll mode (horizontal or vertical).

Parameters:

  • dx View

    Horizontal coordinate.

  • dy View

    Vertical coordinates.

Returns:

ScrollView:

scrollBy

(
  • x
  • y
)
ScrollView

Function scrolls elements to coordinates (x and y). However, this function scrolls only in adjusted set scroll mode (horizontal or vertical).

Parameters:

  • x View

    Horizontal coordinate.

  • y View

    Vertical coordinates.

Returns:

ScrollView:

setFocus

() Boolean

Function sets focus to the object.

Returns:

Boolean:

suspendLayout

() Window

Pause layer's recalculating. This function is useful when a lot of items are inserted into view in short time. When resumeLayout is called, all items will be inserted at once .

Returns:

Window:

Example:

list.native.suspendLayout();
for (var i = 0; i <100; i++) {
    items[i] = new ListViewItem(null,null,i.toString());
    list.add(items[i]);
}
list.native.resumeLayout();

Properties

dockContent

Symbol

Dock Content:

  • #left-top
  • #top
  • #right-top
  • #right
  • #right-bottom
  • #bottom
  • #left-bottom
  • #left

focusable

Boolean

Ability to have a focus.

height

Integer

Height of the object (in pixels).

isScrolling

Boolean

Returns true if scroll is in progress.

layout

Integer

StackLayout used to organize elements into the object.

left

Integer

X - coordinates of left border.

name

String

Name of the object.

scrollMode

Symbol

Scroll Mode:

  • #horz
  • #vert
  • #both
  • #none

scrollX

Integer

Gets horizontal scroll.

scrollY

Integer

Gets verical scroll.

stretch

Symbol

Gets or sets if the view's width is stretchable.

  • #both

top

Integer

Y - coordinates of left border.

visible

Boolean

Visibility of the object. True = visible, false = invisible. Default is visible.

width

Integer

Width of the object (in pixels).

Events

onChar

This event is raised by release an UNICODE character key.

Event Payload:

  • sender Object

    Object which caused this event.

  • key Integer

    Code from unicode table.

onDraw

This event occurs, when it is necessary to redraw object. onDraw event is usually managed by skin.

Event Payload:

  • sender Object

    Object which caused this event.

  • canvas Canvas

    Canvas object enabling drawing to the TextView.

onKeyPressed

This event is raised by press the key.

Event Payload:

  • sender Object

    Object which caused this event.

  • key Symbol

    Pressed key.

    • #leftSoftKey
    • #rightSoftKey
    • #home
    • #back
    • #send
    • #end
    • #num0 - #num9
    • #star - the * key
    • #hash - the # key
    • #up
    • #down
    • #left
    • #right
    • #ok
    • #volumeUp
    • #volumeDown
    • #power
    • #camera

onKeyReleased

This event is raised by release the key.

Event Payload:

  • sender Object

    Object which caused this event.

  • key Symbol

    Pressed key.

    • #leftSoftKey
    • #rightSoftKey
    • #home
    • #back
    • #send
    • #end
    • #num0 - #num9
    • #star - the * key
    • #hash - the # key
    • #up
    • #down
    • #left
    • #right
    • #ok
    • #volumeUp
    • #volumeDown
    • #power
    • #camera

onPointerDragged

Called when touch (click) is moved.

Event Payload:

  • sender Object

    Object which caused this event.

  • x Integer

    X coordinates of pointer.

  • y Integer

    Y coordinates of pointer.

onPointerPressed

Called when touch (click) is stared.

Event Payload:

  • sender Object

    Object which caused this event.

  • x Integer

    X coordinates of pointer.

  • y Integer

    Y coordinates of pointer.

onPointerReleased

Called when touch (click) is finished.

Event Payload:

  • sender Object

    Object which caused this event.

  • x Integer

    X coordinates of pointer.

  • y Integer

    Y coordinates of pointer.

onProcess

Callback function, which is which is called from the object every 25ms.

onResize

Occurs when the control is resized.

Event Payload:

  • sender Object

    Object which caused this event.

  • width Integer

    New width of resized view.

  • height Integer

    New height of resized view.