Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Foreground

Foreground Components are used as overlays for pages.

var uComps = require('u-components');
var uActions = require('u-actions');
var Action = uActions.Action;
new Action('Foreground Demo', foregroundDemo)
.register();
function foregroundDemo() {
    //Get a foreground component, given its name
    var foregroundComp = uComps.Foreground.getForegroundComponent('Navigation')
    foregroundComp.hide();
    //The foreground component can also be retrieved using 'get'
    var foregroundComp2 = uComps.Foreground.get('Navigation')
    foregroundComp2.hide();
    //Get the foreground on the current page
    var foregroundComp3 = uComps.Foreground.current;
    //Find the name of the foreground on the current page
    var foregroundName = uComps.Foreground.getForegroundName();
}

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

A list of all the components directly on the foreground.

current

current: Foreground

It returns the foreground of the current page.

new uActions.Action('hide foreground', hideForeground).register();
function hideForeground() {
    var f1=uComps.Foreground.current;
    f1.hide();
}
returns

Returns the foreground object or null.

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

The name of the foreground that shows in Umajin App Creator.

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.

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 the foreground object.

    new uActions.Action('Show Foreground', showForeground).register();
    function showForeground() {
        var f1=uComps.Foreground.getForegroundComponent('navigation_bar');
        f1.show();
    }

    Parameters

    • foregroundName: string

      the name of the foreground to get.

    Returns Foreground

    Returns the foreground object or null.

hide

  • hide(): void

  • Hides this foreground for the current page.

    var uActions = require('u-actions');
    new uActions.Action('Hide Foreground', hideForeground).register();
    function hideForeground() {
        var currentForeground = uComps.Foreground.current;
        currentForeground.hide();
    }

    Returns void

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

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

show

  • show(): void

  • Set this as the current foreground for the current page.

    var uActions = require('u-actions');
    new uActions.Action('Show Foreground', showForeground).register();
    function showForeground() {
        uComps.Foreground.get('navigation_bar').show();
    }

    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