Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScrollPanelComponent

The Scroll Panel Component provides a container that can have a group of other components displayed inside it.

var uComps = require('u-components');
var uActions = require('u-actions');
var Action = uActions.Action;
new Action('Scroll Panel Demo', scrollPanelDemo)
.addParameter('Scroll Panel', uActions.ParamType.SCROLL_PANEL)
.register();
function scrollPanelDemo(comp) {
    var scrollPanelComp = uComps.cast.toScrollPanel(comp);
    scrollPanelComp.scrollPosition = 100;
    scrollPanelComp.scrollFriction = 0.3;
    scrollPanelComp.scrollbarSize = 1.1;
}

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

alpha

alpha: number

The alpha transparency of the Component. Range from 0 to 100.

clippingType

clippingType: ClippingType

Clip the components contents using one of the options in ClippingType.

components

components: ComponentList

Access this Component's sub-components.

formEnabled

formEnabled: boolean

Whether or not is component is enabled for the parent form. Only relevant when inside a Form Component.

formFieldName

formFieldName: string

Label used to identify the field this Component belongs to in a form. Only relevant when inside a Form Component.

height

height: number

The height of the Component.

mask

mask: RectangleComponent | CircleComponent

Shape component to be used as a mask. Can be either a Rectangle or Circle Component.

name

name: string

Name of the component.

paddingEnd

paddingEnd: number

Padding to apply to the end of the list. Range 0 to 100. Default is 0.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.paddingEnd = 5;

parent

parent: Component

Access this Component's parent component.

passedFormValidation

passedFormValidation: boolean

Whether or not the Component has passed form validation. Only relevant when inside a Form Component.

scrollFriction

scrollFriction: number

Friction on scroll movement. Range from 0.01 to 1. Default 0.1.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.scrollFriction = 0.2;

scrollPosition

scrollPosition: number

The position within the scroll panel.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.scrollPosition = 25;

scrollPositionMax

scrollPositionMax: number

The maximum position to scroll to.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.scrollPositionMax = 150;

scrollVertically

scrollVertically: boolean

Items scroll vertically when true, horizontally when false.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.scrollVertically = true;

scrollbarDefaultFilename

scrollbarDefaultFilename: string

Scrollbar image.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.scrollbarDefaultFilename = 'scrollbar_v_9.png';

scrollbarDownFilename

scrollbarDownFilename: string

Scrollbar image when pressed.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.scrollbarDownFilename = 'scrollbar_v_bg_9.png';

scrollbarSize

scrollbarSize: number

Width of the scrollbar. Range 0.5 to 5. Default 1.5.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.scrollbarSize = 1;

scrollbarSliceBottom

scrollbarSliceBottom: number

Preserve the edges and corners of the scrollbar. Editing Nine Slice values will apply to the scrollbar default, and down images. Bottom Slice: Stop the bottom of the scrollbar from being stretched.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.scrollbarSliceBottom = 6;

scrollbarSliceLeft

scrollbarSliceLeft: number

Preserve the edges and corners of the scrollbar. Editing Nine Slice values will apply to the scrollbar default, and down images. Left Slice: Stop the left of the scrollbar from being stretched.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.scrollbarSliceLeft = 6;

scrollbarSliceRight

scrollbarSliceRight: number

Preserve the edges and corners of the scrollbar. Editing Nine Slice values will apply to the scrollbar default, and down images. Right Slice: Stop the right of the scrollbar from being stretched.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.scrollbarSliceRight = 6;

scrollbarSliceTop

scrollbarSliceTop: number

Preserve the edges and corners of the scrollbar. Editing Nine Slice values will apply to the scrollbar default, and down images. Top Slice: Stop the top of the scrollbar from being stretched.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.scrollbarSliceTop = 6;

showScrollbars

showScrollbars: boolean

When true, a scrollbar will appear within the Feed List Component.

var scrollPanelComp = uComps.cast.toScrollPanel(comp);
scrollPanelComp.showScrollbars = true;

type

type: string

Type of the component.

uniqueId

uniqueId: string

Unique ID of the component.

visible

visible: boolean

Whether or not the Component is visible.

width

width: number

The width of the Component.

x

x: number

The x position of the Component relative to its parent.

y

y: number

The y position of the Component relative to its parent.

Methods

emit

  • emit(eventType: string, data: Object): void

  • Call each callback that is registered for the given eventType, in the order they were registered, passing the supplied data to each.

    Parameters

    • eventType: string

      The type of the event to emit.

    • data: Object

      Data object to pass to each callback.

    Returns void

focus

  • focus(): void

  • Set the keyboard focus to this component.

    new uActions.Action('set focus', setFocus)
        .addParameter('text entry',uActions.ParamType.TEXT_ENTRY)
        .register();
    function setFocus(textEntry) {
        textEntry.focus();
    }

    Returns void

get

  • get(propertyName: string): any

  • Get a property by name.

    var uActions = require('u-actions');
    new uActions.Action('get fontsize',getFontSize).register();
    function getFontSize() {
        var text1=uPages.current.components.getText('Text 1');
        console.log(text1.get('font_size'));
    }

    Parameters

    • propertyName: string

      The name of the property to get.

    Returns any

    Returned value can be of any type, or even null.

on

  • on(eventType: string, callback: Function): void

  • Adds the callback function to the end of the listeners array for eventType.

    Parameters

    • eventType: string

      The type of the event.

    • callback: Function

      The callback function

    Returns void

refresh

  • refresh(): void

  • Refresh this component to force it to be re-rendered, or for its dynamic data to be updated.

    Returns void

reset

  • reset(): void

  • Resets theScroll Panel to the original settings.

    var scrollPanelComp = uComps.cast.toScrollPanel(comp);
    scrollPanelComp.reset();

    Returns void

set

  • set(propertyName: string, value: any): void
  • set(data: Object): void

  • Set a properties value by name.

    var uActions = require('u-actions');
    new uActions.Action('set text color',setTextColor).register();
    function setTextColor() {
        uPages.get('follow').components.getText('Text 1').set('font_color','0x0000FFFF');
    }

    Parameters

    • propertyName: string

      The name of the property to set.

    • value: any

      The value to set. Can be of any type.

    Returns void

  • Set a number properties at once.

    Parameters

    • data: Object

      Data object containing property name and value pairs to set on this component.

    Returns void

tween

  • tween(seconds: number, params: Object, type?: TweenType): void

  • Tween a component property over time.

    Parameters

    • seconds: number

      The number of seconds to tween for.

    • params: Object

      An objects that contains key/value pairs of the properties and values to tween.

    • Optional type: TweenType

      (Optional) Tween type can be any type from "Tween.type"

    Returns void