PickerView Properties

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

For more information on using accessibility features in your app, see the Accessibility appendix in the VoltMX IrisUser Guide.

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.

Note: From Volt Mx Iris V9 SP2 GA version, you can provide i18n keys as values to all the attributes used inside the accessibilityConfig property. Values provided in the i18n keys take precedence over values provided in a11yLabel, a11yValue, and a11yHint fields.

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

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

• When accessibilityConfig property is configured for any widget, the tabIndex attribute is added automatically to the accessibilityConfig property.
• 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 1

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"    
};

Example 2

This example uses the button widget to implement internationalization in accessibilityConfig property, but the principle remains the same for all widgets.

/*Sample code to implement internationalization in accessibilityConfig property in Native platform.*/

Form1.myButton.accessibilityConfig = {
    "a11yLabel": voltmx.i18n.getLocalizedString("key1")     
};  
/*Sample code to implement internationalization in accessibilityConfig property in Desktop Web platform.*/

Form1.myButton.accessibilityConfig = {
    "a11yLabel": "voltmx.i18n.getLocalizedString(\"key3\")"
};

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 background color of the widget.

Syntax

backgroundColor

Type

Color constant or Hexadecimal number

Read/Write

Read + Write

Remarks

• The initial value of backgroundColor has to be specified explicitly. If not, Iris will not deduce the values from the existing skin and this will lead to undefined behavior.
• Colors can be specified using a 6 digit or an 8-digit hex value with alpha position. For example, ffff65 or ffffff00.
• When the 4-byte color format (RGBA) string is used, an alpha (A) value of 65 specifies that the color is transparent. If the value is 00, the color is opaque. The Alpha value is in percentage and must be given in the hexadecimal value for the color (100% in hexadecimal value is 65).
  For example, red complete opaque is FF000000. Red complete transparent is FF000065. The values 0x and # are not allowed in the string.
• A color constant is a String that is defined at the theme level. Ensure that you append the $ symbol at the beginning of the color constant.
• This property does not have a default value.
• This property has more priority than (and overrides) the background property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.
• The backgroundColor, backgroundColorTwoStepGradient, backgroundColoMultiStepGradient, and backgroundImage properties are mutually exclusive. The property that was set most recently is given higher priority over other properties.

Example

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

Form1.btn1.backgroundColor = "ea5075";

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

Specifies the multi-step gradient color for the background of the widget.

Syntax

backgroundColorMultiStepGradient

Type

JSON Object

Read/Write

Read + Write

Input Parameters

• gradientType [Constant]: Specifies the configuration type of the gradient. This parameter can have the following constant values:

  • voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_TOP: Constant for the gradient type toTop.
  • voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_RIGHT: Constant for the gradient type toRight.
  • voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_BOTTOM: Constant for the gradient type toBottom.
  • voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_LEFT: Constant for the gradient type toLeft.
  • voltmx.skin.MULTI_STEP_GRADIENT_TYPE_CUSTOM: Constant for the gradient type custom.
    For the custom gradient type, you must specify the angle by using the angle property.
• angle [Number]: Specifies the angle for the gradient in degrees, counted counter-clockwise. This property is only applicable for the custom gradient type.
• colors [Array]: Specifies the colors for the multi-step gradient. Colors is an array of color hex values that indicate the reference color values of the gradient. This parameter contains an array of hexadecimal numbers that represent the colors or constants defined at the theme level.
• colorStops [Array]: Specifies the color stops for the multi-step gradient. Color Stops 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). This parameter contains an array of numbers that represent the color stops.

Remarks

• The default value of the gradientType key is voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_TOP.
• Colors can be specified using a 6 digit or an 8-digit hex value with alpha position. For example, ffff65 or ffffff00.
• When the 4-byte color format (RGBA) string is used, an alpha (A) value of 65 specifies that the color is transparent. If the value is 00, the color is opaque. The Alpha value is in percentage and must be given in the hexadecimal value for the color (100% in hexadecimal value is 65).
  For example, red complete opaque is FF000000. Red complete transparent is FF000065. The values 0x and # are not allowed in the string.
• A color constant is a String that is defined at the theme level. Ensure that you append the $ symbol at the beginning of the color constant.
• This property does not have a default value.
• This property has more priority than (and overrides) the background property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.
• The backgroundColor, backgroundColorTwoStepGradient, backgroundColoMultiStepGradient, and backgroundImage properties are mutually exclusive. The property that was set most recently is given higher priority over other properties.

Example

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

Form1.btn1.backgroundColorMultiStepGradient = {
    "gradientType": voltmx.skin.MULTI_STEP_GRADIENT_TYPE_CUSTOM  
    "angle": 45,
    "colors": ["ea5075", "f1fa70", "eefd04"],
    "colorStops": [0, 90, 100]
};

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

Specifies the two-step gradient color for the background of the widget.

Syntax

backgroundColorTwoStepGradient

Type

JSON Object

Read/Write

Read + Write

Input Parameters

• topColor [Constant or Hex]: Specifies the top color of the two-step gradient. The value of this parameter can be a hexadecimal number that represents a color or a constant that is defined at the theme level.

