State Progress Bar

Category Requires Version
User Interface API 19, Android 4.4 - 4.4.4 KitKat 1

Overview

A visible component that indicates the progress of an operation by highlighting the steps involved in that operation.

Events

Error Occurred

Event invoked when a error occurred.

Params
error Message Text

State Item Click

Event invoked when a state item was clicked.

Params
state Number Number
is Current State Boolean

Properties

All States Completed

Boolean ➖ Read Write - Blocks

If set to true all states are completed.

Animate Between States

Available as Advanced Property

Boolean Default: True ➖ Read Write - Designer Blocks

If set to true the states will use a animation when they changed.

Animation Duration

Number Default: 250 ➖ Read Write - Designer Blocks

Set the animation duration in milliseconds. Example: use 1000 for 1 second.

Background Color

Color Default: #444444FF  ➖ Read Write - Designer Blocks

Change the background color.

Current State Description Color

Color Default: #4CAF50FF  ➖ Read Write - Designer Blocks

Change the current state description color.

Current State Number

Number Default: 1 ➖ Read Write - Designer Blocks

Set the current state number.

Description Lines Spacing

Number Default: 5.0 ➖ Read Write - Designer Blocks

Set the description lines spacing.

Description Top Space Incrementer

Number Default: 10.0 ➖ Read Write - Designer Blocks

Set the description top space incrementer.

Elements From String

Text Default: Item 1, Item 2, Item 3, Item 4, Item 5 ➖ Write - Designer Blocks

The State Progress Bar elements specified as a string with the items separated by commas such as: Item 1, Item 2, Item 3, Item 4, Item 5. Each word before the comma will be an element in the list. You can add maximum 5 items.

Foreground Color

Color Default: #4CAF50FF  ➖ Read Write - Designer Blocks

Change the foreground color.

Height

Number ➖ Read Write - Blocks

Specifies the component's vertical height, measured in pixels.

Height Percent

Number ➖ Write - Blocks

Specifies the component's vertical height as a percentageof the height of its parent Component.

Justify Multiline Description

Available as Advanced Property

Boolean Default: True ➖ Read Write - Designer Blocks

If set to true justify multiline description is enabled.

Max Description Line

Number Default: 2 ➖ Read Write - Designer Blocks

Set the maximum description line.

Max State Number

Number Default: 5 ➖ Read Write - Designer Blocks

Set the maximum state number.

State Description Color

Color Default: #444444FF  ➖ Read Write - Designer Blocks

Change the state description color.

State Description Size

Number Default: 18.0 ➖ Read Write - Designer Blocks

Set the state description size.

State Description Typeface

Number Default: 0 ➖ Write - Designer

State Description Typeface Import

Available as Advanced Property

Text ➖ Write - Designer Blocks

Set a custom font for state description typeface.

State Line Thickness

Number Default: 10.0 ➖ Read Write - Designer Blocks

Set the state line thickness.

State Number Background Color

Color Default: #000000FF  ➖ Read Write - Designer Blocks

Change the state number background color.

State Number Foreground Color

Color Default: #FFFFFFFF  ➖ Read Write - Designer Blocks

Change the state number foreground color.

State Number Is Descending

Boolean Default: False ➖ Read Write - Designer Blocks

If set to true the state number is in descending order.

State Number Text Size

Number Default: 20.0 ➖ Read Write - Designer Blocks

Set the state number text size.

State Number Typeface

Number Default: 0 ➖ Write - Designer

State Number Typeface Import

Available as Advanced Property

Text ➖ Write - Designer Blocks

Set a custom font for state number typeface.

State Progress Bar Height

Number Default: 40.0 ➖ Read Write - Designer Blocks

Set the state progress bar height.

Visible

Boolean Default: True ➖ Read Write - Designer Blocks

Returns true iff the component is visible.

Width

Number ➖ Read Write - Blocks

Specifies the component's horizontal width, measured in pixels.

Width Percent

Number ➖ Write - Blocks

Specifies the component's horizontal width as a percentageof the Width of its parent Component.


Last update: January 27, 2020