Calendar 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 the appointment data as an array of objects. This property is not a constructor property.

Syntax

appointmentData

Type

JSObject

Read/Write

Read + Write

Remarks

You can pass either a null or an array of appointment. For example,

//format of the appointment data.
var data = [{
    "startData": "2014-10-12 00:00:00",
    "endDate": "2014-10-13 04:00:00",
    "Subject": "Travel to Paris",
    "isAllDay": false,
    "Location": "Paris, France",
    "Description": "Travel to Paris for a meeting",
    "skin": {
        "cellcolor": "#FF09609"
    },
    "info": {}
}, {
    "startData": "2014-10-14 00:00:00",
    "endDate": "2014-10-15 04:00:00",
    "Subject": "Travel to Paris",
    "isAllDay": false,
    "Location": "Paris, France",
    "Description": "Travel to Paris for a meeting",
    "skin": {
        "cellcolor": "#FF09609"
    },
    "info": {}
}];

Form1.calendar1.appointmentData = data;

Platform Availability

Available on WindowsPhone 8/8.1 platform

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

Replaces the system default calendar icon.

Syntax

calendarIcon

Type

String / image Object

Read/Write

Read + Write

Remarks

This property is applicable only when the viewType is set as CALENDAR_VIEW_TYPE_GRID_POPUP.

The value can either be a reference to a local image resource, or a Kony image object.

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

Example

Using a string to indicate a local resource reference:

//Sample code to set calendarIcon property for a Calendar widget.

frmCalendar.myCalendar.calendarIcon="cal.png";

Using a image object (kony.image):

imgObjRef = kony.image.createImage("local.png");
frmCalendar.myCalendar.calendarIcon = imgObjRef;

Platform Availability

• Available in the IDE
• iOS
• Android
• Windows

This property helps you to configure the position of the calendar icon inside the calendar input box.

Syntax

calendarIconAlignment

Type

Number

Read/Write

Read + Write

Remarks

The default value of the calendarIconAlignment property is constants.CALENDAR_ICON_ALIGN_RIGHT.

You can specify any of the following values for this property.

• constants.CALENDAR_ICON_ALIGN_RIGHT : When you set this value, the calendar icon is set to the right of the calendar input box.
  
• constants.CALENDAR_ICON_ALIGN_LEFT: When you set this value, the calendar icon is set to the left of the calendar input box.

  Note: When RTL is enabled for the application, even if you specify the value as RIGHT or LEFT, the position of the calendar icon does not change.

• constants.CALENDAR_ICON_ALIGN_AUTO :Behavior of this constant depends on the RTL feature configuration.
  When you configure this constant, if RTL is disabled, the calendar icon is set to the right of the calendar input box.
  
  When you configure this constant, if RTL is enabled, the position of the calendar icon depends on the value of the contentAlignment property of the Calendar widget. The following table lists the expected position of the calendar icon in this scenario, with the expected alignment of the content.

Example

//Sample code to set the calendarIconAlignment property for a Calendar widget.

frmCalendar.myCalendar.calendarIconAlignment=constants.CALENDAR_ICON_ALIGN_RIGHT;

Platform Availability

• Desktop Web, SPA, iOS, Android

This property is used to provide a languagefor the DatePicker.

Syntax

calendarLanguage

Type

String

Read/Write

Read + Write

Remarks

The possible value for this property are:

• "GregorianCalendar"
• "HebrewCalendar"
• "HijriCalendar"
• "JapaneseCalendar"
• "JulianCalendar"
• "KoreanCalendar"
• "TaiwanCalendar"
• "ThaiCalendar"
• "UmAlQuraCalendar"

Example

Form1.calendar1.calendarLanguage="GregorianCalendar";

Platform Availability

• Windows 10

This property is available only when viewType is set as CALENDAR_VIEW_TYPE_GRID_POPUP or CALENDAR_VIEW_TYPE_GRID_ONSCREEN.

Syntax

cellTemplate

Type

kony.ui.FlexContainer- [Mandatory]

Read/Write

Read + Write

Remarks

The default value for this property is None.

It specifies the common template to be used for a Calendar Day cell. A template can be used only when the data is present for a Calendar Day cell set through data property or setData method. If the data is not set to a cell, the cell is displayed with the default look without any template.

You can define a template using the following widgets:

• HBox
• VBox
• Label
• Button
• Image

Example

/*Sample code to set cellTemplate property for a Calendar widget where calcellTemplate is the template.*/

frmCalendar.myCalendar.cellTemplate=calcellTemplate;

Platform Availability

• Available in the IDE
• iOS
• Android

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

This property is available only when viewType is set as CALENDAR_VIEW_TYPE_GRID_POPUP or CALENDAR_VIEW_TYPE_GRID_ONSCREEN.

Syntax

containerHeight

Type

Number

Read/Write

Read + Write

Remarks

It specifies the available height of the container in terms of percentage. The percentage is with reference to the value of containerHeightReference property.

Example

//Sample code to set containerHeight property for a Calendar widget.

frmCalendar.myCalendar.containerHeight=100;

Platform Availability

• Available in the IDE
• iPhone
• iPad

This property is available only when viewType is set as CALENDAR_VIEW_TYPE_GRID_POPUP or CALENDAR_VIEW_TYPE_GRID_ONSCREEN and when you set the containerHeight.

Syntax

containerHeightReference

Type

Number

Read/Write

Read + Write

Remarks

