Camera Events

doLayout Event

This event is invoked for every widget when the widget position and dimensions are computed. This event is invoked for all the widgets placed inside flex containers. This event is invoked in the order in which the widgets are added to the widget hierarchy and expect the frame property of the widget is calculated and available for use within this event.

Syntax

doLayout()

Read/Write

Read + Write

Remarks

This event is used to set the layout properties of child widgets in the relation to self and peer widgets whose layout is not yet performed.

NOTE: The number of times this event invoked may vary per platform. It is not recommended to write business logic assuming that this function is invoked only once when there is a change in positional or dimensional properties. This event will not trigger when transformations are applied though widget is moved or scaled or rotated from its original location.

Example



//Sample code to set doLayout event callback to a button widget.
/*This code changes the top property of button2 and makes it appear below button1.*/
myForm.button1.doLayout=doLayoutButton1;


function doLayoutButton1(){
      
    myForm.button2.top = myForm.button1.frame.height;
}

Platform Availability

iOS
Android

onBlur Event

An event that accepts a callback function as an input and executes the functionality defined in the callback function when the widget is blurred.

Syntax

onBlur()

Input Parameters

Callback function

A function that contains the logic to be implemented when the widget is blurred.

Read/Write

Read + Write

Remarks

Assign a null value to the onBlur event of a widget to remove the blur effect on the widget.

Example

 

//This is a generic event that is applicable for various widgets.
/*Here, we have shown how to use the onBlur event for a Button widget. You need to make a corresponding use of the onBlur event for other applicable widgets.*/

frmButton.myButton.onBlur = onBlurCallBack;

function onBlurCallBack(widget) {
    console.log('onBlur event triggered');
}

Platform Availability

Available in the IDE
Available on the Responsive Web platform

onCapture Event

The onCapture event invokes a callback when a user takes a photo using the Camera widget.

Syntax

onCapture()

Parameters

camera- [String]- Applicable for iOS and Android platforms.

This parameter specifies the handle (ID) of the Camera widget that triggered the onCapture event.

metadata- Applicable for the iOS and the Android platforms.

This parameter contains the following information about the captured image as key-value pairs:

height[Number]- Returns the height of the captured image.
width[Number]- Returns the width of the captured image.
dateTime[String]- Returns the data and time when the image was captured. The dateTime parameter has the date and time in the following format: YYYY:MM:DD HH:MM:SS.
exifVersion[String]- Returns the EXIF (Exchangeable image file format) version of the captured image, if present.
location[Object]- Returns the latitude and longitude of the location where the image was captured. The latitude and longitude are given as key-value pairs. The location parameter is applicable only for the Android platform.
If you want to access the location information of an image, ensure that you declare and request foreground location access on the device (by using the ACCESS_FINE_LOCATION or the ACCESS_COARSE_LOCATION permissions).
NOTE: In Android apps that targetSDK API level 29 (Android 10) or later, you must additionally declare the ACCESS_MEDIA_LOCATION permission in the Android Manifest File. This additional permission is required when the app is running on Android 10 or later devices. To add the ACCESS_MEDIA_LOCATION permission, navigate to Visualizer Project Settings > Native > Android Mobile/Tablet, and add the following tag in the Child tag entries under <manifest> tag field:
<uses-permission android:name="android.permission.ACCESS_MEDIA_LOCATION" />
orientation[constant]- Returns a constant that indicates the direction in which the image stored on the device is rotated.
dateTimeInMilliSeconds[Number]- Returns the number of milliseconds from Jan 1st 1970 to image captured time in UTC.

The following table contains the constants returned using the orientation parameter and their definitions:

