ListBox Properties

Enables you to control accessibility behavior and alternative text for the widget.

For more information on using accessibility features in your app, refer Accessibility appendix.

Syntax

accessibilityConfig

Type

Object

Read/Write

Read + Write

Remarks

The accessibilityConfig property is enabled for all the widgets which are supported under the Flex Layout.

The accessibilityConfig property is a JavaScript object which can contain the following key-value pairs.

a11yLabel [String]

Optional. Specifies alternate text to identify the widget. Generally the label should be the text that is displayed on the screen.

a11yValue [String]

Optional. Specifies the current state/value associated with the widget so that the user can perform an action. For example, a checkbox is in selected state or unselected state. On the Android platform, the text specified for a11yLabel is prefixed to the a11yValue.

a11yHint [String]

Optional. Specifies the descriptive text that explains the action associated with the widget. On the Android platform, the text specified for a11yValue is prefixed to the a11yHint.

a11yHidden [Boolean]

Optional. Specifies if the widget should be ignored by assistive technology. The default option is set to false. This option is supported on iOS 5.0 and above, Android 4.1 and above, and SPA

Android limitations

• If the results of the concatenation of a11y fields result in an empty string, then accessibilityConfig is ignored and the text that is on widget is read out.
• The soft keypad does not gain accessibility focus during the right/left swipe gesture when the keypad appears.

SPA/Desktop Web limitations

• The behavior of accessibility depends on the Web browser, Web browser version, Voice Over Assistant, and Voice Over Assistant version.
• Currently SPA/Desktop web applications support only a few ARIA tags. To achieve more accessibility features, use the attribute a11yARIA. The corresponding tags will be added to the DOM as per these configurations.

Example

This example uses the button widget, but the principle remains the same for all widgets that have an accessibilityConfig property.

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

Form1.myButton.accessibilityConfig = {
    "a11yLabel": "Label",
    "a11yValue": "Value",
    "a11yHint": "Hint"    
};

Platform Availability

• Available in the IDE
• iOS, Android, SPA, and Desktop Web

Specifies the anchor point of the widget bounds rectangle using the widget's coordinate space.

Syntax

anchorPoint

Type

JSObject

Read/Write

Read + Write

Remarks

The value for this property is a JavaScript dictionary object with the keys "x" and "y". The values for the "x" and "y" keys are floating-point numbers ranging from 0 to 1. All geometric manipulations to the widget occur about the specified point. For example, applying a rotation transform to a widget with the default anchor point causes the widget to rotate around its center.

The default value for this property is center ( {"x":0.5, "y":0.5} ), that represents the center of the widgets bounds rectangle. The behavior is undefined if the values are outside the range zero (0) to one (1).

Example

Form1.widget1.anchorPoint = {
    "x": 0.5,
    "y": 0.5
};

Platform Availability

• iOS, Android, Windows, and SPA

Specifies if the skin preserve">var var focusSkin properties specified for the ListBox must be applied to the popup that appears when you click on the ListBox.

Syntax

applySkinsToPopup

Type

Boolean

Read/Write

No

Remarks

The default value for the property is false.

• If set to true, the skin is applied to the popup.
• If set to false, the skin is not applied to the popup.

Example

//Sample code to set the applySkinsToPopup property of a ListBox widget.
frmList.myList.applySkinsToPopup= true;

Platform Availability

• Available in the IDE
• Available on Android/Android Tablet platform only.

Specifies the background color of the widget in hex format. The background can be a single color or a gradient of several colors.

Syntax

backgroundColor

Type

String

Read/Write

Read + Write

Remarks

This property does not have default value.

This property has more priority compared to the values coming from the configured skin.

The initial value of backgroundColor has to be specified explicitly. If not, Visualizer will not deduce the values from the existing skin and this will lead to undefined behavior.

The value can specify either a solid color, or a gradient:

Solid color:

Solid colors can be specified using a 6 digit or an 8 digit hex value with alpha position. For example, ffffff or ffffff00.

When the 4-byte color format (RGBA) string is used, an alpha (A) value of FF specifies that the color is transparent. If the value is 00, the color is opaque. For example, red complete opaque is FF000000. Red complete transparent is FF0000FF. The values 0x and # are not allowed in the string.

Gradient:

A gradient is specified as follows:

Form1.widgetID.backgroundColor = {
    "angle": 45,
    "colors": ["ea5075", "f1fa70", "eefd04"],
    "colorStops": [0, 90, 100]
};

Where:

• angle is the angle of the gradient in degrees, counted counter-clockwise.
• colors is an array of color hex values that indicate the reference color values of the gradient.
• colorStops are the locations of the reference colors on the gradient, from 0 (the start of the gradient) to 100 (the final value of the gradient).

Example

Form1.lbl1.backgroundColor = {
    "angle": 45,
    "colors": ["ea5075", "f1fa70", "eefd04"],
    "colorStops": [0, 90, 100]
};

Platform Availability

• iOS, Android, Windows, and SPA

You can enable or disable a blur-effect for a widget(for example, a FlexContainer) by making use of a constructor-level property, called blur. The blur property accepts a dictionary that contains the following keys: enabled, value and style. You must specify an appropriate value for the dictionary keys, otherwise the property will not be valid.

Syntax

blur

Input Parameters

• enabled: Accepts a Boolean value that basically decides whether to enable or disable the blur-effect for the widget. This is a mandatory attribute.

• value: Level of the blur-effect that needs to be set for the widget. It should ideally be between 0 to 100. If the level is set as 0 no blur is set, even when the enabled property is set as true. This is a mandatory attribute. Even when the enabled attribute is set as false, you need to specify a numerical value to this attribute.

• style: Specifies the style in which the blur property can be applied to a widget. This is an optional parameter specific to iOS. The default value of this parameter is constants.BLUR_EFFECT_LIGHT. You can specify any of the following values to this parameter:
  
  • constants.BLUR_EFFECT_NONE

  • constants.BLUR_EFFECT_EXTRALIGHT

  • constants.BLUR_EFFECT_LIGHT (default)

  • constants.BLUR_EFFECT_DARK

  • constants.BLUR_EFFECT_REGULAR

  • constants.BLUR_EFFECT_PROMINENT

Read/Write

Read + Write

Remarks

• If you set enabled as true, the blur-effect for the widget is enabled.
• If you set enabled as false, the blur-effect for the widget is disabled.

• If you specify value as less than 0, the value is taken as 0.

• If you specify value as greater than 100, the value is taken as 100.

Limitations

• For Android:

  • If a FlexContainer or a FlexScrollContainer contains a Map widget, the blur-effect is not applied to the map.

  • If a FlexContainer or a FlexScrollContainer contains a Browser or Video widget, the blur-effect is applied but does not get updated. For example, when the video starts playing, the new rendered frame does not get displayed with the blur-effect.

  • Even if you apply 100% blur for widgets that display any text( such as Label or Calendar widgets), the text on these widgets is not blurred. This is a Native Android limitation. To generate the blur effect for the text, apply a skin with darker background to the Label or Calendar widget. This is true even when the widgets are placed in a FlexContainer with blur effect and the widgets do not have a skin.
  • Blur effect will not work on widgets added inside BOX containers.

Example 1

To dynamically set the blur-effect for any widget, such as a FlexContainer, use the following code.

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

Form1.myFlexContainer.blur = {
    "enabled": true,
    "value": 60
};

Example 2

To dynamically set the blur-effect for any widget, such as a FlexContainer in iOS, use the following code.

Form1.widget1.blur = {
    "enabled": true,
    "value": 60,
    "style": constants.BLUR_EFFECT_DARK
};

Platform Availability

• Android, iOS, Windows, SPA , and Desktop web

This property determines the bottom edge of the widget and is measured from the bottom bounds of the parent container.

The bottom property determines the position of the bottom edge of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. In freeform layout, the distance is measured from the bottom edge of the parent container. In flow-vertical layout, the value is ignored. In flow-horizontal layout, the value is ignored.

The bottom property is used only if the Height property is not provided.

Syntax

bottom

Type

String

Read/Write

Read + Write

Remarks

The property determines the bottom edge of the widget and is measured from the bottom bounds of the parent container.

If the layoutType is set as kony.flex.FLOW_VERTICAL, the bottom property is measured from the top edge of bottom sibling widget. The vertical space between two widgets is measured from bottom of the top sibling widget and the top of the bottom sibling widget.

Example