The default value for this property is HEIGHT_BY_FORM_REFERENCE.

The container height percentage is calculated based on the below options.

• HEIGHT_BY_FORM_REFERENCE: The Calendar height is percentage calculated based on the height of the Form excluding headers and footers.
• HEIGHT_BY_PARENT_WIDTH: Use this option if the Calendar is placed inside a Box. The width is calculated based on the width of the Box.

To set the value through code, prefix the option with constants. such as constants.<option>.

Example

//Sample code to set containerHeightReference property for a Calendar widget.

frmCalendar.myCalendar.containerHeightReference=constants.HEIGHT_BY_FORM_REFERENCE;

Platform Availability

• Available in the IDE
• iPhone
• iPad

This property specifies the alignment of the text on the widget with respect to its boundaries.

Syntax

contentAlignment

Type

Number

Read/Write

Read+Write

Remarks

The default value for the property is CONTENT_ALIGN_CENTER.

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

Limitations

Desktop Web/ SPA platforms do not support contentAlignment property in Camera widget, ComboBox widget and ListBox widget.

Example

/*Sample code to set the contentAlignment property of the widgetID Button widget in frmHome Form.*/

frmHome.widgetID.contentAlignment=constants.CONTENT_ALIGN_TOP_LEFT;

Platform Availability

• Available in IDE
• Available on all platforms

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

A JSObjects that represents the actual data to be rendered in each cell.

Syntax

data

Type

JSObject

Read/Write

Read + Write

Example

Format of the data is follows:

//Format for the JS Object for the data property of Calendar widget.
var data1 = {
    "12/11/2012": {
        template: newBox,
        lblAppointments: "4",
        lblTasks: "2"
    },
    "02/01/2012": {
        "lblAppointments": "4",
        "lblTasks": "21"
    }
};

frmHome.mycal.setData(data1);

To specify the data, follow these steps:

1. Click the Ellipsis () button against the cellTemplate property. The Select/Search gridCalendars window appears.
2. Select the template and click OK. The template is now assigned to a calendar.
3. Click the Ellipsis () button against the data property.The Master Data for GridCalendar window appears.

4. Click button to add a row and select the Date and then update Template Data.
5. Click OK.

Platform Availability

• Available in the IDE
• iOS
• Android

Specifies the default date that must appear in the Date field.

Syntax

dateComponents

Type

Array

Read/Write

Read + Write

Remarks

The value should be an array object with six elements in [dd, mm, yyyy, hh, mm, ss] format.

If a platform or the particular calendar view doesn't support the user to set the hh, mm, ss then they always are set 00:00:00 by default irrespective of what developer sets. Individual platforms need to cross check this per view basis and add it to the final documentation.

To specify a date for the calendar

1. Click the Ellipsis button against the Date property. The following popup appears:

   

2. Clear the Set date and time to 'NONE' option. The following popup appears:

   

3. Select the require date and time (optional and applicable only for iPhone). Click OK. The selected date will appear in the calendar when rendered.

Example

//Sample code to set dateComponents property for a Calendar widget.
/*In this example, dateComponents property sets 31-12-2012, 04:30:55 as the default date and time.*/

frmCalendar.myCalendar.dateComponents=[31, 12, 2012, 04, 30, 55];

Platform Availability

• Available in the IDE
• Available on all platforms.

This property determines whether the calendar date must be entered in the calendar textbox.

Syntax

dateEditable

Type

Boolean

Read/Write

Read + Write

Remarks

Normally a user can enter date by choosing the date icon or entering the date in the textbox. Set this property to false, to avoid user from entering the date in textbox and allow the user to select the date only through icon.

The default value for this property is true.

If set to true, the calendar textbox is editable.

If set to false, the calendar textbox is not editable.

Example

//Sample code to enable dateEditable property for a Calendar widget.
frmCalendar.myCalendar.dateEditable=true;

Platform Availability

• This property is available on Desktop Web platform

The date format in which the selected date must appear on the display and when accessed programmatically the "date" property.

Syntax

dateFormat

Type

String

Read/Write

Read + Write

Remarks

The possible supported date formats are:

• MM/dd/yyyy
• dd/MM/yyyy (default)
• MM/dd/yy

Note: Above are the date formats that will be shown in IDE, but developer can pass the format as any one of the Unicode supported Date Formats.

For list of standard characters and formats, please see the following link.

http://unicode.org/reports/tr35/tr35-6.html#Date_Format_Patterns

DatePicker control

The DatePicker control supports the following formats for day, month, and year. If the user provides another format, the default will be used.

Supported formats for Day

d dddd (day digit and full day name)

d ddd(day digit and abbreviated day name)

dddd(full day name eg. Sunday)

ddd(abbreviated day name)

dd(2 digit day number)

d(day digit can be one digit or two digit)

Supported formats for Month

M MMMM(month in number and full month name)

M MMM(month in number and short month name)

MMMM(full month name)

MMM(short month name)

MM(two digit month name)

M

Supported formats for Year

yyyy(four digit year format)

yy(two digit year format)

Important: The default date sequence for the DatePicker combo box is Day Month Year. This sequence cannot be changed.

Example

//Sample code to set the dateFormat property for a Calendar widget.
frmCalendar.myCalendar.dateFormat="dd/MM/yyyy";

Platform Availability

• Available in the IDE
• Available on all platforms except Windows Desktop

Reads the day portion of the currently selected date.

Syntax