• bottomColor [Constant or Hex]:Specifies the bottom color of the two-step gradient. The value of this parameter can be a hexadecimal number that represents a color or a constant that is defined at the theme level.

• style [Constant]: Specifies the configuration style of the two-step gradient. This parameter can have the following constant values:

  • voltmx.skin.TWO_STEP_GRADIENT_STYLE_VERTICAL_GRADIENT: Constant for the vertical gradient style.
  • voltmx.skin.TWO_STEP_GRADIENT_STYLE_VERTICAL_SPLIT: Constant for the vertical split style.
  • voltmx.skin.TWO_STEP_GRADIENT_STYLE_HORIZONTAL_GRADIENT: Constant for the horizontal gradient style.
  • voltmx.skin.TWO_STEP_GRADIENT_STYLE_HORIZONTAL_SPLIT: Constant for the horizontal split style.

Remarks

• The default value of the style key is voltmx.skin.TWO_STEP_GRADIENT_STYLE_VERTICAL_GRADIENT.
• Colors can be specified using a 6 digit or an 8-digit hex value with alpha position. For example, ffff65 or ffffff00.
• When the 4-byte color format (RGBA) string is used, an alpha (A) value of 65 specifies that the color is transparent. If the value is 00, the color is opaque. The Alpha value is in percentage and must be given in the hexadecimal value for the color (100% in hexadecimal value is 65).
  For example, red complete opaque is FF000000. Red complete transparent is FF000065. The values 0x and # are not allowed in the string.
• A color constant is a String that is defined at the theme level. Ensure that you append the $ symbol at the beginning of the color constant.
• This property does not have a default value.
• This property has more priority than (and overrides) the background property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.
• The backgroundColor, backgroundColorTwoStepGradient, backgroundColoMultiStepGradient, and backgroundImage properties are mutually exclusive. The property that was set most recently is given higher priority over other properties.

Example

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

Form1.btn1.backgroundColorTwoStepGradient = {  
     "topColor": "ea5075",  
    "bottomColor": "eefd04",  
    "style": voltmx.skin.TWO_STEP_GRADIENT_STYLE_VERTICAL_GRADIENT  
};

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

Sets the image for the background of the widget.

Syntax

backgroundImage

Type

String

Read/Write

Read + Write

Remarks

• This property does not have a default value.
• This property has more priority than (and overrides) the background property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.
• The backgroundColor, backgroundColorTwoStepGradient, backgroundColoMultiStepGradient, and backgroundImage properties are mutually exclusive. The property that was set most recently is given higher priority over other properties.

Example

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

Form1.btn1.backgroundImage = "bgImg.png";

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

Specifies the border color of the widget.

Syntax

borderColor

Type

Color constant or Hexadecimal number

Read/Write

Read + Write

Remarks

• Colors can be specified using a 6 digit or an 8-digit hex value with alpha position. For example, ffff65 or ffffff00.
• When the 4-byte color format (RGBA) string is used, an alpha (A) value of 65 specifies that the color is transparent. If the value is 00, the color is opaque. The Alpha value is in percentage and must be given in the hexadecimal value for the color (100% in hexadecimal value is 65).
  For example, red complete opaque is FF000000. Red complete transparent is FF000065. The values 0x and # are not allowed in the string.
• A color constant is a String that is defined at the theme level. Ensure that you append the $ symbol at the beginning of the color constant.
• This property does not have a default value.
• This property has more priority than (and overrides) the border property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.borderColor = "ea5075";

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

Specifies the multi-step gradient color for the border of the widget.

Syntax

borderColorGradient

Type

JSON Object

Read/Write

Read + Write

Input Parameters

• gradientType [Constant]: Specifies the configuration type of the gradient. This parameter can have the following constant values:

  • voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_TOP: Constant for the gradient type toTop.
  • voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_RIGHT: Constant for the gradient type toRight.
  • voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_BOTTOM: Constant for the gradient type toBottom.
  • voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_LEFT: Constant for the gradient type toLeft.
  • voltmx.skin.MULTI_STEP_GRADIENT_TYPE_CUSTOM: Constant for the gradient type custom.
    For the custom gradient type, you must specify the angle by using the angle property.
• angle [Number]: Specifies the angle for the gradient in degrees, counted counter-clockwise. This property is only applicable for the custom gradient type.
• colors [Array]: Specifies the colors for the multi-step gradient. Colors is an array of color hex values that indicate the reference color values of the gradient. This parameter contains an array of hexadecimal numbers that represent the colors or constants defined at the theme level.
• colorStops [Array]: Specifies the color stops for the multi-step gradient. Color Stops 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). This parameter contains an array of numbers that represent the color stops.

Remarks

• The default value of the gradientType key is voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_TOP.
• Colors can be specified using a 6 digit or an 8-digit hex value with alpha position. For example, ffff65 or ffffff00.
• When the 4-byte color format (RGBA) string is used, an alpha (A) value of 65 specifies that the color is transparent. If the value is 00, the color is opaque. The Alpha value is in percentage and must be given in the hexadecimal value for the color (100% in hexadecimal value is 65).
  For example, red complete opaque is FF000000. Red complete transparent is FF000065. The values 0x and # are not allowed in the string.