Constant	Definition
constants. CAMERA_IMAGE_ORIENTATION_UP	The orientation in the original pixel data and the current orientation of the image is the same.
constants. CAMERA_IMAGE_ORIENTATION_DOWN	The image has been rotated by 180 degrees.
constants. CAMERA_IMAGE_ORIENTATION_LEFT	The image has been rotated by 90 degrees in the counterclockwise direction.
constants. CAMERA_IMAGE_ORIENTATION_RIGHT	The image has been rotated by 90 degrees in the clockwise direction.
constants. CAMERA_IMAGE_ORIENTATION_UP_MIRRORED	The image has been flipped horizontally.
constants. CAMERA_IMAGE_ORIENTATION_DOWN_MIRRORED	The image has been flipped vertically.
constants. CAMERA_IMAGE_ORIENTATION_LEFT_MIRRORED	The image has been rotated by 90 degrees in the clockwise direction and then flipped horizontally.
constants. CAMERA_IMAGE_ORIENTATION_RIGHT_MIRRORED	The image has been rotated by 90 degrees in the counterclockwise direction and then flipped horizontally.
constants. CAMERA_IMAGE_ORIENTATION_UNKNOWN	It was not possible to retrieve the image orientation from the exif data. This constant is applicable only for the Android platform.

Read/Write

Read + Write

Example



/*Sample code to set onCapture event callback for Camera widget in iOS and Android platforms.*/

frmCamera.myCamera.onCapture = onCaptureCallBck;

function onCaptureCallBck(camera, metadata) {

 if (metadata["orientation"]) == constants.CAMERA_IMAGE_ORIENTATION_UP) {
 var dateTime = metadata["dateTime"];
 var height = metadata["height"];
 var width = metadata["width"];
 var version = metadata["exifVersion"];
 var location = metadata["location"];
 if (location !== null || location !== undefined) {
  var latitude = location["latitude"];
  var longitude = location["longitude"];
 }
}
kony.print("The date and time of the image capture is:" + dateTime);
kony.print("The height of the image is:" + height + "and the width of the image is:" + width);
kony.print("The exif version of the image is:" + version);
kony.print("The latitude of the location of the captured image is:" + latitude);
kony.print("The longitude of the location of the captured image is:" + longitude);
}



/*Sample code to set onCapture event callback for Camera widget for platforms other than iOS and Android.*/

frmCamera.myCamera.onCapture=onCaptureCallBck;

function onCaptureCallBck(camera){
      
   //Write your code here.
}

Platform Availability

Available in the IDE.
iOS
Android
Desktop Web

onCaptureFailed Event

An event callback is invoked when the user has tapped on Don't Allow over permission alert and also when camera privacy is turned off under iPhone settings. If the user taps on Allow for the very first time it will immediately open the camera screen. Camera screen will not be shown until the user has set the permission. Callback will be invoked asynchronously when user selects Don't Allow over permission alert.

The camera permission alert shows up once in app lifecycle. Upgrading or deleting or reinstalling the app will not trigger the alert, if it has already been shown.

For subsequent camera access, onCaptureFailed is called with status as RESOURCE_ACCESS_STATUS_DENIED if the user has selected as Don't Allow for the first time or when camera privacy is turned off under iPhone settings.

Syntax

onCaptureFailed()

Read/Write

Read + Write

Example



//Sample code to set onCaptureFailed event callback for Camera widget.

frmCamera.myCamera.onCaptureFailed=onCaptureFailedCallBck;

function onCaptureFailedCallBck(camera){
      
   //Write your code here.
}

Platform Availability

Not available in the IDE.
iOS
Desktop Web

onFailure Event

An event callback is invoked when an error occurs using a camera widget. For example, you set a camera source, but it is not available on the device.

Syntax

onFailure()

Optional Parameters

source [widgetref]

Handle to the widget reference.

errorcode [Number]

Specifies the error code. The options are:

Error code	Platform	Description
constants.CAMERA_SOURCE_FRONT_UNAVAILABLE	iOS, Android, Desktop Web	When the front camera is not available.
constants.CAMERA_SOURCE_REAR_UNAVAILABLE	iOS, Android, Desktop Web	When the rear camera is not available.
constants.CAMERA_SOURCE_UNAVAILABLE	iOS, Android	When camera source is not available. It is useful when the cameraSource is configured as constants.CAMERA_SOURCE_DEFAULT
constants.CAMERA_PREVIEW_UNAVAILABLE	iOS, Android	When the camera preview is not available.
constants.CAMERA_CAPTURE_FAILED	iOS, Android, Desktop Web	When the camera failed to capture a video.
constants.CAMERA_VIDEO_LOW_DISC_SPACE	Android	When the disk space is low.
constants.CAMERA_VIDEO_RECORDING_FAILED	Android, Desktop Web	When a recording is failed.
constants.CAMERA_VIDEO_SAVE_FAILED	iOS	When the captured video cannot not be saved. For example, insufficient permission to the app to access camera.
constants.CAMERA_ACCESS_MODE_INMEMORY_DATA_RETRIEVE_FAILED	iOS	When the captured media cannot be held in memory because of size constraints.
constants.CAMERA_PERMISSION_DENIED	Desktop Web	When the user denies permission to access the device camera.
constants.CAMERA_NOT_SUPPORTED	Desktop Web	When the web browser does not have camera support.

Read/Write

Read + Write

Example



//Sample code to set onFailure event callback for Camera widget.

frmCamera.myCamera.onFailure=onFailureCallBck;

function onFailureCallBck(camera, errorcode){
      
   //Write your code here.
}

Platform Availability

Not available in the IDE
iOS
Android
Desktop Web

onFocus Event

An event that accepts a callback function as an input and executes the functionality defined in the callback function when the widget is in focus.

Syntax

onFocus()

Input Parameters

Callback function

A function that contains the logic to be implemented when the widget is in focus.

From the V9 Service Pack 7 Fixpack 6 release, the callback function of the onFocus Event contains a new parameter, activeElement. The activeElement parameter specifies the widget that is currently in focus.

Read/Write

Read + Write

Remarks

Assign a null value to the onFocus event of a widget to remove focus from the widget.

Example

 

//This is a generic event that is applicable for various widgets.
/*Here, we have shown how to use the onFocus event for a Button widget. You need to make a corresponding use of the onFocus event for other applicable widgets.*/

frmButton.myButton.onFocus = onFocusCallBack;

function onFocusCallBack(widget, activeElement) {
    console.log('onFocus event triggered');
}

Platform Availability

Available in the IDE
Available on the Responsive Web platform

onImageSaveFailed Event

An event callback is invoked when the user has performed some action over permission alert and also when image cannot be saved to photo album or due to data save error.

Syntax

onImageSaveFailed()

Read/Write

Read + Write

Example



//Sample code to set onImageSaveFailed event callback for Camera widget.

frmCamera.myCamera.onImageSaveFailed=onImageSaveFailedCallBck;

function onImageSaveFailedCallBck(camera, status){
      
   //Write your code here.
}

Platform Availability

Not available in the IDE.
Available on iOS platform.

onKeyPress Event

This event takes a callback as an input that is invoked by the platform when the user presses a key (on the keyboard).

Syntax

onKeyPress(eventObject, eventPayload, context)

Input Parameters

eventObject:

An Object that contains the instance of the widget that triggered the onKeyPress event.

eventPayload:

An Object that contains information about the keyboard interactions. Based on the key that the user presses, the value of the eventPayload varies as follows:

Key	Description
altKey	Returns a boolean value. The value is true when the Alt key (Option key on macOS systems) is pressed.
ctrlKey	Returns a boolean value. The value is true when the Ctrl key is pressed.
shiftKey	Returns a boolean value. The value is true when the Shift key is pressed.
metaKey	Returns a boolean value. The value is true when the meta key ( windows key ⊞ on windows systems, command key ⌘ on macOS systems) is pressed.
capsLock	Returns a boolean value. The value is true when the capsLock key is turned on.
keyCode	Returns the ASCII code of the key pressed .
preventDefault	Returns a function. This function can be invoked to prevent the default action of the widget.

context:

An Object that represents information about the row that contains the target widget that triggered the onKeyPress event.

rowIndex: The index of the row that contains the target widget for a Segment widget.

itemIndex: The index of the row that contains the target widget for a CollectionView widget.

sectionIndex: The index of the section that contains the target widget.

widgetInfo: The widget reference of the Segment or CollectionView widget.

Read/Write

Read + Write

