FlexScrollContainer Events

FlexScrollContainer widget has the following events associated:

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

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

An event callback is invoked by the platform when the user stops scrolling but the content still moves before the content actually stops. This event is invoked asynchronously.

Syntax

onDecelerationStarted()

Read/Write

Read + Write

Example



//Sample code to set a callback to the onDecelerationStarted event for a FlexScrollContainer widget.

myForm.myFlexScroll.onDecelerationStarted=onDecelerationStartedCallback;

function onDecelerationStartedCallback() {
    //write your logic here.
}

Platform Availability

  • This property is available on iOS platform.

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

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

An event callback is invoked by the platform when the scrolling is ended. This event is invoked asynchronously.

Syntax

onScrollEnd ()

source [widgetref]

Optional. Handle to the widget reference on which the scrolling is ended.

Read/Write

Read + Write

Example



//Sample code to set a callback to the onScrollEnd event for a FlexScrollContainer widget.

myForm.myFlexScroll.onScrollEnd=onScrollEndCallback;

function onScrollEndCallback(eventobject) {
    //write your logic here.
}

Platform Availability

  • iOS
  • Android

An event callback is invoked by the platform when the scrolling is in progress. This event is invoked asynchronously.

Syntax

onScrolling (source)

Input Parameters

source [widgetref]

Handle to the widget reference on which the scrolling is in progress.

Read/Write

Read + Write

Example



//Sample code to set a callback to the onScrolling event for a FlexScrollContainer widget.

myForm.myFlexScroll.onScrolling=onScrollingCallback;

function onScrollingCallback(eventobject) {
    //write your logic here.
}

Platform Availability

  • iOS
  • Android

An event callback is invoked by the platform when the user starts scrolling the content. This event is invoked asynchronously.

Syntax

onScrollStart()

source [widgetref]

Optional. Handle to the widget reference on which the scrolling has started.

Read/Write

Read + Write

Example



//Sample code to set a callback to the onScrollStart event for a FlexScrollContainer widget.

myForm.myFlexScroll.onScrollStart=onScrollStartCallback;

function onScrollStartCallback(eventobject) {
    //write your logic here.
}

Platform Availability

  • iOS
  • Android

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

Syntax

onScrollTouchReleased()

source [widgetref]

Optional. Handle to the widget reference on which the user touch is released from the display.

Read/Write

Read + Write

Example



//Sample code to set a callback to the onScrollTouchReleased event for a FlexScrollContainer widget.

myForm.myFlexScroll.onScrollTouchReleased=onScrollTouchReleasedCallback;

function onScrollTouchReleasedCallback(eventobject) {
    //write your logic here.
}

Platform Availability

  • iOS
  • Android

This event callback is invoked by the platform when the widget location position gets changed on scrolling. The onScrollWidgetPosition event returns the positional coordinates of the widget's location with respect to the screen (screenX and screenY) and the parent container (frameX and frameY). This event is invoked asynchronously, and is not available for FlexForm widget.

Syntax

onScrollWidgetPosition()

Read/Write

Read + Write

Example



var LabelWdg = new kony.ui.Label(basicConf, layoutConf, pspConf);
form.add(LabelWdg);
LabelWdg.onScrollWidgetPosition = onScrollWidgetPositionCallBack;

function onScrollWidgetPositionCallBack(wdg, screenX, screenY, frameX, frameY) { //wdg : Widget that is registered for onScrollWidgetPosition.
    /*screenX : Position of widget with respect to 
the screen's X - coordinates (after downsizing the navigation bar and status bar).*/
    /*screenY : Position of widget with respect to the screen's Y - 
coordinates (after downsizing the navigation bar and status bar).*/
    //frameX : Position of widget with respect to parent container's X- coordinates.
    //frameY : Position of widget with respect to parent container's Y- coordinates.
}

Platform Availability

  • Not Accessible from IDE
  • Android
  • iOS

An event callback is invoked by the platform when the zooming has ended. This event is invoked asynchronously.

Syntax

onZoomEnd()

source [widgetref]

Handle to the widget reference on which the zooming has ended.

Read/Write

Read + Write

Remarks

For example, If you have a form with a flexScrollContainer and an image widget inside flexScrollContainer, when you pinch the screen on flexScrollContainer it will call the function configured using widgetToZoom event. If the function returns image, the image will be zoomed.



function onZoomEndCalBck(flexScrollContainer) {
    //Write your logic here
         
    kony.print("zooming ended");
}
myForm.myflexScrollContainer.onZoomEnd = onZoomEndCalBck;

NOTE: This event callback is invoked only when zooming is initiated by user interaction.

Platform Availability

  • Available in the IDE.
  • iOS

An event callback is invoked by the platform when the container is zooming. This event is invoked asynchronously.