• A color constant is a String that is defined at the theme level. Ensure that you append the $ symbol at the beginning of the color constant.
• This property does not have a default value.
• This property has more priority than (and overrides) the border property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.borderColorGradient = {
    "gradientType": voltmx.skin.MULTI_STEP_GRADIENT_TYPE_CUSTOM  
    "angle": 45,
    "colors": ["ea5075", "f1fa70", "eefd04"],
    "colorStops": [0, 90, 100]
};

Platform Availability

• Android
• iOS

Specifies the border style for the widget.

Syntax

borderStyle

Type

Constant

Read/Write

Read + Write

Remarks

• This property can have the following constant values:

  • voltmx.skin.BORDER_STYLE_PLAIN: Constant for the plain border style.
  • voltmx.skin.BORDER_STYLE_ROUNDED_CORNER: Constant for the rounded corner style.
  • voltmx.skin.BORDER_STYLE_COMPLETE_ROUNDED_CORNER: Constant for the complete rounded corner style.
  • voltmx.skin.BORDER_STYLE_CUSTOM: Constant for the custom border style.
• The cornerRadius property is only applicable when the borderStyle is voltmx.skin.BORDER_STYLE_CUSTOM.
• This property does not have a default value.
• This property has more priority than (and overrides) the border property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.borderStyle = voltmx.skin.BORDER_STYLE_PLAIN;

Platform Availability

• Android
• iOS

Specifies the width of the border for the widget in pixels.

Syntax

borderWidth

Type

Number or JSON Object

Read/Write

Read + Write

Remarks

• This property does not have a default value.
• The default unit for the value of this property is pixels.
• The Desktop Web platform supports both Number and JSON Object (with the top, bottom, right, and left keys) values for the borderWidth parameter. The Android and iOS platforms support only Number values for the borderWidth parameter.
• This property has more priority than (and overrides) the border property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

 Form1.btn1.borderWidth = 2;

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

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

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 voltmx.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 voltmx.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 the radius of the border for the widget.

Syntax

cornerRadius

Type

Number or JSON Object

Read/Write

Read + Write

Remarks

• The cornerRadius property is only applicable when the borderStyle is voltmx.skin.BORDER_STYLE_CUSTOM.
• For a Responsive Web app, a corner radius of value zero applies a plain border, and a corner radius value greater than zero applies a rounded border.
• The Android and Desktop Web platforms support both Number and JSON Object (with the top, bottom, right, and left keys) values for the cornerRadius parameter. The iOS platform supports only Number values for the cornerRadius parameter.
• The default unit for the value of this property is pixels.
• This property does not have a default value.
• This property has more priority than (and overrides) the border property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

 Form1.btn1.cornerRadius = 60;

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

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

Syntax

cursorType

Type

String.

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

Read/Write

Read + Write

Remarks

To add the cursorType property using VoltMX Iris in a Desktop Web application, follow these steps.

1. In VoltMX Iris, open the Desktop Web application. From the Project explorer, expand Responsive Web/ Desktop> Forms and select the form to which you need to make the changes.
2. On the canvas, select the widget for which you want to specify the cursor type. For example, button.
3. From the Properties panel, navigate to the Skin tab > Hover Skin tab.
   You will find that the details of the hover skin is not enabled here.
4. Check the Enable option to add a hover skin to your widget.
   The details and configurations of the hover skin is enabled.
5. Under the General section, for the Platform option, click the ellipsis icon.
   The Fork Skin window appears.
6. In the Fork Skin window, for Desktop, check under HTML5 SPA.
7. Click Ok. You have successfully forked your hover skin for Desktop Web application.
   You can see that the Cursor Type property has been added under the General section.
8. Select a value from the drop-down list to set the Cursor Type for the widget.

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

• Available in IDE
• Desktop Web

Specifies the skin properties that define the look and feel of the widget, when the widget is disabled or blocked.

Syntax

disabledStateSkinProperties

Type

JSON Object

Read/Write

Read + Write

Remarks