day

Type

Number

Read / Write

Read only

Example

//Sample code to read the day property of the date selected in a Calendar widget.
var dayCalendar=frmCalendar.myCalendar.day;

Platform Availability

• Available in the IDE
• Available on all platforms

This property is available only when viewType is set as CALENDAR_VIEW_TYPE_GRID_POPUP or CALENDAR_VIEW_TYPE_GRID_ONSCREEN.

Syntax

dayTextAlignmentInCell

Type

Number

Read/Write

Read + Write

Remarks

It specifies the alignment of the text for a Calendar Day cell with respect to its boundaries. The default value is CONTENT_ALIGN_CENTER. To choose another alignment, click the drop-down arrow next to the property and select the desired alignment.

The default value for this property is CONTENT_ALIGN_CENTER (content is aligned at the center of the Calendar).

The following are the available options:

• CONTENT_ALIGN_TOP_LEFT - Specifies the text should align at top left corner of the Calendar Day cell.
• CONTENT_ALIGN_TOP_CENTER - Specifies the text should align at top center of the Calendar Day cell.
• CONTENT_ALIGN_TOP_RIGHT- Specifies the text should align at top right of the Calendar Day cell.
• CONTENT_ALIGN_MIDDLE_LEFT- Specifies the text should align at middle left of the Calendar Day cell.
• CONTENT_ALIGN_CENTER- Specifies the text should align at center of the Calendar Day cell.
• CONTENT_ALIGN_MIDDLE_RIGHT- Specifies the text should align at middle right of the Calendar Day cell.
• CONTENT_ALIGN_BOTTOM_LEFT- Specifies the text should align at bottom left of the Calendar Day cell.
• CONTENT_ALIGN_BOTTOM_CENTER- Specifies the text should align at bottom center of the Calendar Day cell.
• CONTENT_ALIGN_BOTTOM_RIGHT - Specifies the text should align at bottom right of the Calendar Day cell.

Example

//Sample code to set the dayTextAlignmentInCell property of a Calendar widget.
frmCalendar.myCalendar.dayTextAlignmentInCell=constants.CONTENT_ALIGN_MIDDLE_LEFT;

Platform Availability

• Available in the IDE
• iOS
• Android

This property is applicable only when viewType is set as CALENDAR_VIEW_TYPE_GRID_POPUP or CALENDAR_VIEW_TYPE_GRID_ONSCREEN.

Syntax

displayedMonth

Type

Array with month and year

Read/Write

Read + Write

Remarks

It sets or gets the current displayed month and year of the calendar. Using this property you can change the current month and year. For example, if you want to show January, 2013 using displayedMonth is displayed as [1,2013].

The default value for this property is defined in dateComponents and get modified each time when the date is changed in dateComponents.

The property displayedMonth takes precedence over the dataComponents when both are specified during the construction of the widget.

Modifying the displayedMonth will not have any influence on dateComponent property.

Example

//Sample code to set the displayedMonth property of a Calendar widget as January 2013.
frmCalendar.myCalendar.displayedMonth=[1,2013];

Platform Availability

• iOS
• Android

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

This is a skin property. This property helps you to change the pre-defined CSS of a Calendar widget, and to customize the UI of the Calendar dialog box.

Syntax

gridTheme

Type

String

Read/Write

Read + Write

Input Parameters

You can assign any of these values to this property.

• kony.calendar.LEGACY: Old look of the dialog box is applied
• kony.calendar.MODERN: New look of the dialog box is applied

Note: In Kony Visualizer V 8 SP2 and later, the Calendar dialog box opens using the Legacy theme by default. In Kony Visualizer versions later than V8 SP2, the Calendar dialog box opens using the Modern theme by default.

Remarks

If the Calendar dialog box is open when the gridTheme property is applied dynamically, the dialog box is dismissed so that the change in the theme can be applied.

Example

//Sample code to set the gridTheme property of a Calendar widget.
frmCalendar.myCalendar.gridTheme=kony.calendar.MODERN;

Platform Availability

• Not available in the IDE
• SPA
• Desktop Web

This is a skin property and it determines the look and feel when there is focus on a widget.

Syntax

focusSkin

Type

String

Read/Write

Read + Write

Remarks

For more information on how to create and work with skins, see the Working with Applications section of the Kony Visualizer User Guide.

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.

Example

//Sample code to set the focusSkin property of a Calendar widget.
frmCalendar.myCalendar.focusSkin="calFocus";

Platform Availability

• Available in the IDE
• Available on all platforms except on all Mobile Web, and Windows Desktop

Currently selected data as String the format that is set through "dateFormat" property.

Syntax

formattedDate

Type

String

Read/Write

Read only

Example

//Defining the properties for Calendar with dateFormat:"dd/MM/yyyy".
var calBasicConf = {
    id: "calID",
    isVisible: true,
    dateComponents: [31, 12, 2012, 04, 30, 55],
    skin: "konytextar",
    focusSkin: "calFocus",
    dateFormat: "dd/MM/yyyy",
    viewType: constants.CALENDAR_VIEW_TYPE_GRID_POPUP,
    validStartDate: [01, 01, 2012],
    validEndDate: [31, 12, 2012],
    date: [31, 12, 2012],
    placeholder: "JSCalendar",
    calendarIcon: "cal.png"
};

var calLayoutConf = {
    containerWeight: 100
};

var calPSPConf = {};

