Class: QRCode

QRCode

The QR Code control is used to direct users to a website by using a QR scanner.  Typically, QR scanners are available for download on camera-enabled smart phones for free.  It is an easy and convenient way to get users to a particular website, since all they have to do is line up the scanner to the QR code, and they are taken to the website that has been configured on the QR Code control. A QRCode control provides the following configuration properties in Process Designer:

Formula

QR Code Formula: Formula/expression to use for calculating QR code value string

Appearance

Label Placement: Set the label placement for this control
{Top | Left}
string
Width: Width of the QRCode control string
Height: Height of the QRCode control string
Background Image URL: The background image URL for the QR control. string

Behavior

Error Correction Level: There are 4 error correction levels used for QR codes, with each one adding different amounts of backup data depending on how much damage the QR code is expected to suffer in its intended environment, and hence how much error correction may be required: Level L up to 7% damage Level M up to 15% damage Level Q up to 25% damage Level H up to 30% damage
{Level L - up to 7% damage | Level M - up to 15% damage | Level Q - up to 25% damage | Level H - up to 30% damage}
string

Events

On Load:
Description: This event is fired when the QRCode is loaded.
Example:
me.setQRCode("www.salientprocess.com")
On Change:
Description: This event is fired when the QRCode is changed.
Example:
${Text1}.setText(oldQRCode); ${Text2}.setText(newQRCode);
Context Variables newQRCode {string} oldQRCode {string}
Articles
QR Code

new QRCode()

This constructor is never used explicitly.

Extends

Members

Methods

Add/replace CSS class(es) for this control
Name Type Description
name string CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced string optional CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class.
Example
Button.addClass("green");

getBackgroundImageURL(){string}

Get configured backgroundImageURL for QRCode control
Returns:
Type Description
string Returns the URL text associated with the background image
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Returns:
Type Description
Object Value of bound data. undefined if the view has no data binding.
Example
var dec1 = MyDecimal.getData();

getErrorCorrectionLevel(){string}

Get configured errorCorrectionLevel for QRCode control
Returns:
Type Description
string Returns the error correction level

getLabel(){string}

Get label associated with QRCode control
Returns:
Type Description
string

getLabelPlacement(){string}

Get label placement for control. NOTE: This always returns the label placement as set, to avoid ambiguity always set the label placement using "T"|"L"
Returns:
Type Description
string

getQRCode(){string}

Get QRCode for QRCode control
Returns:
Type Description
string Returns the associated text/url

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

getWidth(){string}

Get configured width for QRCode control (including unit)
Returns:
Type Description
string Returns the width of the control
Hide this view/control
Name Type Description
collapseFlag boolean Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();

isLabelVisible(){boolean}

Get label visibility for QRCode control
Returns:
Type Description
boolean
Returns the valid status as last set by the setValid() method.
Returns:
Type Description
boolean Validity status. true if setValid(false, ...) was never called
Example
var valid = MyView.isValid();
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();
Propagates value change of control up through parent views
Name Type Description
event Event Value change event (usually an onchange event)
Returns:
Type Description
boolean True if a formula update was triggered on the control's parent, otherwise false
Example
MyView.propagateUp(event);
Only for formula-enabled views!
Explicitly triggers the re-evaluation of the formula for this view (if a formula has been specified). If the view is not formula-enabled, recalculate() does nothing.
Example
Text1.recalculate(); //If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time

setBackgroundImageURL(height)

Set backgroundImageURL of QRCode control
Name Type Description
height string backgroundImageURL
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Name Type Description
value Object Value of bound data. The type of this parameter must match the type of the bound data.
Example
MyView.setData("TEST"); //Updates bound data to the string 'TEST'
Enable/disable this view/control
Name Type Description
enabled boolean Enabled/read-only flag (true to enable view, false to disable/make read-only)
required boolean Enable/disable required field flag for control
Example
MyView.setEnabled(false); //Make MyView read-only

setErrorCorrectionLevel(level)

Set errorCorrectionLevel of QRCode control
Name Type Description
level string "L"=Level L | "M"="Level M | "Q"=Level Q | "H"=Level H

setHeight(height)

Set height of QRCode control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
height string the height of the control

setLabel(label)

Set label for QRCode control
Name Type Description
label string the label of the control

setLabelPlacement(placement)

Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
Name Type Description
placement string "T"|"TOP"=Top | "L"|"LEFT"=Left

setLabelVisible(flag)

Set label visibility for QRCode control
Name Type Description
flag boolean the visibility of the label

setQRCode(QRCode)

Set QRCode for QRCode control
Name Type Description
QRCode string the QRCode text
Flag this view/control as valid or invalid
Name Type Description
valid boolean Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)
errorText string Validation error text to show on the invalid-styled view
Example
MyView.setValid(false, "Please fix your data entry"); //Make MyView invalid
Show/hide this view/control
Name Type Description
visible boolean Visibility flag (true to show view, false to hide)
collapse boolean Set to true to collapse the control space when visible is set to false.
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"

setWidth(width)

Set width of QRCode control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string the width of the control
Show this view/control
Example
MyView.show();
Broadcasts the expression trigger for the specified view
Name Type Default Description
phase int bpmext.ui.PHASE_NORMAL optional The phase we are currently in
Example
MyView.triggerFormulaUpdates();