//Sample code to set the bottom property for widgets by using DP, Percentage and Pixels.
frmHome.widgetID.bottom = "50dp";

frmHome.widgetID.bottom = "10%";

frmHome.widgetID.bottom = "10px";

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA , and Desktop Web

Specifies the skin that must be used to block the interface until the action in progress (for example, a service call) is completed.

Syntax

blockedUISkin

Type

String

Read/Write

Read + Write

Remarks

The default value for the property is None (No skin is applied.)

To specify a skin, select a skin from the list.

For the skin to be available in the list, you must add a skin for Blocked UI under Widget Skins.

Example

//Sample code to set the blockedUISkin property of a ListBox widget.
frmList.myList.blockedUISkin= "blckUISkin";

Platform Availability

• Available in the IDE
• SPA (iPhone/Android/BlackBerry/Windows NTH)

This property determines the center of a widget measured from the left bounds of the parent container.

The centerX property determines the horizontal center of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. In freeform layout, the distance is measured from the left edge of the parent container. In flow-vertical layout, the distance is measured from the left edge of the parent container. In flow-horizontal layout, the distance is measured from the right edge of the previous sibling widget in the hierarchy.

Syntax

centerX

Type

String

Read/Write

Read + Write

Remarks

If the layoutType is set as kony.flex.FLOW_HORIZONTAL, the centerX property is measured from right edge of the left sibling widget.

Example

//Sample code to set the centerX property for widgets by using DP, Percentage and Pixels.
frmHome.widgetID.centerX = "50dp";

frmHome.widgetID.centerX = "10%";

frmHome.widgetID.centerX = "10px";

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA, and Desktop Web

This property determines the center of a widget measured from the top bounds of the parent container.

The centerY property determines the vertical center of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. In freeform layout, the distance is measured from the top edge of the parent container. In flow-horizontal layout, the distance is measured from the top edge of the parent container. In flow-vertical layout, the distance is measured from the bottom edge of the previous sibling widget in the hierarchy.

Syntax

centerY

Type

String

Read/Write

Read + Write

Remarks

If the layoutType is set as kony.flex.FLOW_VERTICAL, the centerY property is measured from bottom edge of the top sibling widget.

Example

//Sample code to set the centerY property for widgets by using DP, Percentage and Pixels.
frmHome.widgetID.centerY = "50dp";

frmHome.widgetID.centerY = "10%";

frmHome.widgetID.centerY = "10px";

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA, and Desktop Web

Specifies percentage of width to be allocated by its parent widget. The parent widget space is distributed to its child widgets based on this weight factor. All its child widgets should sum up to 100 percent of weight except when placed in kony.ui.ScrollBox.

Syntax

containerWeight

Type

Number

Read/Write

Read + Write

Example

//Sample code to set the containerWeight property of a ListBox widget.
frmList.myList.containerWeight= 100;

Platform Availability

Available on all platforms

Specifies the alignment of the text for a ListBox with respect to its boundaries.

Syntax

contentAlignment

Type

Number

Read/Write

Read + Write

Remarks

The default value for the property is CONTENT_ALIGN_CENTER.

This property is applicable only when the view is set as wheel type.

The following are the available options:

• constants.CONTENT_ALIGN_TOP_LEFT
• constants.CONTENT_ALIGN_TOP_CENTER
• constants.CONTENT_ALIGN_TOP_RIGHT
• constants.CONTENT_ALIGN_MIDDLE_LEFT
• constants.CONTENT_ALIGN_CENTER
• constants.CONTENT_ALIGN_MIDDLE_RIGHT
• constants.CONTENT_ALIGN_BOTTOM_LEFT
• constants.CONTENT_ALIGN_BOTTOM_CENTER
• constants.CONTENT_ALIGN_BOTTOM_RIGHT

Example

//Sample code to set the contentAlignment property of a ListBox widget.
frmList.myList.contentAlignment= constants.CONTENT_ALIGN_TOP_LEFT;

Platform Availability

• Available in the IDE
• iOS, Android, Windows

In Desktop Web applications, when you hover the mouse over any widget, a pointer appears. Using the cursorType property, you can specify the type of the mouse pointer in Visualizer.

Syntax

cursorType

Type

String.

You must provide a valid CSS cursor values such as wait, grab, help, etc. to the cursorType property.

Read/Write

Read + Write

Example

 //This is a generic property and is applicable for many widgets.

/*The example provided is for the Button widget. Make the required changes in the example while using other widgets.*/

frmButton.myButton.cursorType = "wait";

Platform Availability

• Desktop Web

Specifies the image to be used for the drop-down box indicator (inverted triangle by default).

Syntax

dropDownImage

Type

String / image Object

Read/Write

No

Remarks

The image you specify is used to depict the drop-down box. If you do not specify an image, the drop-down box displays the default image (inverted triangle).

You can create an image Object by using kony.image Namespace functions.

For the Windows Phone platform, you can specify the image from the ListBox skin.

For the iOS platform, the drop down image should be 20px * 33px for non retina devices and for retina devices the image size should be 40px * 66px.

The following figure illustrates the default drop-down box indicator:

Example

Using a string to identify an image resource:

/*Sample code to set the dropDownImage property of a ListBox widget where downarrow.png is an image file in the resources folder.*/
frmList.myList.dropDownImage="downarrow.png";

Using a Kony image object (kony.image) to specify the dropdown image:

/*Sample code to set the dropDownImage property of a ListBox widget where local.png is an image file in the resources folder.*/

var imgObjRef = kony.image.createImage("local.png");
frmList.myList.dropDownImage=imgObjRef;

Platform Availability

Available in the IDE

• iOS
• Android
• BlackBerry (no support for the Kony image object)
• Windows Phone (no support for the Kony image object)

The property enables you to improve the performance of Positional Dimension Animations.

Syntax

enableCache

Type

Boolean

Read/Write

Read + Write

Remarks

The default value for this property is true.

Note: When the property is used, application consumes more memory. The usage of the property enables tradeoff between performance and visual quality of the content. Use the property cautiously.

Example

Form1.widgetID.enableCache = true;

Platform Availability

• Available in the IDE.
• Windows

Allows you to enable or disable haptic feedback on the ListBox widget.

Syntax

enableHapticFeedback

Type

Boolean.
If the enableHapticFeedback property is not specified, haptic feedback is not enabled on the ListBox widget.

Read/Write

Read + Write

Remarks

• The enableHapticFeedback property is supported for ListBox widgets only when the onClick callback event is defined.

• iOS

  • The Haptic Feedback feature is available on iPhone 7 devices and later. These devices have Taptic Engine hardware and users can enable/disable Haptics from Device Settings-> Sounds & Haptics-> System Haptics.

• Windows
  • Haptic Feedback is supported on Windows devices with OS build version 10.0.15063.0 or later.
• Android

  • Users can enable the Vibrate on touch feature from Settings-> Sound & notification-> Other sounds.

Limitations and Behavior

• The haptic feedback feature is provided on the Options context menu for ListBox widget.

Example

//Sample code to set the enableHapticFeedback property of a ListBox widget.

frmList.myList.enableHapticFeedback =true;

Platform Availability

• Android

• iOS
• Windows

This property is used to set the width of the row items to its parent width. From Kony Visualizer 8.4.44 version onwards, you can use this property when you observe that the width of the row content is less than the parent width. This behavior is observed in Android devices such as Google Pixel and Samsung S10.

When the list item width is less than the width of the dialog as shown in the following image, set this property to true to make the width the same as the parent width.

Syntax

expandListItemToParentWidth

Type

Boolean

Read/Write

Read + Write

Remarks

The default value of this property is false.

• If you set expandListItemToParentWidth as true, the row items of the ListBox widget occupies the parent width.
• If you set expandListItemToParentWidth as false, the width of the row items of the ListBox widget is set as per the native platform.

Example

//Sample code to set the expandListItemToParentWidth property for a ListBox widget.

frmList.myList.expandListItemToParentWidth=true;

Platform Availability

• Android

Specifies the look and feel of the ListBox when in focus.

Syntax

focusSkin

Type

String

Read/Write

Read + Write

Remarks

You must be aware of the following:

On J2ME, if you do not specify the Focus skin, it will not possible to identify the traversal.

Mobile Web does not support this property. For Advanced Mobile Web platforms, a platform specific progress indicator is displayed. For other Mobile Web platforms (Basic and BJS), the screen is refreshed.