Syntax

onZooming ()

source [widgetref]

Optional. Handle to the widget reference on which the zooming has started.

Read/Write

Read + Write

Remarks

For example, If you have a form with a flexScrollContainer and an image widget inside flexScrollContainer, when you pinch the screen on flexScrollContainer it will call the function configured using widgetToZoom event. If the function returns image, the image will be zoomed.



function onZoomingCalBck(flexScrollContainer) {
    //Write your logic here.
}
myForm.myflexScrollContainer.onZooming = onZoomingCalBck;

NOTE: This event callback is invoked only when zooming is initiated by user interaction.

Platform Availability

  • iOS

An event callback is invoked by the platform when the container is about to zoom. This event is invoked asynchronously.

Syntax

onZoomStart()

source [widgetref]

Optional. Handle to the widget reference on which the zooming has started.

widget [widgetref]

Optional. Specifies the widget that actually zooms.

Read/Write

Read + Write

Remarks

For example, If you have a form with a flexScrollContainer and an image widget inside flexScrollContainer, when you pinch the screen on flexScrollContainer it will call the function configured using widgetToZoom event. If the function returns image, the image will be zoomed.



function onZoomStartCalBck(flexScrollContainer) {
    //Write your logic here
          
    kony.print("zooming started");
}
myForm.myflexScrollContainer.onZoomStart = onZoomStartCalBck;

NOTE: This event callback is invoked only when zooming is initiated by user interaction.

Platform Availability

  • Available on iOS platform.

This event callback is invoked while scrolling the FlexScrollContainer horizontally or vertically. The scrollingEvents event is triggered when the FlexScrollContainer is pushed or pulled beyond its horizontal or vertical boundaries.

Syntax

scrollingEvents()

Events defined in scrollingEvents

onPull: This event is triggered when the FlexScrollContainer is pulled while scrolling horizontally or vertically.

onPull(widgetRef)

onPush: This event is triggered when the FlexScrollContainer is pushed while scrolling horizontally or vertically.

onPush(widgetRef)

onReachingBegining: This event is triggered when the scrolling bar reaches the beginning of the FlexScrollContainer widget.

onReachingBegining(widgetRef)

onReachingEnd: This event is triggered when the scrolling bar reaches the end of the FlexScrollContainer widget.

onReachingEnd(widgetRef)

Input Parameters

widgetRef

This parameter references the FlexScrollContainer that triggered the event.

Read/Write

Read + Write

Remarks

Limitations

  • Desktop Web does not support onPull and onPush events.
  • onPull and onPush events do not work when the scrollDirection Property is set as Both.
  • When onPull and onPush events are configured, the parent container does not scroll.
  • In Android, when onPull and onPush events are enabled, the scrollDirection Property cannot be modified in the same FlexForm.
  • In Android, you cannot enable scrollingEvents after navigating to the FlexForm. It must be enabled before navigating to the form.


//The following function should be called in the Preshow event of the myForm FlexForm.
function myFormPreShow() {
 myForm.myFlexScroll.scrollingEvents = {
  "onPull": flxPushMethod,
  "onPush": flxPullMethod,
  "onReachingBegining": flxReachBeginMethod,
  "onReachingEnd": flxReachEndMethod,
 };
}
//The following functions should be defined in the modules.
//The callback assigned to the onPush event.
function flxPushMethod(widgetRef) {
 kony.print("onPush");
}
//The callback assigned to the onPull event.
function flxPullMethod(widgetRef) {
 kony.print("onPull");
}
//The callback assigned to the onReachingBegining event.
function flxReachBeginMethod(widgetRef) {
 kony.print("onReachingBegining");
}
//The callback assigned to the onReachingEnd event.
function flxReachEndMethod(widgetRef) {
 kony.print("onReachingEnd");
}

Platform Availability

  • Android
  • iOS

An event callback is invoked by the platform to return one of the child widgets of source to zoom. The returning source itself may not result in zooming the entire source. The container will not zoom, if a null value is returned. This event is invoked asynchronously.

Syntax

widgetToZoom()

source [widgetref]

Optional. Handle to the widget reference on which the zooming has started.

Read/Write

Read + Write

Remarks

For example, If you have a form with a flexScrollContainer and an image widget inside flexScrollContainer, when you pinch the screen on flexScrollContainer it will call the function configured using widgetToZoom event. If the function returns image, the image will be zoomed.



function onWidgetToZoomCalBck(flexScrollContainer) {
    //Write your logic here
    return flexScrollContainer.image;
}
myForm.myflexScrollContainer.widgetToZoom = onWidgetToZoomCalBck;

NOTE: This event callback is invoked only when zooming is initiated by user interaction.

Platform Availability

  • Available in the IDE.
  • iOS