Methods

addClass
getBackgroundImageURL
getData
getErrorCorrectionLevel
getLabel
getLabelPlacement
getLabelWidth
getQRCode
getType
getWidth
hide
isBound
isEnabled
isLabelVisible
isValid
isVisible
propagateUpValueChange
recalculate
setBackgroundImageURL
setData
setEnabled
setErrorCorrectionLevel
setHeight
setLabel
setLabelPlacement
setLabelVisible
setLabelWidth
setQRCode
setValid
setVisible
setWidth
show
triggerFormulaUpdates

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
QR Code
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.
Appearance
Label placement: The label position.
{Top | Left}		 LabelPlacement
Label width: The width of the label in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. 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\:\r\nLevel L up to 7% damage\r\nLevel M up to 15% damage\r\nLevel Q up to 25% damage\r\nLevel 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}		 QRErrorCorrectionLevel
Formula
QR code formula: The formula or expression to calculate the QR code value. 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}
Extends:
com.ibm.bpm.coach.CoachView
Methods:
Inherited addClass(name, [replaced])
Add/replace CSS class(es) for this control
NameTypeDefaultDescription
name{string}CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced{string}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() Returns: {string}
Get configured backgroundImageURL for QRCode control
Inherited getData() Returns: {Object}
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Example
var dec1 = MyDecimal.getData();
getErrorCorrectionLevel() Returns: {string}
Get configured errorCorrectionLevel for QRCode control
getLabel() Returns: {string}
Get label associated with QRCode control
getLabelPlacement() Returns: {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"
getLabelWidth() Returns: {string}
Get label width of QRCode control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
getQRCode() Returns: {string}
Get QRCode for QRCode control
getType() Returns: {string}
Get descriptive string representing the type of control
getWidth() Returns: {string}
Get configured width for QRCode control (including unit)
Inherited hide(collapseFlag)
Hide this view/control
NameTypeDefaultDescription
collapseFlag{boolean}Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Inherited isBound() Returns: {boolean}
Indicates bound status of control.
Inherited isEnabled() Returns: {boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled();
isLabelVisible() Returns: {boolean}
Get label visibility for QRCode control
Inherited isValid() Returns: {boolean}
Returns the valid status as last set by the setValid() method.
Example
var valid = MyView.isValid();
Inherited isVisible() Returns: {boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible();
Inherited propagateUpValueChange(event) Returns: {boolean}
Propagates value change of control up through parent views
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);
Inherited recalculate()
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
NameTypeDefaultDescription
height{string}backgroundImageURL
Inherited setData(value)
Set/update bound data associated this view/control. Only works for views/controls with bound data.

Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options
NameTypeDefaultDescription
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'
Inherited setEnabled(enabled, required)
Enable/disable this view/control
NameTypeDefaultDescription
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
NameTypeDefaultDescription
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)
NameTypeDefaultDescription
height{string}the height of the control
setLabel(label)
Set label for QRCode control
NameTypeDefaultDescription
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"
NameTypeDefaultDescription
placement{string}"T"|"TOP"=Top | "L"|"LEFT"=Left
setLabelVisible(flag)
Set label visibility for QRCode control
NameTypeDefaultDescription
flag{boolean}the visibility of the label
setLabelWidth(labelWidth)
Set label width of QRCode control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
NameTypeDefaultDescription
labelWidth{string}Control's label width
setQRCode(QRCode)
Set QRCode for QRCode control
NameTypeDefaultDescription
QRCode{string}the QRCode text
Inherited setValid(valid, errorText)
Flag this view/control as valid or invalid
NameTypeDefaultDescription
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
Inherited setVisible(visible, collapse)
Show/hide this view/control
NameTypeDefaultDescription
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)
NameTypeDefaultDescription
width{string}the width of the control
Inherited show()
Show this view/control
Example
MyView.show();
Inherited triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();