• This property does not have a default value.
• This property has more priority than (and overrides) the disabledSkin property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.disabledStateSkinProperties= {  
     background: {  
        backgroundType: voltmx.skin.BACKGROUND_TYPE_MULTI_STEP_GRADIENT,  
        backgroundColorMultiStepGradient : {  
            gradientType: voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_TOP,  
            colors: ["ea5075", "f1fa70", "eefd04"],  
            colorStops: [0, 90, 100]  
        },  
    },  
    border: {  
        borderType: voltmx.skin.BORDER_TYPE_SINGLE_COLOR,  
        borderColor: "ea5075",  
        borderStyle: voltmx.skin.BORDER_STYLE_PLAIN,  
        borderWidth: 50  
    },  
    fonts: {  
        fontColor: "ea5075",  
        fontFamily: "Serif",  
        fontSize: '100',  
        fontStyle: voltmx.skin.FONT_STYLE_NONE,  
        fontWeight: voltmx.skin.FONT_WEIGHT_NORMAL  
    },  
    textShadow: {  
        textShadowRadius: 5,  
        textShadowColor: "ea5075",  
        textShadowOffset: {  
            x: 20,  
            y: 4  
        }  
    }

Platform Availability

• Android

The enable property is used to control the actionability of the widgets. In a scenario where you want to display a widget but not invoke any action on the widget, configure the enable property to false to achieve it.

This is a constructor level property and applicable for all widgets in VoltMX Iris.

Syntax

enable

Type

Boolean

Read/Write

Read + Write

Remarks

The default value of this property is true.

When enable property is configured to true, the action associated with a widget can be invoked by the user in the application.

When enable property is configured to false, the action associated with a widget cannot be invoked by the user in the application.

Example

//This is a generic property and is applicable for many widgets.  
  
/*The example provided is for the Button widget. Make the changes required in the example while using other widgets.*/
  
frmButton.myBtn.enable= true;

Platform Availability

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

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 PickerView widget.

Syntax

enableHapticFeedback

Type

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

Read/Write

Read + Write

Remarks

• The enableHapticFeedback property is supported for PickerView widgets only when the onSelection 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.

  • Android

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

Limitations and Behavior

• For iOS, when the wheel widget is scrolled, haptic feedback is provided by iOS native until the scroll action stops.

• For Windows and Android, haptic feedback is performed only when users click on the element or at the end of scrolling the element.

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

Example

//Sample code to set the enableHapticFeedback property of a PickerView widget.  
  
frmPView.myPView.enableHapticFeedback=true;

Platform Availability

• Android

• iOS
• Windows

Specifies the look and feel of the PickerView widget when it is in focus.

Note: Not applicable for iPhone / iPad currently. Even if configured will be ignored in case of iPhone and iPad.

Note: Mobile Web does not support this property, instead browser specific focus will be applied.

Syntax

focusSkin

Type

String

Read/Write

Yes - (Read and Write)

Example

//Sample code to set the focusSkin property of a PickerView widget.  
  
frmPView.myPView.focusSkin="pickerFSkin";

Accessible from IDE

Yes

Platform Availability

Available on all platforms except iOS and SPA.

Specifies the skin properties that define the look and feel of the widget, when the widget is in focus.

Syntax

focusStateSkinProperties

Type

JSON Object

Read/Write

Read + Write

Remarks

• This property does not have a default value.
• This property has more priority than (and overrides) the focusSkin property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

 Form1.btn1.focusStateSkinProperties = {  
     background: {  
        backgroundType: voltmx.skin.BACKGROUND_TYPE_MULTI_STEP_GRADIENT,  
        backgroundColorMultiStepGradient : {  
            gradientType: voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_TOP,  
            colors: ["ea5075", "f1fa70", "eefd04"],  
            colorStops: [0, 90, 100]  
        }  
    },  
    border: {  
        borderType: voltmx.skin.BORDER_TYPE_SINGLE_COLOR,  
        borderColor: "ea5075",  
        borderStyle: voltmx.skin.BORDER_STYLE_PLAIN,  
        borderWidth: 5  
    },  
    fonts: {  
        fontColor: "ea5075",  
        fontFamily: "Serif",  
        fontSize: '100',  
        fontStyle: voltmx.skin.FONT_STYLE_NONE,  
        fontWeight: voltmx.skin.FONT_WEIGHT_NORMAL  
    },  
    textShadow: {  
        textShadowRadius: 5,  
        textShadowColor: "ea5075",  
        textShadowOffset: {  
            x: 20,  
            y: 4  
        }  
    }

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

Specifies the font color of the widget.

Syntax

fontColor

Type

Color constant or Hexadecimal number

Read/Write

Read + Write

Remarks

• Colors can be specified using a 6 digit or an 8-digit hex value with alpha position. For example, ffff65 or ffffff00.
• When the 4-byte color format (RGBA) string is used, an alpha (A) value of 65 specifies that the color is transparent. If the value is 00, the color is opaque. The Alpha value is in percentage and must be given in the hexadecimal value for the color (100% in hexadecimal value is 65).
  For example, red complete opaque is FF000000. Red complete transparent is FF000065. The values 0x and # are not allowed in the string.
• A color constant is a String that is defined at the theme level. Ensure that you append the $ symbol at the beginning of the color constant.
• This property does not have a default value.
• This property has more priority than (and overrides) the fonts property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.fontColor = "ea5075";

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

Specifies the font family for the font of the widget.

Syntax

fontFamily

Type

String

Read/Write

Read + Write

Remarks

• This property does not have a default value.
• This property has more priority than (and overrides) the fonts property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

 Form1.btn1.fontFamily = "Serif";

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

Specifies the font size for the widget in percentage (%) units.

Syntax

fontSize

Type

Number

Read/Write

Read + Write

Remarks

• This property does not have a default value.
• This property has more priority than (and overrides) the fonts property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

 Form1.btn1.fontSize = 150;

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

Specifies the font style for the widget.

Syntax

fontStyle

Type

Constant

Read/Write

Read + Write

Remarks

• This property can have the following constant values:

  • voltmx.skin.FONT_STYLE_NONE: Constant for the normal font style.
  • voltmx.skin.FONT_STYLE_ITALIC: Constant for the italic font style.
  • voltmx.skin.FONT_STYLE_UNDERLINE: Constant for the underline font style.
• This property does not have a default value.
• This property has more priority than (and overrides) the fonts property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.fontStyle = voltmx.skin.FONT_STYLE_NONE;

Platform Availability

• Android
• Desktop Web (Not available on Desktop Web Legacy SDK)

Specifies the weight for the font of the widget.

Syntax

fontWeight

Type

Constant

Read/Write

Read + Write

Remarks

• This property can have the following constant values:

  • voltmx.skin.FONT_WEIGHT_NORMAL: Constant for the normal font weight.
  • voltmx.skin.FONT_WEIGHT_BOLD: Constant for the bold font weight.
• This property does not have a default value.
• This property has more priority than (and overrides) the fonts property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.fontWeight = voltmx.skin.FONT_WEIGHT_NORMAL;

Platform Availability

• Android
• Desktop Web (Not available on Desktop Web Legacy SDK)

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.
• voltmx.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 PickerView widget by using DP, Percentage and Pixels.*/
frmPView.myPView.height="50dp";

frmPView.myPView.height="10%";

frmPView.myPView.height="10px";

Platform Availability

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

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

Syntax

hExpand

Type

Boolean

Read/Write

No

Default: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.

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

Example

//Sample code to set the hExpand property of a PickerView widget.  
  
frmPView.myPView.hExpand=true;

Accessible from IDE

Yes

Platform Availability

Available on all platforms except SPA and Desktop Web platforms

Specifies the skin properties that define the look and feel of the widget, when the cursor hovers on the widget.

Syntax

hoverStateSkinProperties

Type

JSON Object

Read/Write

Read + Write

Remarks

• This property does not have a default value.
• This property has more priority than (and overrides) the hoverSkin property of the configured skin.

Example

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

 Form1.btn1.hoverStateSkinProperties = {  
     background: {  
        backgroundType: voltmx.skin.BACKGROUND_TYPE_MULTI_STEP_GRADIENT,  
        backgroundColorMultiStepGradient : {  
            gradientType: voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_TOP,  
            colors: ["ea5075", "f1fa70", "eefd04"],  
            colorStops: [0, 90, 100]  
        }  
    },  
    border: {  
        borderType: voltmx.skin.BORDER_TYPE_SINGLE_COLOR,  
        borderColor: "ea5075",  
        borderStyle: voltmx.skin.BORDER_STYLE_PLAIN,  
        borderWidth: 5  
    },  
    fonts: {  
        fontColor: "ea5075",  
        fontFamily: "Serif",  
        fontSize: '100',  
        fontStyle: voltmx.skin.FONT_STYLE_NONE,  
        fontWeight: voltmx.skin.FONT_WEIGHT_NORMAL  
    },  
    textShadow: {  
        textShadowRadius: 5,  
        textShadowColor: "ea5075",  
        textShadowOffset: {  
            x: 20,  
            y: 4  
        }  
    }

Platform Availability

• Desktop Web (Not available on Desktop Web Legacy SDK)

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

Syntax

id

Type

String - [Mandatory]

Read/Write

Yes - (Read only)

Example

//Defining the properties for PickerView with id:"picker"
var pickerBasic = {
    id: "picker",
    info: {
        key: "PickerView"
    },
    skin: "pickerSkin",
    focusSkin: "pickerFSkin",
    masterData: [
        [
            ["y1", "2009"],
            ["y2", "2010"],
            ["y3", "2011"],
            40
        ],
        [
            ["m1", "Jan"],
            ["m2", "Feb"],
            ["m3", "Mar"],
            ["m4", "Apr"],
            ["m5", "May"],
            ["m6", "Jun"],
            ["m7", "Jul"],
            60
        ]
    ],
    isVisible: true,
    selectedKeys: ["y2", "m1"]
};

var pickerLayout = {
    margin: [5, 5, 5, 5],
    marginInPixel: true,
    widgetAlignment: constants.WIDGET_ALIGN_CENTER,
    hExpand: true,
    containerWeight: 99
};

//Creating the PickerView.
var picker = new voltmx.ui.PickerView(pickerBasic, pickerLayout, {});

//Reading id of the pickerView
alert("pickerView id is ::" + picker.id);

Accessible from IDE

Yes

Platform Availability

Available on all platforms except SPA and Desktop Web

A custom JSObject with the key value pairs that a developer can use to store the context with the widget. This helps in avoiding globals in your programming.

Syntax

info

Type

JSObject

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.

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 the info property of a PickerView widget.  
  
frmPView.myPView.info={
    key: "PickerView"
};  
//Reading info of the PickerView widget.
alert("pickerView info is ::" +frmPView.myPView.info);  

Accessible from IDE

No

Platform Availability

Available on all platforms except SPA and Desktop Web platforms

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)

Example

//Sample code to set the isVisible property of a PickerView widget.  
  
frmPView.myPView.isVisible=true;

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

Accessible from IDE

Yes

Platform Availability

Available on all platforms except SPA and Desktop Web 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 voltmx.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

Defines the space around a widget. You can use this option to define the left, top, right, and bottom distance between the widget and the next element.

To define the margin values for a platform, click the () button against the property to open the Margin screen. Select the PickerView against the platform for which you want to define the margins and enter the top, left, right, and bottom margin values.

If you want to use the margin values set for a platform across other platforms, you can click the Apply To button and select the platforms on which you want the margin values to be applied.

The following image illustrates a widget with a defined margin:

Syntax

margin

Type

Array of Numbers

Read/Write

Yes - (Read and Write)

Example

//Sample code to set the margin property of a PickerView widget.  
  
frmPView.myPView.margin=[5, 5, 5, 5];

Accessible from IDE

Yes

Platform Availability

Available on all platforms except SPA and Desktop Web platforms

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

Default: false

If set to true, the margins are applied in pixels.

If set to false, the margins are applied as set in margin property.

Syntax

marginInPixel

Type

Boolean

Read/Write

No

Example

//Sample code to set the marginInPixel property of a PickerView widget.  
  
frmPView.myPView.marginInPixel=true;

Platform Availability

• Available in IDE
• iOS, Android

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

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 PickerView window.

In the Master Data window, you can specify the Key, Display Value, i18n Key, and the Accessibility Config. You can add the components by clicking the “+” button.

Syntax

masterData

Type

Array

Read/Write

Yes (Read and Write)

Remarks

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 use the quick preview feature of the IDE. (For more information on Quick Preview, see the VoltMX IrisUser Guide.

If the key or the display value is null/nil, the value will not be listed as one of the available choices. The key and value should be of string data type

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

[   
  //0th component  
  [  
    ["key1","value1", accessibilityConfigObject],  
    ["key2","value2", accessibilityConfigObject],....,  
    ["keyn", "valuen", accessibilityConfigObject], componentWidth  
  ],  
  
  //1st component  
  [  
    ["key1","value1", accessibilityConfigObject],  
    ["key2","value2", accessibilityConfigObject],....,  
    ["keyn", "valuen", accessibilityConfigObject], componentWidth  
  ],  
]

Example

//Sample code to set the masterData property of a PickerView widget.  
  
frmPView.myPView.masterData = [
 [
  ["y1", "2009", accessibilityConfigObject],
  ["y2", "2010", accessibilityConfigObject],
  ["y3", "2011", accessibilityConfigObject], 40
 ],
 [
  ["m1", "Jan", accessibilityConfigObject],
  ["m2", "Feb", accessibilityConfigObject],
  ["m3", "Mar", accessibilityConfigObject],
  ["m4", "Apr", accessibilityConfigObject],
  ["m5", "May", accessibilityConfigObject],
  ["m6", "Jun", accessibilityConfigObject],
  ["m7", "Jul", accessibilityConfigObject], 60
 ]
];

Accessible from IDE

Yes

Platform Availability

Available on all platforms except SPA and Desktop Web platforms

Specifies the set of values from which you can make one or more selections. You must set the values from the code.

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

Syntax

masterDataMap

Type

Array

Read/Write

Read and Write

Example

//Sample code to set the masterDataMap property of a PickerView widget.  
  
frmPView.myPView.masterDataMap = [
 [
  [{
   key1: "y1",
   value1: "2001",
   "accessibilityconfig": acObject
  }, {
   key1: "y2",
   value1: "2002",
   "accessibilityconfig": acObject
  }, {
   key1: "y3",
   value1: "2003",
   "accessibilityconfig": acObject
  }],
  yearid, yearvalue,
  60
 ],
 [
  [{
   key2: "m1",
   value2: "jan",
   "accessibilityconfig": acObject
  }, {
   key2: " m2",
   value2: "feb",
   "accessibilityconfig": acObject
  }, {
   key2: " m3",
   value2: "mar",
   "accessibilityconfig": acObject
  }],
  monid, monvalue,
  40
 ]
];

Accessible from IDE

No

Platform Availability

Available on all platforms except SPA and Desktop Web 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 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

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 inside a FlexForm, FlexContainer or FlexScrollContainer.

Example

function func() {

    voltmx.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 skin properties that define the look and feel of the widget, when the widget is pressed or clicked.

Syntax

pressedStateSkinProperties

Type

JSON Object

Read/Write

Read + Write

Remarks

• This property does not have a default value.
• This property has more priority than (and overrides) the pressedSkin property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.pressedStateSkinProperties = {  
     background: {  
        backgroundType: voltmx.skin.BACKGROUND_TYPE_MULTI_STEP_GRADIENT,  
        backgroundColorMultiStepGradient : {  
            gradientType: voltmx.skin.MULTI_STEP_GRADIENT_TYPE_TO_TOP,  
            colors: ["ea5075", "f1fa70", "eefd04"],  
            colorStops: [0, 90, 100]  
        }  
    },  
    border: {  
        borderType: voltmx.skin.BORDER_TYPE_SINGLE_COLOR,  
        borderColor: "ea5075",  
        borderStyle: voltmx.skin.BORDER_STYLE_PLAIN,  
        borderWidth: 5  
    },  
    fonts: {  
        fontColor: "ea5075",  
        fontFamily: "Serif",  
        fontSize: '100',  
        fontStyle: voltmx.skin.FONT_STYLE_NONE,  
        fontWeight: voltmx.skin.FONT_WEIGHT_NORMAL  
    },  
    textShadow: {  
        textShadowRadius: 5,  
        textShadowColor: "ea5075",  
        textShadowOffset: {  
            x: 20,  
            y: 4  
        }  
    }

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 voltmx.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, 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 voltmx.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, 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 voltmx.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, 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 voltmx.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

If you create a PickerView with multiple values, you can choose to show specific values as selected when the PickerView is rendered. Returns the array of selected keys from the masterdata representing the selected key. If you set the selectedkeys to null/nil, the selection is cleared.

Syntax

selectedKeys

Type

Array

Read/Write

Read and Write

Example

//Sample code to set the selectedKeys property of a PickerView widget.  
  
frmPView.myPView.masterData = [
 [
  ["y1", "2009"],
  ["y2", "2010"],
  ["y3", "2011"],
  40
 ],
 [
  ["m1", "Jan"],
  ["m2", "Feb"],
  ["m3", "Mar"],
  ["m4", "Apr"],
  ["m5", "May"],
  ["m6", "Jun"],
  ["m7", "Jul"],
  60
 ]
];
frmPView.myPView.selectedKeys = ["y2", "m1"];

Accessible from IDE

No

Platform Availability

Available on all platforms except SPA and Desktop Web platforms

Returns the array of selected key-value pairs selected from the masterdata representing the selected key value.

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

Syntax

selectedKeyValues

Type

Array

Read/Write

Yes - (Read only)

Example

//Sample code to set the selectedKeyValues property of a PickerView widget.  
  
frmPView.myPView.masterData = [
 [
  ["y1", "2009"],
  ["y2", "2010"],
  ["y3", "2011"],
  40
 ],
 [
  ["m1", "Jan"],
  ["m2", "Feb"],
  ["m3", "Mar"],
  ["m4", "Apr"],
  ["m5", "May"],
  ["m6", "Jun"],
  ["m7", "Jul"],
  60
 ]
];
frmPView.myPView.selectedKeys = ["y2", "m1"];  
//Reading selectedKeyValues of the PickerView widget.
voltmx.print("pickerView selectedKeyValues is ::"+frmPView.myPView.selectedKeyValues);  

Accessible from IDE

No

Platform Availability

Available on all platforms except SPA and Desktop Web platforms

Specifies the color for the shadow of the widget.

Syntax

shadowColor

Type

Color constant or Hexadecimal number

Read/Write

Read + Write

Remarks

• Colors can be specified using a 6 digit or an 8-digit hex value with alpha position. For example, ffff65 or ffffff00.
• When the 4-byte color format (RGBA) string is used, an alpha (A) value of 65 specifies that the color is transparent. If the value is 00, the color is opaque. The Alpha value is in percentage and must be given in the hexadecimal value for the color (100% in hexadecimal value is 65).
  For example, red complete opaque is FF000000. Red complete transparent is FF000065. The values 0x and # are not allowed in the string.
• A color constant is a String that is defined at the theme level. Ensure that you append the $ symbol at the beginning of the color constant.
• This property does not have a default value.
• This property has more priority than (and overrides) the shadow property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.shadowColor = "ea5075";

Platform Availability

• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

This property specifies the current coordinates of the shadow region in the widget.

Syntax

shadowOffset

Type

JSON Object

Read/Write

Read + Write

Remarks

• The JSON Object contains the X-coordinate and Y-coordinates for the offset in the following format:

  {x: value in pixels, y: value in pixels}

• The default unit for the value of this property is pixels.
• This property does not have a default value.
• This property has more priority than (and overrides) the shadow property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.shadowOffset= {
    "x": "3",
    "y": "27"
};

Platform Availability

• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

Specifies the radius for the blur value of the shadow.

Syntax

shadowRadius

Type

Number

Read/Write

Read + Write

Remarks

• The default value of the shadowRadius property for a Responsive Web app is 0.
• The default unit for the value of this property is pixels.
• This property does not have a default value.
• This property has more priority than (and overrides) the shadow property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

 Form1.btn1.shadowRadius = 6;

Platform Availability

• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

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

Read and Write

Example

//Sample code to set the showAppMenu property of a PickerView widget.  
  
frmPView.myPView.showAppMenu=true;  

Accessible from IDE

No

Platform Availability

Windows

Specifies the look and feel of the button when not in focus. It is the skin which is applied at the widget level.

Note: The changes made to the skin property will not be reflected in the Iris canvas. But the changes will be reflected in the output.

Syntax

skin

Type

String

Read/Write

Yes - (Read and Write)

Example

//Sample code to set the skin property of a PickerView widget.  
  
frmPView.myPView.skin="pickerSkin";  

Accessible from IDE

Yes

Platform Availability

Available on all platforms except iOS, SPA, and Desktop Web platforms

Note: On iOS platform, even if the skin is configured, is ignored.

Enables or disables the font color support in normal skin.

Syntax

supportSkins

Type

Boolean

Read/Write

Read + Write

Remarks

The default value of the property is.

true: the fontColor property is respected from normal skin.

false: backward compatible.

Example

//Sample code to set the supportSkins property of a PickerView widget.   
  
frmPView.myPView.supportSkins = true;

Availability

iOS

Specifies the color for the text shadow of the widget.

Syntax

textShadowColor

Type

Color constant or Hexadecimal number

Read/Write

Read + Write

Remarks

• Colors can be specified using a 6 digit or an 8-digit hex value with alpha position. For example, ffff65 or ffffff00.
• When the 4-byte color format (RGBA) string is used, an alpha (A) value of 65 specifies that the color is transparent. If the value is 00, the color is opaque. The Alpha value is in percentage and must be given in the hexadecimal value for the color (100% in hexadecimal value is 65).
  For example, red complete opaque is FF000000. Red complete transparent is FF000065. The values 0x and # are not allowed in the string.
• A color constant is a String that is defined at the theme level. Ensure that you append the $ symbol at the beginning of the color constant.
• This property does not have a default value.
• This property has more priority than (and overrides) the textShadow property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.textShadowColor = "ea5075";

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

This property specifies the current coordinates of the text shadow region in the widget.

Syntax

textShadowOffset

Type

JSON Object

Read/Write

Read + Write

Remarks

• The JSON Object contains the X-coordinate and Y-coordinates for the offset in the following format:

  {x: value in pixels, y: value in pixels}

• The default unit for the value of this property is pixels.
• This property does not have a default value.
• This property has more priority than (and overrides) the textShadow property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

Form1.btn1.textShadowOffset = {
    "x": "2",
    "y": "24"
};

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

Specifies the radius for the blur value of the text shadow.

Syntax

textShadowRadius

Type

Number

Read/Write

Read + Write

Remarks

• The default value of the textShadowRadius property for a Responsive Web app is 0.
• The default unit for the value of this property is pixels.
• This property does not have a default value.
• This property has more priority than (and overrides) the textShadow property of the configured skin. Even if there is no skin configured for the widget, this property updates the skin.

Example

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

 Form1.btn1.textShadowRadius = 6;

Platform Availability

• Android
• iOS
• Desktop Web (Not available on Desktop Web Legacy SDK)

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 voltmx.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 voltmx.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 = voltmx.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

This property facilitates to select the view of the PickerView widget.

Syntax

viewType

Read/Write

Read + Write

Remarks

The changes made to the viewType property will not be reflected in the Iris canvas. But the changes will be reflected in the output.

The view of the PickerView widget in Android platform was same as the PickerWheel widget of the native iOS platform. From version 7.0 onwards, a new view of the PickerView is introduced for Android.

If a project containing PickerView is created in 7.0 version, the default value for the viewType property is PICKER_VIEW_TYPE_FLAT. In case the projects created using versions prior to 7.0, the default value of the viewType property is PICKER_VIEW_TYPE_WHEEL to support the backward compatibility.

In other words, PICKER_VIEW_TYPE_WHEEL is the default look and feel of the PickerView widget in versions prior to 7.0. From Iris 7.0 onwards, the default look and feel is PICKER_VIEW_TYPE_FLAT. In either case, you can change the value of viewType property if required.

When the viewType is PICKER_VIEW_TYPE_FLAT:

When the ViewType is PICKER_VIEW_TYPE_WHEEL:

Example

//Sample code to set the viewType property of a PickerView widget.   
  
frmPView.myPView.viewType = constants.PICKER_VIEW_TYPE_WHEEL;

Platform Availability

• Available in the IDE
• Android

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 PickerView widget.   
  
frmPView.myPView.widgetAlignment=constants.WIDGET_ALIGN_CENTER;

Accessible from IDE

Yes

Platform Availability

Available on all platforms except SPA and Desktop Web 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.
• voltmx.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 VoltMX Iris hierarchy, inside of a flexContainer or form. The zIndex property accepts only 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.

From VoltMX Iris V9 SP2 FP7, developers can configure the Z Index value for a Responsive Web app as Auto or Custom. When the selected Z Index value is Auto, the default Z Index value of 1 is applied. When the selected Z Index value is Custom, developers can specify a desired numeric value.

Prior to the V9 SP2 FP7 release, the default value for the Z Index was 1. When developers imported any third-party libraries with the Z index set as Auto, content overflow was disabled as the value of Auto is less than 1.

Note: The Z Index value Auto is supported only when the Enable JS Library mode is configured as unchecked.

For existing components, the value of the Z Index is configured as 1 for the Native channel. For the Responsive Web channel, the Z Index will be set as Custom with 1 as the value.

For new components, the value of the Z Index is configured as 1 for the Native channel. For the Responsive Web channel, the Z Index will be set as Auto or 1 based on the project level settings.

Note: If ModalContainer property is set to true in any of the FlexContainer widget, the Z Index value of that container and all of its parent containers should be set to Custom.

voltmx.flex.ZINDEX_AUTO : Constant to configure the Z Index value as auto programmatically.

//Sample code to set the ZIndex value to Auto  
 var flx = new voltmx.ui.FlexContainer({ 
  "id": "flx"
  "zIndex": voltmx.flex.ZINDEX_AUTO
});

//Sample code to set the ZIndex value to Auto
flx.zIndex = voltmx.flex.ZINDEX\_AUTO;

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