In the Desktop Web platform, Chrome browser does not support if the properties defined in font tab are different for skin and focusSkin.

Example

//Sample code to set the focusSkin property of a ListBox widget.

frmList.myList.focusSkin="listFSkin";

Platform Availability

• Available in the IDE
• Available on all platforms.

Specifies if all the rows in the ListBox should be grouped using a rounded corner background and border.

Syntax

groupCells

Type

Boolean

Read/Write

No

Remarks

The default value for the property is false.

• If set to true, the cells will have a rounded border.
• If set to false, the cells will not have rounded border.

For the iOS platform, this property is applicable only when viewType is set as LISTBOX_VIEW_TYPE_TABLEVIEW.

Example

//Sample code to set the groupCells property of a ListBox widget.

frmList.myList.groupCells=true;

Platform Availability

• Available in the IDE
• iPad
• iPhone

It determines the height of the widget and measured along the y-axis.

The height property determines the height of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. For supported widgets, the height may be derived from either the widget or container’s contents by setting the height to “preferred”.

Syntax

height

Type

Number, String, and Constant

Read/Write

Read + Write

Remarks

Following are the available measurement options:

• %: Specifies the values in percentage relative to the parent dimensions.
• px: Specifies the values in terms of device hardware pixels.
• dp: Specifies the values in terms of device independent pixels.
• default: Specifies the default value of the widget.
• kony.flex.USE_PREFERED_SIZE: When this option is specified, the layout uses preferred height of the widget as height and preferred size of the widget is determined by the widget and may varies between platforms.

Example

/*Sample code to set the height property for a ListBox widget by using DP, Percentage and Pixels.*/
frmList.myList.height="50dp";

frmList.myList.height="10%";

frmList.myList.height="10px";

Platform Availability

• Available in the IDE
• iOS
• Android
• Windows
• SPA

Specifies the look and feel of a widget when the cursor hovers on the widget.

Syntax

hoverSkin

Type

String

Read/Write

Read + Write

Example

//Sample code to set the hoverSkin property of a ListBox widget.

frmList.myList.hoverSkin="hSkin";

Platform Availability

• Available in the IDE
• Windows Tablet

Specifies if the widget should occupy all the width available to it.

Syntax

hExpand

Type

Boolean

Read/Write

No

Remarks

The default value for the property is true.

• If set to false, the widget occupies the preferred width. The preferred width of a widget is the sum of its contents width, padding and margin.
• If set to true, the widget ensures that the entire width available to it is occupied.

Mobile Web does not support the Expand property. This is because a widget in a Mobile Web cannot expand or contract based on the neighboring widget (default behavior of a widget in a Mobile Web).

In BlackBerry 10 platform, hExpand as false is not supported.

Example

//Sample code to set the hExpand property of a ListBox widget.

frmList.myList.hExpand =true;

Platform Availability

• Available in the IDE
• Available on all platforms except and SPA

id is a unique identifier of ListBox consisting of alpha numeric characters. Every ListBox should have a unique id within a Form.

Syntax

id

Type

String

Read/Write

Read only

Example

//Defining the properties for Listbox with the id:"listbx"
var listBasic = {
    id: "listbx",
    isVisible: true,
    masterData: [
        ["key1", "value1"],
        ["key2", "value2"],
        ["key3", "value3"]
    ],
    skin: "listSkin",
    focusSkin: "listFSkin"
};

var listLayout = {
    widgetAlignment: constants.WIDGET_ALIGN_CENTER,
    padding: [0, 0, 0, 0],
    margin: [0, 0, 0, 0],
    containerWeight: 40,
    hExpand: false
};

var listPSP = {};

//Creating the Listbox	
var listbx = new kony.ui.ListBox(listBasic, listLayout, listPSP);

//Reading the id of the listbox		
alert("listbox Id ::" + listbx.id);

Platform Availability

• Available in the IDE
• Available on all platforms

A custom JSObject with the key value pairs that a developer can use to store the context with the widget. This will help in avoiding the globals to most part of the programming.

Note: This is a non-Constructor property. You cannot set this property through widget constructor. But you can read and write data to it.

Info property can hold any JSObject. After assigning the JSObject to info property, the JSObject should not be modified. For example,

var inf = {
    a: 'hello'
};
widget.info = inf; //works
widget.info.a = 'hello world'; //This will not update the widget.info property to Hello world. widget.info.a will have old value as hello.

Syntax

info

Type

JSObject

Read/Write

Yes - (Read and Write)

Example

//Sample code to set info property for a ListBox widget.

frmList.myList.info = {
    key: "listboxitems"
};

//Reading the info of the ListBox widget.
kony.print("Map widget info:" +frmList.myList.info);

Accessible from IDE

No

Platform Availability

Available on all platforms

While building iPhone applications that support or provide text input, it is necessary to create some extra buttons (or other controls) beyond the ones provided by the default keyboard interface. Kony AppPlatform by default, adds the Previous, Next, and Done buttons to the applicable input controls. These buttons allow specific operations needed by your application, such as moving to the next or previous text field, making the keyboard disappear and so on. The area above the keyboard is known as Input Accessory View.

Syntax

inputAccessoryViewType

Type

Number

Read/Write

Yes

Remarks

The default value for this property is LISTBOX_INPUTACCESSORYVIEW_DEFAULT.

This property, allows you to specify the type of accessory view that will be shown for all the input controls for Listbox widget.

Note: For iOS, a header with 'Prev' and Next' buttons is added to the keypad by default. You can turn off this header at three levels: application-level, form-level, and widget-level.

To know more about how to set inputAccessoryViewType property at application-level and form-level, you can refer the inputAccessoryViewType property under Flexform widget.

To turn on/off the header at widget-level, assign any of the following constants to inputAccessoryViewType property. You must specify each constant with the ‘constants.xx’ prefix.

• LISTBOX_INPUTACCESSORYVIEW_NONE: Use this option if you do not want to specify the toolbar. This option should be used carefully, as setting this option for widgets like calendar leaves the user with no option to select and drop-down a wheel calendar.
• LISTBOX_INPUTACCESSORYVIEW_DEFAULT: Specifies that the toolbar that is defined in the Application level settings. To set the Application level settings, right-click on the project and navigate to Properties> Native App>iPhone/iPad.
  
• LISTBOX_INPUTACCESSORYVIEW_NEXTPREV: Specifies the navigation options as Next, Previous, and Done for a form.

• LISTBOX_INPUTACCESSORYVIEW_CANCEL: Specifies that the input accessory view has a Cancel button. This option does not trigger any events.

Example

//Sample code to set inputAccessoryViewType property for a ListBox widget.

frmList.myList.inputAccessoryViewType= constants.LISTBOX_INPUTACCESSORYVIEWTYPE_DEFAULT;

Platform Availability

• Available in the IDE
• iPhone
• iPad

This property controls the visibility of a widget on the form.

Default: true

If set to false, the widget is not displayed.

If set to true, the widget is displayed.

Syntax

isVisible

Type

Boolean

Read/Write

Yes - (Read and Write)

Remarks

You can also set the visibility of a widget dynamically from code using the setVisibility method.

Example

//Sample code to set isVisible property for a ListBox widget.

frmList.myList.isVisible= true;

Accessible from IDE

Yes

Platform Availability

Available on all platforms

This property determines the lower left corner edge of the widget and is measured from the left bounds of the parent container.

The left property determines the position of the left edge of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. In freeform layout, the distance is measured from the left edge of the parent container. In flow-vertical layout, the distance is measured from the left edge of the parent container. In flow-horizontal layout, the distance is measured from the right edge of the previous sibling widget in the hierarchy.

Syntax

left

Type

String

Read/Write

Read + Write

Remarks

If the layoutType is set as kony.flex.FLOW_HORIZONTAL, the left property is measured from right edge of the left sibling widget.

Example

//Sample code to set the left property for widgets by using DP, Percentage and Pixels.
frmHome.widgetID.left = "50dp";

frmHome.widgetID.left = "10%";

frmHome.widgetID.left = "10px";

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA, and Desktop Web

This property allows you to enable/disable the horizontal scrolling for the selected item in the ListBox Widget.

Syntax

lockTextScroll

Type

Boolean

Read/Write

Yes - (Read and Write)

Remarks

Default:false

If set to true, the scrolling for the selected item is disabled

If set to false, the scrolling for the selected item is enabled

Example