Remarks

The onKeyPress event is not linked with native keypress event, i.e both the events are different.
For widgets (such as TextBox and TextArea) that support both the onKeyDown and onKeyPress events, the onKeyDown event takes higher priority.
If a widget has both the onKeyDown and onKeyPress events configured, the onKeyDown event is invoked first, followed by the onKeyPress event.
The Web Framework provides support for both the onKeyDown and onKeyPress events on the TextBox and TextArea widgets. However, Temenos recommends that you use only one of the events for a widget.

Example



/*This event is triggered in both TextBox and TextArea widgets for Android platform.*/

/*This example demonstrates how to set an onKeyPress event callback to a Button widget that is placed inside form


frmButton.myButton.onKeyPress = onKeyPressCallBack;

function onKeyPressCallBack(eventObject, eventPayload) {
    console.log('onKeyPress event triggered');
}

Platform Availability

Available in the IDE
Available on the Responsive Web platform

onTouchEnd Event

An event callback is invoked by the platform when the user touch is released from the touch surface.

Syntax

onTouchEnd ()

Optional Parameters

source

Handle to the widget reference on which the user touch has ended.

x

Specifies the x-coordinate with in the widget with respect to widget's co-ordinate system. It is a number indicating device independent pixel.

y

Specifies the y- coordinate with in the widget with respect to widget's co-ordinate system. It is a number indicating device independent pixel.

contextInfo

On devices that support 3D Touch, specifies a key-value pair where the value specifies the force of the touch. The value 1.0 represents the force of an average touch, as determined by the system.

NOTE: 3D Touch is available only on iOS 9.0 and later.

Read/Write

Read + Write

Remarks

This event is invoked asynchronously.

Example



function onTouchEndCallback(source, x, y, contextInfo) {
    if (contextInfo) {
        var force = contextInfo[“force”];
        kony.print(“value of force is” + force)
    }
}
Form1.widget1.onTouchEnd = onTouchEndCallback;

Platform Availability

iOS
Android

onTouchMove Event

An event callback is invoked by the platform when the touch moves on the touch surface continuously until movement ends.

Syntax

onTouchMove ()

Optional Parameters

source

Handle to the widget reference on which touch moves.

x

Specifies the x-coordinate with in the widget with respect to widget's co-ordinate system. It is a number indicating device independent pixel.

y

Specifies the y- coordinate with in the widget with respect to widget's co-ordinate system. It is a number indicating device independent pixel.

contextInfo

On devices that support 3D Touch, specifies a key-value pair where the value specifies the force of the touch. The value 1.0 represents the force of an average touch, as determined by the system.

NOTE: 3D Touch is available only on iOS 9.0 and later.

Read/Write

Read + Write

Remarks

This event is invoked asynchronously.

Example



function onTouchMoveCallback(source, x, y, contextInfo) {
    if (contextInfo) {
        var force = contextInfo[“force”];
        kony.print(“value of force is” + force)
    }
    Form1.widget1.onTouchMove = onTouchMoveCallback;

Platform Availability

iOS
Android

onTouchStart Event

An event callback is invoked by the platform when the user touches the touch surface.

Syntax

onTouchStart ()

Optional Parameters

source

Handle to the widget reference on which the user touches.

x

Specifies the X co-ordinate with in the widget with respect to widget's co-ordinate system. It is a number indicating device independent pixel.

y

Specifies the Y co-ordinate with in the widget with respect to widget's co-ordinate system. It is a number indicating device independent pixel.

contextInfo

On devices that support 3D Touch, specifies a key-value pair where the value specifies the force of the touch. The value 1.0 represents the force of an average touch, as determined by the system.

NOTE: 3D Touch is available only on iOS 9.0 and later.

Read/Write

Read + Write

Remarks

This event is invoked asynchronously.

Example



function onTouchStartCallback(source, x, y, contextInfo) {
    if (contextInfo) {
        var force = contextInfo[“force”];
        kony.print(“value of force is” + force)
    }
}
Form1.widget1.onTouchStart = onTouchStartCallback;

Platform Availability

iOS
Android