//Creating the Calendar
var Calendar = new kony.ui.Calendar(calBasicConf,
    calLayoutConf,
    calPSPConf);

//Reading the formattedDate property of calendar widget.
alert("Calendar formattedDate ::" + Calendar.formattedDate);

Platform Availability

• Available in the IDE
• Available on all platforms except Windows Desktop

This property is used to provide a header for the DatePicker skin, if headerText is set.

Syntax

headerSkin

Type

String

Read/Write

Read + Write

Example

Setting the headerSkin property on an existing widget

FormHover.widgetID.headerSkin="theHeaderSkin";
//theHeaderSkin is a header skin created under Skins tab.

Platform Availability

Windows 10

This property is used to provide text above the calendar DatePicker, like a header for the DatePicker control.

Syntax

headerText

Type

String

Read/Write

Read + Write

Example

FormCalendar.calendar1.headerText="Header text";

Platform Availability

Windows 10

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 widgets by using DP, Percentage and Pixels.
frmHome.calendar1.height="50dp";

frmHome.calendar1. height="10%";

frmHome.calendar1. height="10px";

Platform Availability

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

This property is available only when viewType is set as CALENDAR_VIEW_TYPE_GRID_POPUP or CALENDAR_VIEW_TYPE_GRID_ONSCREEN. It indicates if the weekdays are hidden on the header for grid calendar.

Syntax

hideDaysHeader

Type

Boolean

Read/Write

Read + Write

Remarks

The default value for this property is false

If set to true, the weekdays are hidden and are not displayed.

If set to false, the weekdays are displayed.

Example

//Sample code to disable the hideDaysHeader property of a Calendar widget.
frmCalendar.myCalendar.hideDaysHeader=false;

Platform Availability

• Available in the IDE
• iOS
• Android

This property is available only when viewType is set as CALENDAR_VIEW_TYPE_GRID_POPUP or CALENDAR_VIEW_TYPE_GRID_ONSCREEN. It indicates if the months header is hidden for grid calendar including the navigation buttons.

Syntax

hideMonthsHeader

Type

Boolean

Read/Write

Read + Write

Remarks

If set to true, the months header is hidden and the navigation buttons are not displayed.

If set to false, the months header is displayed.

Example

//Sample code to disable the hideMonthsHeader property of a Calendar widget.
frmCalendar.myCalendar.hideMonthsHeader=false;

Platform Availability

• Available in the IDE
• iOS
• Android

You can use this property to specify the visibility of the dates of the previous and next months.

The hidePreviousNextMonthDates property is available for the Responsive Web and SPA platforms from Kony Visualizer V8 SP3 onwards.

Syntax

hidePreviousNextMonthDates

Type

Boolean

Read/Write

Read + Write

Remarks

The default value of the hidePreviousNextMonthDates property is false.

When you specify the value of this property as false, the previous and next months are visible but are not clickable.

When you specify the value of this property as true, the previous and next months are neither visible nor clickable.

If you change the value of hidePreviousNextMonthDates property while the calendar is open, the changes are reflected only after you re-open the calendar.

Example

//Sample code to enable the hidePreviousNextMonthDates property for a Calendar widget.
frmCalendar.myCalendar.hidePreviousNextMonthDates=true;

Platform Availability

• Android, iOS, Desktop Web, and SPA

Reads the hour portion of the currently selected date.

Syntax

hour

Type

Number

Read/Write

Read only

Example

//Sample code to read the hour property of the date selected in a Calendar widget.
var hourCalendar=frmCalendar.myCalendar.hour;

Platform Availability

• Available in the IDE
• Available on all platforms except Windows Phone, and Windows Desktop platform.

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

Syntax

hoverSkin

Type

String

Read/Write

Read + Write

Example

Setting the hoverSkin property on an existing widget

FormHover.widgetID.hoverSkin="theHoverSkin";
//theHoverSkin is a hover skin created under Skins tab

Note: To apply hoverSkin for dynamically created widgets or cloned widgets, assign hoverSkin dynamically after adding the widget to the form hierarchy. This is applicable for the Desktop web platform.

formid.widgetid.hoverSkin = "skinname";

Platform Availability

• Available in the IDE
• This property is available on Windows Tablet

Defines a string of alpha numeric characters that uniquely identifies a calendar widget within an application.

Syntax

id

Type

String

Read/Write

Read only

Example

//Defining the properties for Calendar with id:"calendar1".
var calBasicConf = {
    id: "calendar1",
    isVisible: true,
    skin: "konytextar",
    focusSkin: "calFocus",
    dateFormat: "dd/MM/yyyy",
    viewType: constants.CALENDAR_VIEW_TYPE_GRID_POPUP,
    validStartDate: [01, 01, 2012],
    validEndDate: [31, 12, 2012],
    placeholder: "JSCalendar",
    calendarIcon: "cal.png"
};

var calLayoutConf = {
    containerWeight: 100
};

var calPSPConf = {};

//Creating the Calendar.
var calendar1 = new kony.ui.Calendar(calBasicConf,
    calLayoutConf,
    calPSPConf);

