AppStatusBar Method (CLIENT)

PLB Web Only, 9.9B

The AppStatusBar method controls a mobile device OS statusbar the may exist at the top of the 'PlbWebCli' App viewport. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A CLIENT object.

return

Optional. A Numeric Variable that returns the success or failure of the method.

mode

Required. A Numeric Variable or decimal number that specifies a value that gives the action to be executed for the mobile device OS statusbar.

backcolor

Optional. A Character String Variable or string literal that specifies the background color of the mobile device OS statusbar.

Flags Affected: OVER, ZERO

Note the following:

1. This method only takes affect when a mobile device OS statusbar exists on an iOS, Android, or Windows RT phone mobile device.

2. See this link for more information on this cordova plugin:

 

https://github.com/apache/cordova-plugin-statusbar
 

3. The ZERO flag is always set when the {return} value is zero which indicates that the method execution was successful.

4. The OVER flag is set if the {return} variable is too small to receive the numeric result.

5. The {return} values are defined as follows:
    

Value	Meaning
0	The method executed successfully.
1	Cordova is not supported.
2	The method failed and extended error information can be retrieved using the CLIENT 'AppExtendedError' method.

 

6. The {mode} value is a numeric bitmask value that specifies the operation(s) to be executed for the mobile device OS statusbar. The {mode} values can be a combination of one or more of the following:

 

Keyword	Value	Meaning
AppStatusBarHide	1	Hide the mobile device OS statusbar.
AppStatusBarShow	2	Show the mobile device OS statusbar. By default, the mobile device OS statusbar is visible at the top of a 'PlbWebCli' App.
AppStatusBarOverlayOff	4	This is the default mode implemented by the 'PlbWebCli' App. The mobile device OS statusbar does not overlay the 'PlbWebCli' viewport
AppStatusBarOverlayOn	8	When this mode is set, the mobile device OS statusbar overlays the 'PlbWebCli' viewport.
AppStatusBarDefault	16	Set the default foreground color of the presentation for the mobile device OS statusbar. The default depends on the mobile device OS being used.
AppStatusBarLightContent	32	This mode enables a light foreground color type used by the mobile device OS statusbar.

 

7. The {backcolor} is a Character String Variable or string literal that specifies the background color of the mobile device OS statusbar. The {backcolor} string values can be specified in either one of the following formats:

 

Format One:

A hex string declared as '#RRGGBB'.

Format Two (Color names are case sensitive!):

A name of the background color used:

 

black

darkGray

lightGray

white

gray

red

green

blue

cyan

yellow

magenta

orange

purple

brown

Example Instructions using 'AppStatusBar'

See Also: CLIENT, Client Methods, Method Syntax