//Sample code to set lockTextScroll property for a ListBox widget.

frmList.myList.lockTextScroll = true;                            

Accessible from IDE

No

Platform Availability

This property is available on Windows Phone 8/8.1 platforms

Specifies the set of values that must be displayed for the user to make a selection from the available choices.

Syntax

masterData

Type

Array

Read/Write

Yes (Read and Write)

Remarks

Default: User Defined (You must specify the key and the display value)

To specify the set of values, click the Ellipsis () button against the property to open the MasterData for ListBox window.

In the Master Data window, you can specify the Key, Display Value, i18N Key, and the Accessibility Config.

You can use the Selected column to specify the choice to be shown as selected when rendered. You can do this by selecting true against the choice that you wish to show as selected.

Select the Use as test data in preview mode option if you want to see the data you enter in the Master Data when you Quick Preview. (For more information on Quick Preview, see the Kony Visualizer User Guide.

If the key or the display value is null/nil, the value will not be listed as one of the available choices.

The accessibilityConfigObject is optional and the object should contain the keys as defined in the accessibilityConfig property.

//Format of the masterData property [ ["key1","value1",accessibilityConfigObject], ["key2","value2",accessibilityConfigObject], ["keyn","valuen",accessibilityConfigObject] ]

Example

//Sample code to set masterData property for a ListBox widget.

//Format of the masterData property with accessibility Object

var dataAccessibility=[
    ["key1", "value1", accessibilityConfigObject],
    ["key2", "value2", accessibilityConfigObject],
    ["keyn", "valuen", accessibilityConfigObject]
];
frmList.myList.masterData=dataAccessibility;
//Format of the masterData property without accessibility Object
var dataList = [
    ["key1", "value1"],
    ["key2", "value2"],
    ["key3", "value3"]
];
frmList.myList.masterData= dataList;

Accessible from IDE

Yes

Platform Availability

Available on all platforms

Specifies the set of values from which you can make selections.You must specify a key and a value in a master data map.

Syntax

masterDataMap

Type

Array

Read/Write

Yes - (Read and Write)

Remarks

This is a non-Constructor property. You cannot set this property through widget constructor. But you can always read and write data to it.

This property is applicable only if the masterData is not set. You must use either the masterData or the masterDataMap to set data for the CheckBox.

You must specify a key, value, and the accessibilityConfig in a master data map.

The accessibilityConfig is the standard key expected in each items data array. It is optional and the object should contain the keys as defined in the accessibilityConfig property.

If the key or the value is null/nil, the value will not be listed as one of the available choices.

Example

//Sample code to set masterDataMap property for a ListBox widget.

//Format of the masterDataMap property without accessibility Object
var list = [
    [{
        "mykey": "key1",
        "myvalue": "value1"
    }, {
        "mykey": "key2",
        "myvalue": "value2"
    }, {
        "mykey": "key3",
        "myvalue": "value3"
    }], "mykey", "myvalue"
];
frmList.myList.masterDataMap=list;
//Format of the masterDataMap property with accessibility Object
var listAccessibility =[
    [{
        "mykey": "key1",
        "myvalue": "value1",
        "accessibilityConfig": acObject
    }, {
        "mykey": "key2",
        "myvalue": "value2",
        "accessibilityConfig": acObject
    }, {
        "mykey": "key3",
        "myvalue": "value3",
        "accessibilityConfig": acObject
    }],
    "mykey", "myvalue"
];
frmList.myList.masterDataMap= listAccessibility;

Accessible from IDE

No

Platform Availability

Available on all platforms.

This property specifies the maximum height of the widget and is applicable only when the height property is not specified.

The maxHeight property determines the maximum height of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. The maxHeight value overrides the preferred, or “autogrow” height, if the maxHeight is less than the derived content height of the widget.

Syntax

maxHeight

Type

Number

Read/Write

Read + Write

Example

//Sample code to set the maxHeight property for widgets by using DP, Percentage and Pixels.
frmHome.widgetID.maxHeight = "50dp";

frmHome.widgetID.maxHeight = "10%";

frmHome.widgetID.maxHeight = "10px";

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA, and Desktop Web

This property specifies the maximum width of the widget and is applicable only when the width property is not specified.

The Width property determines the maximum width of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. The maxWidth value overrides the preferred, or “autogrow” width, if the maxWidth is less than the derived content width of the widget.

Syntax

maxWidth

Type

Number

Read/Write

Read + Write

Example

//Sample code to set the maxWidth property for widgets by using DP, Percentage and Pixels.
frmHome.widgetID.maxWidth = "50dp";

frmHome.widgetID.maxWidth = "10%";

frmHome.widgetID.maxWidth = "10px";

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA, and Desktop Web

This property specifies the minimum height of the widget and is applicable only when the height property is not specified.

The minHeight property determines the minimum height of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. The minHeight value overrides the preferred, or “autogrow” height, if the minHeight is larger than the derived content height of the widget.

Syntax

minHeight

Type

Number

Read/Write

Read + Write

Example

//Sample code to set the minHeight property for widgets by using DP, Percentage and Pixels.
frmHome.widgetID.minHeight = "50dp";

frmHome.widgetID.minHeight = "10%";

frmHome.widgetID.minHeight = "10px";

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA, and Desktop Web

This property specifies the minimum width of the widget and is applicable only when the width property is not specified.

The minWidth property determines the minimum width of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. The minWidth value overrides the preferred, or “autogrow” width, if the minWidth is larger than the derived content width of the widget.

Syntax

minWidth

Type

Number

Read/Write

Read only

Example

//Sample code to set the minWidth property for widgets by using DP, Percentage and Pixels.
frmHome.widgetID.minWidth = "50dp";

frmHome.widgetID.minWidth = "10%";

frmHome.widgetID.minWidth = "10px";

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA, and Desktop Web

Specifies if the widget allows multiple values to be selected from the drop down list.

Default: false

If set to true, an additional property multiSelectRows is displayed.

Syntax

multiSelect

Type

Boolean

Read/Write

No

Example

//Sample code to set multiSelect property for a ListBox widget.

frmList.myList.multiSelect=true;

Accessible from IDE

Yes

Platform Availability

This property is available on Desktop Web

Specifies the number of visible rows in the ListBox. A ListBox in Desktop Web can grow to any length. This property is used to restrict the number of rows visible in a ListBox.

Note: This property is displayed only when the multiSelect is set to true.

Default:

none

Syntax

multiSelectRows

Type

Number

Read/Write

Yes - (Read and Write)

Example

//Sample code to set multiSelectRows property for a ListBox widget.

frmList.myList.multiSelectRows=5;

Accessible from IDE

Yes

Platform Availability

This property is available on Desktop Web

Specifies the skin that is applied to each item in the native popup that appears when you click on the ListBox.

Syntax

nativeListFieldSkin

Type

String

Read/Write

Yes - (Read and Write)

Example

//Sample code to set nativeListFieldSkin property for a ListBox widget.

frmList.myList.nativeListFieldSkin="nativeListNormalSkin";

Accessible from IDE

Yes

Platform Availability

• Android
• BlackBerry

Specifies the skin that is applied to a focused item in the native popup that appears when you click on the ListBox.

Syntax

nativeListFieldFocusSkin

Type

String

Read/Write

Yes - (Read and Write)

Example

//Sample code to set nativeListFieldFocusSkin property for a ListBox widget.

frmList.myList.nativeListFieldFocusSkin="nativeListFSkin";

Accessible from IDE

Yes

Platform Availability

• Android
• BlackBerry

Specifies the opacity of the widget. The value of this property must be in the range 0.0 (transparent) to 1.0 (opaque). Any values outside this range are fixed to the nearest minimum or maximum value.

Specifies the opacity of the widget. Valid opacity values range from 0.0 (transparent), to 1.0 (opaque). Values set to less than zero will default to zero. Values more than 1.0 will default to 1. Interaction events set on a transparent widget will still be fired. To disable the events, also set the “isVisible” property to “false”.

Syntax

opacity

Type

Number

Read/Write

Read + Write

Remarks

Note: This property has more priority compared to the values coming from the configured skin.

Example

//Sample code to make the widget transparent by using the opacity property.
frmHome.widgetID.opacity = 0;

//Sample code to make the widget opaque by using the opacity property.
frmHome.widgetID.opacity = 1;

Platform Availability

• Not available in the IDE.
• iOS, Android, Windows, SPA, and Desktop Web

This property defines the space between the content of the widget and the widget boundaries. You can use this option to define the top, left, right, and bottom distance between the widget content and the widget boundary.

When you are defining the padding (for any platform) the first time, the value that you enter in the padding field (top, left, right, or bottom) is auto-populated across all the platforms.

The following image illustrates a widget with a defined padding:

Syntax

padding

Type

Array of Numbers

Read/Write

Read + Write

Remarks

Due to Browser restrictions, you cannot apply Padding for a ListBox and Form widgets on Mobile Web platform.

If no skin is applied to a Button, then Padding is not supported on iPhone. This is due to iOS Safari browser limitation. If you want the padding to be applied, apply a skin to the button and then apply padding.

Example

//Sample code to set padding property for a ListBox widget.

frmList.myList.padding=[10, 10, 10, 0];

Platform Availability

• Available in IDE
• Available on all platforms.

Indicates if the padding is to be applied in pixels or in percentage.

Default: false

If set to true, the padding is applied in pixels.

If set to false, the padding is applied as set in padding property.

Note: This property can be set to true or false only for iPhone, iPad, Android and Windows Phone. On other platforms this property does not give any results even when set to true.

Note: For backward compatibility on older projects, this property is will be made true for iPhone, iPad, Android and Windows Phone and for other platforms it will be false.

Syntax

paddingInPixel

Type

Boolean

Read/Write

Read Only

Example

//Sample code to set paddingInPixel property for a ListBox widget.

frmList.myList.paddingInPixel =true;

Platform Availability

• Available on all platforms.

Helps you access the parent of the widget. If the widget is not part of the widget hierarchy, the parent property returns null.

Syntax

parent

Read/Write

Read only

Remarks

Note: The property works for all the widgets whether they are placed inside a FlexContainer, a Form, or an HBox.

Example

function func() {

    kony.print("The parent of the widget" + JSON.stringify(Form1.widgetID.parent));

}

Platform Availability

• Not available in the IDE
• iOS, Android, Windows, SPA, and Desktop Web

Specifies the temporary or substitute text (a hint provided as a word or phrase) that must be displayed on the ListBox until the actual selection is made. If you do not specify the placeholder text, the first option in the list is shown as the selected value.

If placeholder is set then by default (without user selecting any option) selectedKey and selectedKeyValue properties will return null/nil.

If placeholder is not set then by default the first entry should be shown as selected and selectedKey and selectedKeyValue properties will return the first options key-value pair.

Syntax

placeholder

Type

String

Read/Write

Yes - (Read and Write)

Example

//Sample code to set placeholder property for a ListBox widget.

frmList.myList.placeholder="Please select a value";

Accessible from IDE

Yes

Platform Availability

• iPad
• iPhone
• Android
• BlackBerry
• Windows Phone
• Windows Desktop

This property reads the font color set in the skin and ignores the other attributes.Android does not support setting a background color for a placeholder.

Syntax

placeholderSkin

Type

String

Read/Write

Yes - (Read and Write)

Example

//Sample code to set placeholderSkin property for a ListBox widget.

frmList.myList.placeholderSkin="plcHolderSkn";

Accessible from IDE

Yes

Platform Availability

This property is available on Android/Android Tablet platform only.

Specifies the icon that appears in the title area of the popup (on the top left side of the popup). For the popup to appear, you have to expand or click the Listbox.

Syntax

popupIcon

Type

String / image Object

Read/Write

No

Remarks

Default: empty

You can create an image Object by using kony.image Namespace functions.

The figure below depicts how a Popup Icon in a List Box looks:

Example

Using a local resource for the popup icon:

/*Sample code to set the popupIcon property of a ListBox widget where icon.png is an image file in the resources folder.*/
frmList.myList.popupIcon="icon.png";

Using a Kony image object (kony.imagefor the popup icon:

/*Sample code to set the popupIcon property of a ListBox widget where local.png is an image file in the resources folder.*/

var imgObjRef = kony.image.createImage("local.png");
frmList.myList.popupIcon=imgObjRef;

Platform Availability

Accessible from IDE

• Android

Specifies the Title text to be displayed for the Listbox.

Default:Please Select (This is the default text that will appear as the title of the Listbox)

Syntax

popupTitle

Type

String

Read/Write

No

Example

//Sample code to set the popupTitle property of a ListBox widget.

frmList.myList.popupTitle="List of items";

Accessible from IDE

Yes

Platform Availability

• Android
• Symbian

The property helps you change the background color of the ListBox title.

You can specify the color in the RGBA hex format. The format could be 0xRGBA or RGBA. The RGBA format followed is the standard RGBA format and is not the same as the RGBA color code generated by Kony IDE for skins.

For example, the formats, 0xFF0000FF and FF0000FF are valid for red.

Syntax

popupTitleBackgroundColor

Type

String

Read/Write

Read + Write

Example

//Sample code to set the popupTitleBackgroundColor property of a ListBox widget.
frmList.myList.popupTitleBackgroundColor = "ff0000ff";

Platform Availability

• Android

This property is used to retain the content alignment property value, as it was defined.

Note: Locale-level configurations take priority when invalid values are given to this property, or if it is not defined.

The mirroring widget layout properties should be defined as follows.

function getIsFlexPositionalShouldMirror(widgetRetainFlexPositionPropertiesValue) {
    return (isI18nLayoutConfigEnabled &&
    localeLayoutConfig[defaultLocale]
    ["mirrorFlexPositionalProperties"] == true &&
    !widgetRetainFlexPositionPropertiesValue);
}

The following table illustrates how widgets consider Local flag and Widget flag values.

Syntax

retainContentAlignment

Type

Boolean

Read/Write

No (only during widget-construction time)

Example

//This is a generic property that is applicable for various widgets.
//Here, we have shown how to use the retainContentAlignment property for Button widget.
/*You need to make a corresponding use of the 
retainContentAlignment property for other applicable widgets.*/
var btn = new kony.ui.Button({
    "focusSkin": "defBtnFocus",
    "height": "50dp",
    "id": "myButton",
    "isVisible": true,
    "left": "0dp",
    "skin": "defBtnNormal",
    "text": "text always from top left",
    "top": "0dp",
    "width": "260dp",
    "zIndex": 1
}, {
    "contentAlignment": constants.CONTENT_ALIGN_TOP_LEFT,
    "displayText": true,
    "padding": [0, 0, 0, 0],
    "paddingInPixel": false,
    "retainFlexPositionProperties": false,
    "retainContentAlignment": true
}, {});

Platform Availability

• Available in IDE
• Windows 10, iOS, Android, and SPA

This property is used to retain flex positional property values as they were defined. The flex positional properties are left, right, and padding.

Note: Locale-level configurations take priority when invalid values are given to this property, or if it is not defined.

The mirroring widget layout properties should be defined as follows.

function getIsFlexPositionalShouldMirror(widgetRetainFlexPositionPropertiesValue) {
    return (isI18nLayoutConfigEnabled &&
    localeLayoutConfig[defaultLocale]
    ["mirrorFlexPositionalProperties"] == true &&
    !widgetRetainFlexPositionPropertiesValue);
}

The following table illustrates how widgets consider Local flag and Widget flag values.

Syntax

retainFlexPositionProperties

Type

Boolean

Read/Write

No (only during widget-construction time)

Example

//This is a generic property that is applicable for various widgets.
//Here, we have shown how to use the retainFlexPositionProperties property for Button widget.
/*You need to make a corresponding use of the 
retainFlexPositionProperties property for other applicable widgets.*/
var btn = new kony.ui.Button({
    "focusSkin": "defBtnFocus",
    "height": "50dp",
    "id": "myButton",
    "isVisible": true,
    "left": "0dp",
    "skin": "defBtnNormal",
    "text": "always left",
    "top": "0dp",
    "width": "260dp",
    "zIndex": 1
}, {
    "contentAlignment": constants.CONTENT_ALIGN_CENTER,
    "displayText": true,
    "padding": [0, 0, 0, 0],
    "paddingInPixel": false,
    "retainFlexPositionProperties": true,
    "retainContentAlignment": false
}, {});

Platform Availability

• Available in IDE
• Windows 10, iOS, Android, and SPA

This property is used to convert Flow Horizontal Left to Flow Horizontal Right.

Note: Locale-level configurations take priority when invalid values are given to this property, or if it is not defined.

The mirroring widget layout properties should be defined as follows.

function getIsFlexPositionalShouldMirror(widgetRetainFlexPositionPropertiesValue) {
    return (isI18nLayoutConfigEnabled &&
    localeLayoutConfig[defaultLocale]
    ["mirrorFlexPositionalProperties"] == true &&
    !widgetRetainFlexPositionPropertiesValue);
}

The following table illustrates how widgets consider Local flag and Widget flag values.

Syntax

retainFlowHorizontalAlignment

Type

Boolean

Read/Write

No (only during widget-construction time)

Example

//This is a generic property that is applicable for various widgets.
//Here, we have shown how to use the retainFlowHorizontalAlignment property for Button widget.
/*You need to make a corresponding use of the 
retainFlowHorizontalAlignment property for other applicable widgets. */
var btn = new kony.ui.Button({
 "focusSkin": "defBtnFocus",
 "height": "50dp",
 "id": "myButton",
 "isVisible": true,
 "left": "0dp",
 "skin": "defBtnNormal",
 "text": "always left",
 "top": "0dp",
 "width": "260dp",
 "zIndex": 1
}, {
 "contentAlignment": constants.CONTENT_ALIGN_CENTER,
 "displayText": true,
 "padding": [0, 0, 0, 0],
 "paddingInPixel": false,
 "retainFlexPositionProperties": true,
 "retainContentAlignment": false,
 "retainFlowHorizontalAlignment ": false
}, {});

Platform Availability

• Available in IDE
• Windows 10, iOS, Android, and SPA

This property determines the lower right corner of the widget and is measured from the right bounds of the parent container.

The right property determines the position of the right edge of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. In freeform layout, the distance is measured from the left edge of the parent container. In flow-vertical layout, value is ignored. In flow-horizontal layout, the value is ignored.

The right property is used only if the width property is not provided.

Syntax

right

Type

String

Read/Write

Read + Write

Remarks

If the layoutType is set as kony.flex.FLOW_HORIZONTAL, the right property is measured from left edge of the right sibling widget. The horizontal space between two widgets is measured from right of the left sibling widget and left of the right sibling widget.

Example

//Sample code to set the right property for widgets by using DP, Percentage and Pixels.
frmHome.widgetID.right = "50dp";

frmHome.widgetID.right = "10%";

frmHome.widgetID.right = "10px";

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA, and Desktop Web

Represents the key that is shown as selected.

If you do not select a value, the return value is null/nil.

Syntax

selectedKey

Type

String

Read/Write

Yes - (Read and Write)

Example

//Sample code to set the selectedKey property of a ListBox widget.

frmList.myList.masterData = [
 ["key1", "value1"],
 ["key2", "value2"],
 ["key3", "value3"]
];
frmList.myList.selectedKey = "key1";

Accessible from IDE

No

Platform Availability

Available on all platforms.

Returns the keys from the data representing the selected keys.

If you set the selectedkeys to null/nil, the selection is cleared.

Syntax

selectedKeys

Type

Array

Read/Write

Yes - (Read and Write)

Example

//Sample code to set the selectedKeys property of a ListBox widget.

frmList.myList.masterData = [
 ["key1", "value1"],
 ["key2", "value2"],
 ["key3", "value3"]
];
frmList.myList.selectedKeys = ["key1", "key2"];

Accessible from IDE

No

Platform Availability

Available on Desktop Web platform only

Returns the array of selected key-value pair.

If you do not select a value, the return value is null/nil.

Syntax

selectedKeyValue

Type

Array

Read/Write

Yes - (Read only)

Example

//Sample code to read the selectedKeyValue property of a ListBox widget.

frmList.myList.masterData = [
 ["key1", "value1"],
 ["key2", "value2"],
 ["key3", "value3"]
];
frmList.myList.selectedKey = "key1";
	
alert("The selected key value of the listbox is::"+frmList.myList.selectedKeyValue);

Accessible from IDE

No

Platform Availability

Available on all platforms.

Returns the array of selected key-value pair from the data representing the selected key and value.

If you do not select a value, the return value is null/nil.

Syntax

selectedKeyValues

Type

Array

Read/Write

Yes - (Read only)

Example

//Sample code to read the selectedKeyValues property of a ListBox widget.

frmList.myList.masterData = [
 ["key1", "value1"],
 ["key2", "value2"],
 ["key3", "value3"]
];
frmList.myList.selectedKeys = ["key1", "key2"];
	
alert("The selected key value of the listbox is::"+frmList.myList.selectedKeyValues);

Accessible from IDE

No

Platform Availability

Available on Desktop Web platform only

Defines the depth of the shadow effect applied to the ListBox Widget.

Syntax

shadowDepth

Type

Number

Read/Write

Read + Write

Remarks

The depth of the shadow should be specified in DP (Device Independent Pixels) units. The higher the value of shadowDepth, the appearance of the ListBox Widget is elevated from the screen and the casted shadow becomes soft.

Example

 //Sample code to set the shadowDepth property of a ListBox widget.
frmList.myList.shadowDepth = 10;

Platform Availability

• Android 5.0 and later versions.

Sets a type of the shadow effect to apply to the ListBox Widget.

Syntax

shadowType

Type

Number

Read/Write

Read + Write

Remarks

The property specifies a shape to the widget's shadow that is cast. You can apply any one of the following shadow types:

VIEW_BOUNDS_SHADOW: Shadow matches the widget's rectangular bounds.

PADDED_VIEW_BOUNDS_SHADOW: Shadow matches the widget's rectangular padded bounds.

BACKGROUND_SHADOW: Shadow matches the widget's background. This is the default value.

Example

//Sample code to set shadowType property of a ListBox widget.
frmList.myList.shadowType = constants.VIEW_BOUNDS_SHADOW;

Platform Availability

• Android 5.0 and later versions.

This property provides you to show or hide the app menu when the dialog is open.

Default:true

When this property is set to true, the app menu is visible.

When this property is set to false, the app menu is hidden.

Syntax

showAppMenu

Type

Boolean

Read/Write

Yes - (Read and Write)

Example

//Sample code to set the showAppMenu property of a ListBox widget.
frmList.myList.showAppMenu=true;

Accessible from IDE

No

Platform Availability

This property is available on Windows 8.1 platform only.

When the singleLineText property is set to 'true', this property controls the position of the ellipses (...), in the selected option text.

Default:False

Syntax

singleLineText

Type

Boolean

Read/Write

Yes - (Read and Write)

Example

//Sample code to set the singleLineText property of a ListBox widget.
frmList.myList.singleLineText=true;

Accessible from IDE

No

Platform Availability

• Android/Android tablet
• Windows 10

Remarks

• For Windows 10: If you set the value of the singleLineText property as 'true', the textTruncatePosition, singleLineTextInPopup, and textTruncatePositionInPopup properties are not considered. So, if the length of the text in the ListBox is more than the available space, the selected options text and the popup options text are displayed in a truncated manner, i.e., in a single line with ellipses (...). The position of the ellipses is always at the end of the text line.

When thIS property is set to true, this property controls the position of the ellipses (...), in the popup options text.

Default:False

Syntax

singleLineTextInPopup

Type

Boolean

Read/Write

Yes - (Read and Write)

Example

//Sample code to set the singleLineTextInPopup property of a ListBox widget.
frmList.myList.singleLineTextInPopup=true;

Accessible from IDE

No

Platform Availability

This property is available on Android/Android Tablet platform

Specifies a background skin for ListBox widget.

Note: For Desktop Web platform, Chrome browser does not support if the properties defined in font tab are different for skin and focusSkin.

Note: For iOS platform, only background color is supported.

Syntax

skin

Type

String

Read/Write

Yes - (Read and Write)

Example

//Sample code to set the skin property of a ListBox widget.
frmList.myList.skin="listSkin";

Accessible from IDE

Yes

Platform Availability

Available on all platforms

If the length of the text is more than the available space, the selected options text and the popup options text are displayed in a truncated manner, in a single line with ellipses (...). The position of the ellipses is controlled by the textTruncatePosition property. The default ellipses position is at the end of the line if textTruncatePosition property is not set.

Syntax

textTruncatePosition

Type

Number

Read/Write

Yes - (Read and Write)

Remarks

The options are:

constants.TEXT_TRUNCATE_START

constants.TEXT_TRUNCATE_MIDDLE

constants.TEXT_TRUNCATE_END

Default Value:

• For Android: constants.TEXT_TRUNCATE_END
• For iOS: constants.TEXT_TRUNCATE_MIDDLE

Example

//Sample code to set the textTruncatePosition property of a ListBox widget.
frmList.myList.textTruncatePosition= constants.TEXT_TRUNCATE_MIDDLE;

Accessible from IDE

No

Platform Availability

• Android/Android tablet
• iOS

If the length of the text is more than the space available, the popup options text will be displayed truncated, in a single line with (...) ellipses. The position of the ellipses is controlled by textTruncatePositionInPopup property. The default ellipses position is at the end of the line if textTruncatePositionInPopup property is not set.

Syntax

textTruncatePositionInPopup

Type

Number

Read/Write

Yes - (Read and Write)

Remarks

The options are:

constants.TEXT_TRUNCATE_START

constants.TEXT_TRUNCATE_MIDDLE

constants.TEXT_TRUNCATE_END

Default:constants.TEXT_TRUNCATE_END

Accessible from IDE

No

Platform Availability

This property is available on Android/Android Tablet platform

Example

//Sample code to set the textTruncatePositionInPopup property of a ListBox widget.
frmList.myList.textTruncatePositionInPopup= constants.TEXT_TRUNCATE_MIDDLE;

Accessible from IDE

No

Platform Availability

This property is available on Android/Android Tablet platform

Specifies the image to be displayed when you make a selection.

Syntax

tickedImage

Type

String / image Object

Read/Write

No

Remarks

Note: If you specify a ticked Image, ensure that you also specify an unTickedimage. If not specified, the behavior will be undefined.

Note: You can create an image Object by using kony.image Namespace functions.

Example

Using a string to define a local resource for the image:

 /*Sample code to set the tickedImage property of a ListBox widget where tickImg.png is an image file in the resources folder.*/
frmList.myList.tickedImage="tickImg.png";

Using a Kony image object (kony.image) to define the image:

 /*Sample code to set the tickedImage property of a ListBox widget where local.png is an image file in the resources folder.*/
var imgObjRef = kony.image.createImage("local.png");
frmList.myList.tickedImage=imgObjRef;

Platform Availability

Accessible from IDE

• iOS
• Android

The property helps you align the title of the ListBox Widget.

Syntax

titleAlignment

Type

Number

Read/Write

Read + Write

Remarks

The following are the possible values that you can specify for the property.

• LISTBOX_TITLE_ALIGN_LEFT - Aligns the title to left. This is the default value.
• LISTBOX_TITLE_ALIGN_CENTER - Aligns the Title to center.
• LISTBOX_TITLE_ALIGN_RIGHT - Aligns the Title to right.

Note: If you specify any value other than the preceding values, the default value is set.

Example

//Sample code to set the titleAlignment property of a Listbox widget.
frmList.myList.titleAlignment = constants.LISTBOX_TITLE_ALIGN_RIGHT;

Platform Availability

• Android

The property helps you align the title icon of the ListBox Widget.

Syntax

titleIconAlignment

Type

Number

Read/Write

Read + Write

Remarks

The following are the possible values that you can specify for the property.

• LISTBOX_TITLE_ICON_ALIGN_LEFT - Aligns the Title icon to the left. This is the default value.
• LISTBOX_TITLE_ICON_ALIGN_RIGHT - Aligns the Title icon to the right.

Note: If you specify any value other than the preceding values, the default value is set.

Example

//Sample code to set the titleIconAlignment property of a ListBox widget.
frmList.myList.titleIconAlignment = constants.LISTBOX_TITLE_ICON_ALIGN_RIGHT;

Platform Availability

• Android

Specifies the hint text when the cursor hovers over a widget, without clicking it. The text entered in the tooltip appears as a small box when the cursor hovers over a widget.

Syntax

toolTip

Type

String

Read/Write

Yes - (Read and Write)

Example

//Sample code to set the toolTip property of a ListBox widget.
frmList.myList.toolTip= "sample text";

Accessible from IDE

Yes

Platform Availability

• Windows Tablet
• Windows Desktop

This property determines the top edge of the widget and measured from the top bounds of the parent container.

The top property determines the position of the top edge of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. In freeform layout, the distance is measured from the top edge of the parent container. In flow-vertical layout, the distance is measured from the bottom edge of the previous sibling widget in the hierarchy. In flow-horizontal layout, the distance is measured from the left edge of the parent container.

Syntax

top

Type

String

Read/Write

Read + Write

Remarks

If the layoutType is set as kony.flex.FLOW_VERTICAL, the top property is measured from the bottom edge of the top sibling widget. The vertical space between two widgets is measured from bottom of the top sibling widget and top of the bottom sibling widget.

Example

//Sample code to set the top property for widgets by using DP, Percentage and Pixels.
frmHome.widgetID.top = "50dp";

frmHome.widgetID.top = "10%";

frmHome.widgetID.top = "10px";

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA,and Desktop Web

Contains an animation transformation that can be used to animate the widget.

Syntax

transform

Type

JSObject

Read/Write

Read + Write

Remarks

This property is set to the identify transform by default. Any transformations applied to the widget occur relative to the widget's anchor point. The transformation contained in this property must be created using the kony.ui.makeAffineTransform function.

Example

This example uses the button widget, but the principle remains the same for all widgets that have a transform property.

//Animation sample
var newTransform = kony.ui.makeAffineTransform();
newTransform.translate3D(223, 12, 56);

//translates by 223 xAxis,12 in yAxis,56 in zAxis
widget.transform = newTransform;

Platform Availability

• iOS, Android, Windows, and SPA

Specifies the image to be displayed when a selection is cleared.

Syntax

unTickedImage

Type

String / image Object

Read/Write

No

Remarks

Note: If you specify an unTickedImage, ensure that you also specify a tickedImage. If not specified, the behavior will be undefined.

Note: You can create an image Object by using kony.image Namespace functions.

Example

Defining the image using a local resource:

 /*Sample code to set the untickedImage property of a ListBox widget where untickImg.png is an image file in the resources folder.*/
frmList.myList.untickedImage="untickImg.png";

Defining the image using a Kony image object (kony.image):

 /*Sample code to set the untickedImage property of a ListBox widget where local.png is an image file in the resources folder.*/
var imgObjRef = kony.image.createImage("local.png");
frmList.myList.untickedImage=imgObjRef;

Platform Availability

Accessible from IDE

• iOS
• Android

Specifies if the widget has to occupy all the vertical space available to it.

Syntax

vExpand

Type

Boolean

Read/Write

No

Remarks

Mobile Web does not support the Expand property. This is because a widget in a Mobile Web cannot expand or contract based on the neighboring widget (default behavior of a widget in a Mobile Web).

Default:false

• If set to true, the widget occupies the entire available height.
• If set to false, the widget occupies the preferred height.

Example

//Sample code to set the vExpand property of a ListBox widget.
frmList.myList.vExpand=true;

Accessible from IDE

Yes

Platform Availability

Available on all platforms

Specifies the view configuration for different viewtypes.

Syntax

viewConfig

Type

JSObject

Read/Write

Yes - (Read and Write)

Remarks

You can set the configuration for toggle view.

toggleViewConfig: The property to configure the properties of LISTBOX_VIEW_TYPE_TOGGLEVIEW.

viewStyle: Accepts the view style. This property is not supported in iOS7 and above versions. Following are the available options:

LISTBOX_TOGGLE_VIEW_STYLE_PLAIN

LISTBOX_TOGGLE_VIEW_STYLE_BORDERED

LISTBOX_TOGGLE_VIEW_STYLE_BAR

equalSegments: Specifies the boolean value which indicates if the segments must be equal.

enableTint: Specifies the boolean value to enable tintColor property. When this property is set to true, tintColor property is displayed.

tintColor: Specifies the tint color in RGB format. The default color is blue.

Example

//Sample code to set the viewConfig property of a ListBox widget.
frmList.myList.viewConfig = {
 toggleViewConfig: {
  equalSegments: true
 }
};

Accessible from IDE

Yes

Platform Availability

• iPad
• iPhone

Specifies the view type of the ListBox.

Syntax

viewType

Type

Number

Read/Write

Yes - (Read and Write)

Remarks

Default: LISTBOX_VIEW_TYPE_LISTVIEW

Following are the available options on various platforms:

LISTBOX_VIEW_TYPE_LISTVIEW (applicable on all platforms)

LISTBOX_VIEW_TYPE_TABLEVIEW (applicable on iPhone and iPad platforms)

LISTBOX_VIEW_TYPE_TOGGLEVIEW (applicable on iPhone and iPad platforms)

LISTBOX_VIEW_TYPE_ONSCREENWHEEL (applicable on iPhone and iPad platforms)

LISTBOX_VIEW_TYPE_SPINNER (applicable on Android/Android Tablet only)

LISTBOX_VIEW_TYPE_EDITVIEW (applicable on Desktop Web only)

For toggleView you can further select the View Style as plain, bordered, or bar.

The following images illustrate the modes:

listView

If you select the listView and do not specify a selection in the masterData, the default behavior of the platform is to select the first entry on the list.

tableView

toggleView

onscreenwheel

spinner

The below image illustrate the nextprevtoolbar set to a listbox. The highlighted toolbar is achieved on setting the Mode as onscreenwheel to the List Box and Input Accessory View Type as nextprevtoolbar to the Form.

For editview viewType

• Users can use this viewType to change the colour of a drop-down item on hover, which is not possible with the select attribute provided by html for list. You can customize drop-down items to a great extent and use this to cater to the needs of users with respect to drop-down type widgets in a better manner. This is applicable only for Desktop Web.
• Assumptions:

  • The ListBox widget has to be dynamically created in order to use the editview viewType, which is defined as a platform-specific property (pspconfig) for this widget.

  • You can update masterData, selectedKey, editableAreaSkin, viewtType, and autoSuggest.

• Limitations:

  • The editview viewType is available only in Desktop Web.

  • The editview viewType supports only single select, so there is no option of selectedKeys.

Example (for editview)

//Sample code to set the viewType property of a ListBox widget as editview.
//This is applicable only for Desktop Web platform.
frmList.myList.viewType = constants.LISTBOX_VIEW_TYPE_EDITVIEW;

Example (for changing the color of a drop-down item on hover)

div[name="SelectOptionList"]:hover
{
  background-color:" #800000" !important;
    color: "#FFFFFF";
} //Creating a custom CSS of background color (Maroon)

Example (for viewType)

//Sample code to set the viewType property of a ListBox widget as LISTBOX_VIEW_TYPE_SPINNER.
frmList.myList.viewType = constants.LISTBOX_VIEW_TYPE_SPINNER;

Accessible from IDE

Yes

Platform Availability

• iPad
• iPhone
• Android/Android Tablet ( only Spinner view is available for the platform)

Specifies the background color for the wheel that is displayed when you click the ListBox. This property is applicable only when you set the viewType as LISTBOX_VIEW_TYPE_ONSCREENWHEEL.

Syntax

wheelBackgroundColor

Type

JSObject

Read/Write

Yes - (Read and Write)

Example

//Sample code to set the wheelBackgroundColor property of a ListBox widget.
frmList.myList.wheelBackgroundColor="0000ff00";

Accessible from IDE

No

Platform Availability

• iPad
• iPhone

Indicates how a widget is to be anchored with respect to its parent. Each of these below options have a horizontal alignment attribute and a vertical alignment attribute. For example, WIDGET_ALIGN_TOP_LEFT specifies the vertical alignment as TOP and horizontal alignment as LEFT.

Default: WIDGET_ALIGN_CENTER

The available options are:

• WIDGET_ALIGN_TOP_LEFT
• WIDGET_ALIGN_TOP_CENTER
• WIDGET_ALIGN_TOP_RIGHT
• WIDGET_ALIGN_MIDDLE_LEFT
• WIDGET_ALIGN_CENTER
• WIDGET_ALIGN_MIDDLE_RIGHT
• WIDGET_ALIGN_BOTTOM_LEFT
• WIDGET_ALIGN_BOTTOM_CENTER
• WIDGET_ALIGN_BOTTOM_RIGHT

Syntax

widgetAlignment

Type

Number

Read/Write

No

Example

//Sample code to set the widgetAlignment property of a ListBox widget.
frmList.myList.widgetAlignment=constants.WIDGET_ALIGN_CENTER;

Accessible from IDE

Yes

Platform Availability

Available on all platforms

This property is used to enable and configure left or right swipe actions for a widget. The widgetSwipeMove Property can be used for all widgets . The most common use case is for implementing swipe action for individual rows in Segment.

Syntax

widgetSwipeMove

Type

String

Read/Write

Read + Write

Input Parameters

The following table consists of the parameters of the callback parameter:

Remarks

• For a Segment, the widgetSwipeMove Property is configured while setting the data of the Segment.

Note: It is not recommended to assign the widgetSwipeMove property on a top Flex container of the segment template widget.

Limitations

• When a translation animation is applied to the same widget that has widgetSwipeMove already configured, the action which has been performed last takes precedence. For example, if you have set a translation animation on a FlexContainer and then set the widgetSwipeMove property, the actions set in widgetSwipeMove take precedence over the translation animation.
• The state of the swipe transition of the widget is not retained.
• In a Segment, the widgetSwipeMove Property must be configured for the rows so that they reset to the previous position.

• If the widgetSwipeMove property is configured on a top level Flex container of a segment template, the onRowClick event will not be triggered. - Applicable on iOS, Android, and SPA.
• Android limitation: On Android devices, when the user lifts their finger, the transition occurs immediately.

Example

Following is a code snippet for a mail app. Here we have used a Segment for listing the mail and the widgetSwipeMove Property has been configured for the SwipeFlex FlexContainer.

//This is a generic property that is applicable for various widgets.
//Here, we have shown how to use the widetSwipeMove property for Button widget.
/*You need to make a corresponding use of the 
widgetSwipeMove property for other applicable widgets.*/
//Example of a swipe move configuration.

var swipeMoveConfig = {
 "translate": true,
 "Xboundaries": ["-60%", "60%"],
 "swipeLeft": [{
  "translateRange": ["-60%", "0%"],
  "callback": null,
  "translatePos": "-60%",
  "translate": true
 }, {
  "translateRange": ["0%", "60%"],
  "callback": null,
  "translatePos": "0%",
  "translate": true
 }],
 "swipeRight": [{
  "translateRange": ["-60%", "0%"],
  "callback": null,
  "translatePos": "0%",
  "translate": true
 }, {
  "translateRange": ["0%", "60%"],
  "callback": this.onCallback1,
  "translatePos": "60%",
  "translate": true
 }]
};

this.view.myButton.widgetSwipeMove=swipeMoveConfig;

Platform Availability

• iOS, SPA

This property determines the width of the widget and is measured along the x-axis.

The width property determines the width of the widget’s bounding box. The value may be set using DP (Device Independent Pixels), Percentage, or Pixels. For supported widgets, the width may be derived from either the widget or container’s contents by setting the width to “preferred”.

Syntax

width

Type

Number, String, and Constant

Read/Write

Read + Write

Remarks

Following are the options that can be used as units of width:

• %: Specifies the values in percentage relative to the parent dimensions.
• px: Specifies the values in terms of device hardware pixels.
• dp: Specifies the values in terms of device independent pixels.
• default: Specifies the default value of the widget.
• kony.flex.USE_PREFERED_SIZE: When this option is specified, the layout uses preferred width of the widget as width and preferred size of the widget is determined by the widget and may varies between platforms.

Example

//Sample code to set the width property for widgets by using DP, Percentage and Pixels.
frmHome.widgetID.width = "50dp";

frmHome.widgetID.width = "10%";

frmHome.widgetID.width = "10px";

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA, and Desktop Web

This property specifies the stack order of a widget. A widget with a higher zIndex is always in front of a widget with a lower zIndex.

The zIndex property is used to set the stack, or layer order of a widget. Widgets with higher values will appear “over”, or “on top of” widgets with lower values. Widgets layered over other widgets will override any interaction events tied to widgets beneath. Modifying the zIndex does not modify the order of the widgets in the Kony hierarchy, inside of a flexContainer or form. zIndex accepts both negative and positive values.

Syntax

zIndex

Type

Number

Read/Write

Read + Write

Remarks

The default value for this property is 1.

Note: Modifying the zIndex does not modify the order of the widgets inside the FlexContainer. If zIndex is same for group of overlapping widgets then widget order decides the order of overlapping. The last added widget is displayed on top.

Example

//Sample code to set the zIndex property for widgets.
frmHome.widgetID.zIndex = 300;

Platform Availability

• Available in the IDE
• iOS, Android, Windows, SPA, and Desktop Web