//Reading the id property of calendar widget
alert("Calendar Id ::" + calendar1.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.

Syntax

info

Type

JSObject

Read/Write

Read + Write

Remarks

This will help in avoiding the globals to most part of the programming.

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 a property to Hello world.
 widget.info.a will have old value as hello.*/

Example

//Sample code to set info property for a Calendar widget

frmCalendar.myCalendar.info = {
    key: "caldate"
};

//Reading the info of the Calendar widget.
kony.print("Calendar info ::" +frmCalendar.myCalendar.info);

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 CALENDAR_INPUTACCESSORYVIEW_DEFAULT.

This property, allows you to specify the type of accessory view that will be shown for all the input controls for Calendar 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 the inputAccessoryViewType property at application-level and form-level, refer the inputAccessoryViewType property under FlexForm widget.

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

• CALENDAR_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 like a wheel calendar.
• CALENDAR_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.
  
• CALENDAR_INPUTACCESSORYVIEW_NEXTPREV: Specifies the navigation options as Next, Previous, and Done for a form.

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

Example

//Sample code to set inputAccessoryViewType property for a Calendar widget

frmCal.myCalendar.inputAccessoryViewType=constants.CALENDAR_INPUTACCESSORYVIEWTYPE_DEFAULT;

Platform Availability

• Available in the IDE
• iPhone
• iPad

This property specifies whether the Day combo box of the DatePicker is visible.

Syntax

isDayVisible

Type

Boolean

Read/Write

Read + Write

Remarks

If the value of this property is true, the Day combo box is visible. If the value is false, the combo box is hidden. The default value is true.

If this value is false, and the user changes the month, the corresponding month of the date returned in the callback will be changed. For example, if the user sets the date to 12/10/2015 (dd/mm/yyyy) and IsDayVIsible is false, if the user changes the month to November, the date returned will be 12/11/2015.

If isDayVisible, isMonthVisible, and isYearVisible are all false, the control will be useless.

Example

Form1.calendar1.isDayVisible = true;

Platform Availability

• Windows 10

This property specifies whether the Month combo box of the DatePicker is visible.

Syntax

isMonthVisible

Type

Boolean

Read/Write

Read + Write

Remarks

If this value is true, the Month combo box is visible. If the value is false, the combo box is hidden. The default value for this property is true.

If isDayVisible, isMonthVisible, and isYearVisible are all false, the control will be useless.

Example

Form1.calendar1.isMonthVisible = true;

Platform Availability

Windows 10

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

Syntax

isVisible

Type

Boolean

Read/Write

Read + Write

Remarks

The default for this property is true.

If set to false, the widget is not displayed.

If set to true, the widget is displayed.

Example

Form1.widget1.isVisible = true;

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

Platform Availability

• Available in the IDE except for form and popup
• Available on all platforms.

This property specifies whether the Year combo box of the DatePicker is visible.

Syntax

isYearVisible

Type

Boolean

Read/Write

Read + Write

Remarks

If the value of this property is true, the Year combo box of the DatePicker is visible. If the value is false, the combo box is hidden. The default value is true.

If isDayVisible, isMonthVisible, and isYearVisible are all false, the control will be useless.

Example

Form1.calendar1.isYearVisible = true;

Platform Availability

• Windows 10

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 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

Reads the minutes portion of the currently selected date.

Syntax

minutes

Type

Number

Read/Write

Read only

Example

//Sample code to read the minutes property of the date selected in a Calendar widget.
var minutesCalendar=frmCalendar.myCalendar.minutes;

Platform Availability

• Available in the IDE
• Available on all platforms except Windows Phone, and Windows Desktop platform.

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 the mode in which the calendar is used.

Syntax

mode

Type

String

Read/Write

Read + Write

Remarks

The available options are:

• CALENDAR_VIEW_TYPE_WHEEL_ONSCREEN (applicable on WHEEL mode only)
• CALENDAR_VIEW_TYPE_WHEEL_POPUP (applicable on WHEEL mode only)

• CALENDAR_WHEEL_ONLY_DATE (Default)
• CALENDAR_WHEEL_ONLY_TIME
• CALENDAR_WHEEL_BOTH_DATETIME

Example

//Sample code to set mode property for a Calendar widget

frmCal.myCalendar.mode=constants.CALENDAR_WHEEL_ONLY_TIME;

Platform Availability

• iPhone
• iPad

Reads the month portion of the currently selected date.

Syntax

month

Type

Number

Read/Write

Read only

Example

//Sample code to read the month property of the date selected in a Calendar widget.
var monthCalendar=frmCalendar.myCalendar.month;

Platform Availability

• Available in the IDE
• Available on all platforms

Specifies the number between 1 and 12 which indicates the number of months to be displayed when the calendar is selected.

Syntax

noOfMonths

Type

Number

Read/Write

Read + Write

Example

//Sample code to read the noOfMonths property of the dates selected in a Calendar widget.
var numberMonth=frmCalendar.myCalendar.noOfMonths;

Platform Availability

• Available in the IDE
• Available only on the Desktop Web platform

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

Limitations

• Desktop Web/ SPA platforms do not support padding property in Image widget, Slider widget and Switch widget.
• 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 the padding property for widgetID Button widget in frmHome Form.
frmHome.widgetID.padding= [2,2,2,2];

Platform Availability

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

This property specifies whether the padding property is to be applied in pixels or in percentage.

Syntax

paddingInPixel

Type

Boolean

Read/Write

Read Only

Remarks

The default value of this property is false.

If the value of this property is true, the padding are applied in pixels.

If the value of this property is false, the padding are applied as set in padding property.

Limitations

Desktop Web/ SPA platforms do not support paddingInPixel property in Image widget, Slider widget and Switch widget.

Example

//Sample code to read paddingInPixel property for widgetID Button widget in frmHome form.

kony.print("PaddingInPixel property value is:"+fromHome.widgetID.paddingInPixel);

Platform Availability

• iOS, Android, Windows Desktop, Desktop Web and SPA.

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 that must be displayed until a date is selected.

Syntax

placeholder

Type

String

Read/Write

Read + Write

Remarks

For example, you can display the placeholder text on the calendar widget as "Enter your date of travel", until the user clicks the calendar widget and selects a date.

Example

//Sample code to set the placeholder property of a Calendar widget.
frmCalendar.myCalendar.placeholder="Enter your date of travel";

Platform Availability

• Available in the IDE
• Available on all platforms except Windows Phone ( IE9 version), Windows Desktop.

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

Reads the seconds portion of the currently selected date.

Syntax

seconds

Type

Number

Read/Write

Read only

Example

//Sample code to read the seconds property of the date selected in a Calendar widget.
var secondCalendar=frmCalendar.myCalendar.seconds;

Platform Availability

• Available in the IDE
• Available on all platforms except Windows Phone, and Windows Desktop platforms.

This property is valid only when the selectionType Property value is either CALENDER_SELECTION_TYPE_MULTI_SELECT or CALENDER_SELECTION_TYPE_RANGE_SELECT. selectedDatesproperty returns an array of dates that has been selected in the Calendar widget.

Syntax

selectedDates

Type

Array

Read/Write

Read + Write

Input Parameters

The input parameters for the selectedDates Property vary with the value of the selectionType Property.

• If the value of the selectionType Property is constants.CALENDER_SELECTION_TYPE_MULTI_SELECT, the input is an array of date components. Each item of the date component is of this format: [dd,mm,yyyy].
• If the value of the selectionType Property is constants.CALENDER_SELECTION_TYPE_RANGE_SELECT, the input has two values: the from-date, to-date. The from-date and to-date are of this format: [dd,mm,yyyy].

Example

/*Sample code to define selectedDates Property of a Calendar widget when the selectionType Property has the value constants.CALENDER_SELECTION_TYPE_RANGE_SELECT*/

frmCalendar.myCalendar.selectedDates = [
 [10, 2, 2018],
 [3, 4, 2018]
];

Platform Availability

• Not available in the IDE
• Desktop Web

This property specifies the method of date selection in a Calendar widget.

Syntax

selectionType

Type

Number

Read/Write

Read + Write

Input Parameters

You can assign the following values to this property:

• Single-select : constants.CALENDER_SELECTION_TYPE_SINGLE_SELECT (default)
• Multi-select : constants.CALENDER_SELECTION_TYPE_MULTI_SELECT
• Range-select : constants.CALENDER_SELECTION_TYPE_RANGE_SELECT

Remarks

When you dynamically assign a value to the selectionType Property, the values in the dateComponents Property and selectedDates Property are cleared. If the Calendar dialog box is opened when the property is changed dynamically, the dialog box is dismissed.

When the selectionType Property is selected as Multi-Select or Range-Select, the Applybutton appears. After selecting the dates, click Apply to assign the dates to the widget. You can change the skin of this button by assigning a skin to the doneButtonSkin attribute of the viewConfig Property.

The following properties become undefined when you set the selectionType Property as Multi-Select or Range-Select:

• dateComponents
• formattedDate
• day
• month
• year

Example

//Sample code to set selectionType Property for a Calendar widget.

frmCalendar.myCalendar.selectionType=constants.CALENDAR_SELECTION_TYPE_RANGE_SELECT;

Platform Availability

• Not available in the IDE
• Desktop Web

Specifies a background skin for Calendar.

Syntax

skin

Type

String

Read/Write

Read + Write

Example

//Sample code to set skin Property for a Calendar widget.

frmCalendar.myCalendar.skin="konytextar";

Platform Availability

• Available in the IDE
• Available on all platforms except Windows Desktop

Specifies each cell color of the timesheet view when the calendar view type it set as CALENDAR_VIEW_TYPE_MONTH_VIEW.

Syntax

timeSheetSkin

Type

JSObject

Read/Write

Read + Write

Remarks

This property accepts skin as an array of key value pair for date and cell color.

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

Following are the date formats of the timesheet skin: "Mon, 13 Oct 2014", "10/13/2014", and "2014-10-12"

Example

Form1.calendar.timeSheetSkin = "calendarSkin"; 

Platform Availability

• Available on WindowsPhone 8/8.1 platform

Specifies the title text to be displayed on the calendar popup.

Syntax

titleOnPopup

Type

String

Read/Write

Read + Write

Example

//Sample code to set titleOnPopup Property for Calendar widget.

frmCalendar.myCalendar.titleOnPopup="calendar PopUp Title";

Platform Availability

• Available in the IDE
• SPA

Specifies the hint text when the cursor hovers over a widget, without clicking it.

Syntax

toolTip

Type

String

Read/Write

Read + Write

Remarks

The text entered in the tooltip appears as a small box when the cursor hovers over a widget.

Example

//Sample code to set toolTip Property for Calendar widget.

frmCalendar.myCalendar.toolTip="sample text";

Platform Availability

• Available in the IDE
• 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

Array representing the day, month and year portions of the date in the same order.

When used for the DatePicker control, this property restricts the ending year.

Syntax

validEndDate

Type

Array

Read/Write

Read + Write

Remarks

The valid end date, accepts Array of [dd, mm, yyyy, hh,mm,ss]

If a platform or the particular calendar view doesn't support the user to set the hh,mm,ss then they always are set 00:00:00 by default irrespective of what developer sets. Individual platforms need to cross check this per view basis and add it to the final documentation.

For backward compatibility atleast three elements [dd,mm,yyyy] are mandatory from all the six elements.

When used in the DatePicker control, if this property changes on an event such as button click and the user selects a date that is above the validEndDate, then this control will retain the date that is selected, regardless of the specified end date.

Example

//Sample code to set validEndDate Property for Calendar widget.

frmCalendar.myCalendar.validEndDate=[31, 12, 2012];

Platform Availability

• Available in the IDE
• Available on all platforms except Windows Desktop platform

Array representing the day, month, and year portions of the date in the same order.

When used for the DatePicker control, this property restricts the starting year in the DatePicker control.

Syntax

validStartDate

Type

Array

Read/Write

Read + Write

Remarks

The valid start date, accepts Array of [dd, mm, yyyy, hh, mm, ss]

If a platform or the particular calendar view doesn't support the user to set the hh,mm,ss then they always are set 00:00:00 by default irrespective of what developer sets. Individual platforms need to cross check this per view basis and add it to the final documentation.

For backward compatibility atleast three elements [dd,mm,yyyy] are mandatory from all the six elements.

Example

//Sample code to set validStartDate Property for Calendar widget.

frmCalendar.myCalendar.validStartDate=[01, 01, 2012];

Platform Availability

• Available in the IDE
• Available on all platforms except Windows Desktop platform

The view configuration for different view types.

Syntax

viewConfig

Type

JSObject

Read/Write

Read + Write

Remarks

Each view will have a key representing the view name and the value being the hash of key, value configurations.

For iOS platform, the option "allowWeekendSelectable" is not applicable when the calendar view type is set as wheelCalendar.

Possible hash of key value configurations for Grid Views:

• CALENDAR_VIEW_TYPE_ GRID_ONSCREEN
• CALENDAR_VIEW_TYPE_ GRID_POPUP

The possible keys are defined below:

• "gridSkin" - The skin for grid calendar
• "gridCellSkin" - The grid calendar cell skin

Note: The gridCellSkin parameter is not available on Windows Desktop and Windows Kiosk devices.

• "gridCellFocusSkin" - The grid calendar cell focus skin
• "gridCellSelectedSkin" - The grid calendar cell selected skin
• "gridCellTodaySkin" - The grid calendar today cell skin
• "gridCellWeekendSkin" - The grid calendar skin for weekend days
• "gridCellInactiveDaysSkin" - The grid calendar skin for non-working inactive days
• "leftNavigationImage" - The image to be set on the button that moves calendar to previous month. This can be a string identifier for an image resource or a Kony image Object (kony.image). You can create an image Object by using kony.image Namespace functions.
• "rightNavigationImage" - The image to be set on the button that moves calendar to next month. This can be a string identifier for an image resource or a Kony image Object (kony.image). You can create an image Object by using kony.image Namespace functions.
• "allowWeekendSelectable" - The Boolean flag to disable or enable the weekend days. If the value is false i.e., disabled, then gridCellInactiveDaysSkin is applied.
• "doneButtonSkin" - The skin to be applied on the Done button that appear on a calendar popup, which ever platform done button is applicable. It is not supported on Windows Phone platform.
• "cancelButtonSkin" - The skin to be applied on a Cancel button that appear on a calendar popup, which ever platform cancel button is applicable. It is not supported on Windows Phone platform.
• "noOfMonths" - Accepts a number between 1 and 12 which indicates the number of months to be displayed when the calendar is selected. It is supported only on Desktop Web platform.
• "gridCellFromDateSkin"-This attribute accepts a skin name as a String. This skin is applied to the start date of a calendar, when the selectionType Property is CALENDER_SELECTION_TYPE_RANGE_SELECT. It is supported only on the Desktop Web platform.
• "gridCellToDateSkin"-This attribute accepts a skin name as a String. This skin is applied to the end date of a calendar, when the selectionType Property is CALENDER_SELECTION_TYPE_RANGE_SELECT. It is supported only on the Desktop Web platform.

Example

//Sample code to set validStartDate Property for Calendar widget.
//Sample code to create a viewConfig object for gridView type
var gridConfig = {
    gridConfig: {
        gridSkin: "gridSkin",
        gridCellSkin: "gridCellSkin",
        gridCellFocusSkin: "gridCellFocusSkin",
        gridCellSelectedSkin: "gridCellSelectedSkin",
        gridCellTodaySkin: "gridCellTodaySkin",
        gridCellWeekendSkin: "gridCellWeekendSkin",
        gridCellInactiveDaysSkin: "gridCellInactiveDaysSkin",
        gridDaysSkin: "gridDaysSkin",
        gridMonthSkin: "gridMonthSkin",
        allowWeekendSelectable: false
    }
};

frmCalendar.myCalendar.viewConfig=gridConfig;

Using an image object for rightNavigationImage. Also applicable to left NavigationImage.

imgObjRef = kony.image.createImage("local.png");
var gridConfig = {
    gridConfig: {
        gridSkin: "gridSkin",
        gridCellSkin: "gridCellSkin",
        gridCellFocusSkin: "gridCellFocusSkin",
        gridCellSelectedSkin: "gridCellSelectedSkin",
        gridCellTodaySkin: "gridCellTodaySkin",
        gridCellWeekendSkin: "gridCellWeekendSkin",
        gridCellInactiveDaysSkin: "gridCellInactiveDaysSkin",
        gridDaysSkin: "gridDaysSkin",
        gridMonthSkin: "gridMonthSkin",
        allowWeekendSelectable: false,
        "leftNavigationImage": "zoomout.png",
        "rightNavigationImage": imgObjRef
    }
};

frmCalendar.myCalendar.viewConfig = gridConfig;

Platform Availability

• Available on the IDE
• Available on all platforms

Specifies the view type of the Calendar.

Syntax

viewType

Type

Number

Read/Write

Read only

Remarks

Below are the view types applicable on all platforms:

• CALENDAR_VIEW_TYPE_DATEPICKER - Specifies a DatePicker control. This value is supported in Windows 10 only.
• CALENDAR_VIEW_TYPE_DEFAULT: Specifies the default native calendar view in respective platforms.
• CALENDAR_VIEW_TYPE_ GRID_ONSCREEN
• CALENDAR_VIEW_TYPE_ GRID_POPUP ( Desktop and SPA platforms supports this option only)

On Android and BlackBerry platforms, when the viewType is set as CALENDAR_VIEW_TYPE_DEFAULT, the user cannot be restricted to select the dates within the validStartDate and validEndDate.

Below are the view types applicable on iOS platform:

• CALENDAR_VIEW_TYPE_WHEEL_ONSCREEN
• CALENDAR_VIEW_TYPE_WHEEL_POPUP (Default)

Below are the view types applicable on Mobile Web platform:

• CALENDAR_VIEW_TYPE_LISTBOXES_ONSCREEN
• CALENDAR_VIEW_TYPE_LISTBOXES_COLLAPSIBLE
• CALENDAR_VIEW_TYPE_LISTBOXES_POPUP

The below table shows the list of view types and their availability in different platforms:

Note: * indicates the default option in respective platforms.

On Widows platform, when the calendar is instantiated with the viewType as CALENDAR_VIEW_TYPE_DAY_VIEW or CALENDAR_VIEW_TYPE_WEEK_VIEW or CALENDAR_VIEW_TYPE_MONTH_VIEW, the view type should not be assigned with other view types. These views day, week, and month are entirely different and bear a different functionality usage and incompatible with each other.

On Windows platform, when the viewType is set as CALENDAR_VIEW_TYPE_DAY_VIEW or CALENDAR_VIEW_TYPE_WEEK_VIEW or CALENDAR_VIEW_TYPE_MONTH_VIEW, only the below date formats are accepted: "Mon, 13 Oct 2014 00:00:00", "10/13/2014 02:15:00 AM", and "2014-10-12 00:00:00".

Example

//Defining the properties for Calendar with viewType as GRID_POPUP
var calBasicConf = {
    id: "calendar1",
    isVisible: true,
    dateComponents: [31, 12, 2012, 04, 30, 55],
    skin: "konytextar",
    focusSkin: "calFocus",
    dateFormat: "dd/MM/yyyy",
    viewType: constants.CALENDAR_VIEW_TYPE_GRID_POPUP,
    validStartDate: [01, 01, 2012],
    validEndDate: [31, 12, 2012],
    date: [31, 12, 2012],
    placeholder: "JSCalendar",
    calendarIcon: "cal.png"
};

var calLayoutConf = {
    containerWeight: 100
};

var calPSPConf = {};

//Creating the Calendar.
var calendar1 = new kony.ui.Calendar(calBasicConf,
    calLayoutConf,
    calPSPConf);

//Reading the viewType property of calendar widget
alert("Calendar viewType ::" + calendar1.viewType);

Platform Availability

• Available in the IDE
• Available on all platforms except Windows Desktop

Specifies the background color for the wheel that is displayed when you click the Calendar.

Syntax

wheelBackgroundColor

Type

JSObject

Read/Write

Read + Write

Remarks

This property is applicable only when you set the viewType as CALENDAR_VIEW_TYPE_WHEEL_POPUP.

Example

//Sample code to set wheelBackgroundColor Property for Calendar widget.

frmCalendar.myCalendar.wheelBackgroundColor="0000ff00";

Platform Availability

• iPad
• iPhone

Specifies the mapping information between the widget id's and the keys in the data.

Syntax

widgetDataMapForCell

Type

Array with month and year

Read/Write

Read + Write

Remarks

It is the developer responsibility to ensure that widget data map to accommodate all the widget ids required including the widgets referred in dynamic templates.

{ 
  widgetID1: "dataId1",
 widgetId2: "dataId2",
 widgetId3: "dataId3",
 widgetId4: "secDataId1",
 widgetId5: "secDataId2"
}

Example

//Sample code to set widgetDataMapForCell property for Calendar widget.

frmCalendar.myCalendar.widgetDataMapForCell= {
 widgetId1: "dataid1",
 widgetId2: "dataId2",
 widgetId3: "dataId3",
 widgetId4: "secDataId1",
 widgetId5: "secDataId2"
};

Platform Availability

• iOS
• Android

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

Reads the year portion of the currently selected date.

Syntax

year

Type

Number

Read/Write

Read only

Example

//Sample code to read the year property of the date selected in a Calendar widget.
var yearCalendar=frmCalendar.myCalendar.year;

Platform Availability

• Available in the IDE
• Available on all platforms

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