ImageGallery - Basic Properties

The basic properties for ImageGallery widget are:

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

For more information on using accessibility features in your app, refer the Accessibility appendix in the Quantum Application Design Guidelines Guide.

Syntax

accessibilityConfig

Type

JSON Object

Read/Write

Read + Write

Remarks

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

NOTE: From Quantum Visualizer 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.

Key Type Description ARIA Equivalent
a11yIndex Integer with no floating or decimal number. This is an optional parameter. Specifies the order in which the widgets are focused on a screen.

For all widgets, this parameter maps to the index properties.
a11yLabel String This is an optional parameter. Specifies alternate text to identify the widget. Generally the label should be the text that is displayed on the screen.

For all widgets, this parameter maps to the aria-labelledby property of ARIA in HTML.

NOTE: For the Image widget, this parameter maps to the alt attribute of ARIA in HTML.
a11yValue String This is an optional parameter. 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. This parameter is similar to the a11yLabel parameter. If the a11yValue is defined, the value of a11yValue is appended to the value of a11yLabel. These values are separated by a space.
a11yHint String This is an optional parameter. 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. For all widgets, this parameter maps to the aria-describedby property of ARIA in HTML.
a11yHidden Boolean This is an optional parameter. 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. For all widgets, this parameter maps to the aria-hidden property of ARIA in HTML.
a11yARIA Object
  • This is an optional parameter.
  • For each widget, the key and value provided in this object are added as the attribute and value of the HTML tags respectively.
  • Any values provided for attributes such as aria-labelledby and aria-describedby using this attribute, takes precedence over values given in a11yLabel and a11yHint fields.
  • When a widget is provided with the following key value pair or attribute using the a11yARIA object, the tabIndex of the widget is automatically appended as zero.
    • {"role": "main"}
    • aria-label
  • The aria-labelledby and aria-describedby properties are used to set the IDs of the widgets that describe the value to be provided. You must provide only the widget IDs and not the widget path.
    Consider a Login scenario with a Label widget with the text Username and a TextBox widget for entering the username. To read the text in the Label widget when the TextBox widget is in focus, provide the id of the Label widget to the aria-labelledby property. When you want to provide a little more description for the value entered in the TextBox, you can provide the id of the widget with the description to the aria-describedby property.
 This parameter is only available on the Desktop Web platform.
tagName String
  • Applicable only in the FlexContainer, FlexScrollContainer, Label, and Segment widgets.
  • From Quantum Visualizer V9 Service Pack 2 you can define the HTML tags using the tagName property. The HTML tag assigned to the tagName property replaces the default HTML tags of the Label and Segment widgets.
  • From the Quantum Visualizer V9 Service Pack 5 release, you can define the HTML tags for the FlexContainer, FlexScrollContainer widgets by using the tagName property.
  • This is a constructor-level property. You cannot modify the tags of the widgets during runtime.
  • For more information about the tagName attribute, click here.
 This parameter is only available on the Desktop Web platform.
a11yAttributes Array
  • Applicable only in the Label and RichText widgets.

  • The supported values for the a11yAttributes parameter in the Label widget are AccessibilityTypeNone (array value [0]), AccessibilityTypeHeader (array value [1]), and AccessibilityTypeStaticText(array value [2]).

    NOTE: On the Android platform, you can only provide the AccessibilityTypeHeader value for the a11yAttributes parameter. This parameter is only available on devices that run on Android 9 (and later) versions.

  • The supported values for the a11yAttributes parameter in the RichText widget are AccessibilityTypeNone (array value [0]) and AccessibilityTypeLink (array value [3]).
  • You can select one or more values for this parameter.
  • The default value for this parameter is AccessibilityTypeNone (array value [0]).
 This parameter is only available on the Android and iOS Native platforms.
a11yChildrenHidden Boolean
  • Applicable only in the FlexContainer and FlexScrollContainer widgets.
  • When you enable this property for a container widget, the container widget is hidden along with all its child elements.
  • If you set the value of this property as true, the a11yHidden property of the container and all of its child elements is ignored.
  • If a container widget has both the a11yChildrenHidden and the a11yHidden properties enabled, the a11yChildrenHidden property is applied as it takes higher precedence.
 This parameter is only available on the Android and iOS Native platforms.

Accessibility in Components

  • In a FlexForm containing direct widgets and components, while providing values to the aria-labelledby and the aria-describedby properties for widgets directly inside the FlexForm, you must not provide the Id of the widgets inside the components.
  • In a component containing direct widgets and child components, while providing values to the aria-labelledby and the aria-describedby properties for widgets directly inside the component, you must not provide the Id of the widgets inside the child components.

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.
  • The i18n key support in accessibilityConfig property depends on the languages supported by the TTS(Text-To-Speech) engine of the mobile device. If the TTS engine of the mobile device does not support a language, the text provided in the accessibilityConfig property is not read by the TTS engine.

Accessibility in Desktop Web Platform

  • To use the accessibilityConfig property on the Desktop Web platform, ensure that you disable the Legacy JS Mode in the Project Settings > Responsive Web section.
  • 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 Desktop web applications support only a few ARIA tags. To achieve more accessibility features, use the attribute a11yARIA. The tags added to a11yARIA will be added to the DOM.

  • The tagName attribute supports the following tags in the Label Segment, FlexContainer, and FlexScrollContainer widgets:

    Widget Name Supported tags Example Remarks
    Label
    • label(default)
    • div
    • span
    • h1, h2, h3, h4, h5, h6

    The following example shows how to assign the tags to the Label widget.

    

/*Sample code to assign the span tag to the Label widget*/
    "accessibilityConfig": {
  "tagName": "span"
}
    		  
    Segment
    • ul(default)
    • ol
    • div
    • table
    • dl

    The following example uses the role and tagName attributes to modify the HTML tag of Segment widget.

    

/*Sample code to assign the div tag to the Segment widget*/
    "accessibilityConfig": {
  "a11yARIA": {
    "role": "grid"
  },
  "tagName": "div"
}
    • You can assign values to the role attribute inside the a11yARIA only when you modify the tag to div.
    • You can only assign the following values to the role attribute of a Segment widget: grid table and button.
    FlexContainer
    • div (default)
    • th
    • td
    • tr
    • dt
    • dd

    The following example uses the role and tagName attributes to modify the HTML tag of a FlexContainer widget.

    

/*Sample code to assign the td tag to a FlexContainer widget*/

    var flx = new kony.ui.FlexContainer({
    "accessibilityConfig": {
        "tagName": "td"
    }
});
    • This is a read-only property.

    • When you specify the value as tr for the tagName property of a FlexContainer widget, ensure that you use the Flex Horizontal Layout Type.
      The height of the FlexContainer widget is inherited from the height of the child widgets present inside it.
    FlexScrollContainer
    • div (default)
    • th
    • td
    • dt
    • dd

    The following example uses the role and tagName attributes to modify the HTML tag of a FlexScrollContainer widget.

    

/*Sample code to assign the td tag to a FlexScrollContainer widget*/

    var flx = new kony.ui.FlexScrollContainer({
    "accessibilityConfig": {
        "tagName": "td"
    }
});
    • This is a read-only property.

Example 1

This example uses the Login scenario to explain how to provide accessibility to the usernameText TextBox widget inside the frmLogin Form. The frmLogin form also contains the usernameLbl Label widget (with the text Username) and rulesLbl Label widget(that contains the username policies). 



//This is a generic property that is applicable for various widgets.
/*Here, we have shown how to use the accessibilityConfig Property for a TextBox widget.You need to make a corresponding use of the accessibilityConfig property for other applicable widgets.*/
frmLogin.usernameText.accessibilityConfig = {
  "a11yLabel": "Label",
  "a11yValue": "Value",
  "a11yHint": "Hint",
  "a11yARIA": {
    "tabindex" /* Integer with no floating/decimal numbers*/: 1,
    "role" /*Prescribed string value as per wcag guidelines*/: "main",
    "aria-labelledby": "usernameLbl"
    "aria-describedby": "rulesLbl"
  }
};

Example 2

This example creates a Label widget (lblSpan) inside the frmSample FlexForm. This sample code uses the tagName property to change the HTML tag of the lblSpan Label from label tag to span tag.



/*Here, we have shown how to use the accessibilityConfig Property for a Label widget. You need to make a corresponding use of the accessibilityConfig property for in Segment widget as well.*/
var lblspan = new kony.ui.Label({
  "accessibilityConfig": {
    "tagName": "span"
  },
  "id": "lblspan",
  "isVisible": true,
  "left": "460dp",
  "skin": "CopyslLabel0b3521e51e03b44",
  "text": "span tag",
  "top": "92dp",
  "width": kony.flex.USE_PREFFERED_SIZE,
  "zIndex": 1
}, {
  "contentAlignment": constants.CONTENT_ALIGN_MIDDLE_LEFT,
  "padding": [0, 0, 0, 0],
  "paddingInPixel": false
}, {});

frmSample.add(lblspan);

Example 3

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": kony.i18n.getLocalizedString("key1")     
};
/*Sample code to implement internationalization in accessibilityConfig property in Desktop Web platform.*/

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

Platform Availability

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

Represents the JSObject to represent the images to be rendered in ImageGallery. The format of the JSObject consists of an array of two elements:

  • [0] is the array of objects with hashes
  • [1] is the key's key in the data hash of [0]

Example 

formname.widgetname.data=
  [
  [{"imagekey":"image1.png"},
   {"imagekey":"image2.png"},
   {"imagekey":"imagen.png"}]
];

Syntax

data

Type

Array

Read/Write

Yes - (Read and Write)

Platform Availability

Available in the IDE

Available on all platforms

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

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

Syntax

focusSkin

Type

String

Read/Write

Yes - (Read and Write)

Remarks

You must be aware of the following:

On J2ME non-touch devices, if you do not specify the Focus skin, it is not possible to identify the focus change between the widgets.

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

Example


//Defining the properties for ImageGallery with focusSkin: "gradroundfocusbtn"
var imgGalBasic = { id: "imgGallery",
	isVisible: true,
	skin: "gradroundfocusbtn",
	focusSkin: "gradroundfocusbtn"};

var imgGalLayout = {containerWeight:100};

//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,{});

//Reading the focusSkin of ImageGallery
alert("ImageGallery focusSkin is ::"+imgGallery.focusSkin);

Platform Availability

Available in the IDE

Available on all platforms..

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

Syntax

hoverSkin

Type

String

Read/Write

Yes - (Read and Write)

Example


//Defining the properties for ImageGallery with hoverSkin:"hskin"
var imgGalBasic = { id: "imgGallery",
	isVisible: true, 
	skin: "gradroundfocusbtn",
	focusSkin: "gradroundfocusbtn",
	selectedIndex:3, spaceBetweenImages: 50};

var imgGalLayout = {containerWeight:100};

var imgGalPSP = {hoverSkin:"hskin"};

//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,imgGalPSP);

Platform Availability

Available in the IDE.

This property is available on Windows Tablet.

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

Syntax

id

Type

String - [Mandatory]

Read/Write

Yes - (Read only)

Example


//Defining the properties for ImageGallery with ID:"imgGallery"
var imgGalBasic = { id: "imgGallery", isVisible: true};

var imgGalLayout = {containerWeight:100};
	
//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,{});
	
//Reading the ID of ImageGallery
alert("ImageGallery id is ::"+imgGallery.id);

Platform Availability

Available in the IDE

Available on all platforms.

Specifies the image to be displayed when the remote resource is not available. This image is taken from the resources folder.

Syntax

imageWhenFailed

Type

String

Read/Write

No

Example

//Defining the properties for ImageGallery with imageWhenFailed: "AppIcon.png".
//Image with the same name should be in resources folder.
var imgGalBasic = { id: "imgGallery",
	isVisible: true, 
	skin: "gradroundfocusbtn",
	focusSkin: "gradroundfocusbtn",
	imageWhileDownloading: "ApplicationIcon.png",
	imageWhenFailed: "AppIcon.png"};

var imgGalLayout = {containerWeight:100};
	
//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,{});

Platform Availability

Not available in the IDE.

Available on all platforms except and Windows Desktop platforms.

Specifies the image to be displayed when the remote source is still being downloaded. This image is taken from the resources folder.

Syntax

imageWhileDownloading

Type

String

Read/Write

No

Example

//Defining the properties for ImageGallery with imageWhileDownloading: "ApplicationIcon.png". 
//Image with the same name should be in resources folder.
var imgGalBasic = { id: "imgGallery",
	isVisible: true, 
	skin: "gradroundfocusbtn",
	focusSkin: "gradroundfocusbtn",
	imageWhileDownloading: "ApplicationIcon.png"};
	var imgGalLayout = {containerWeight:100};
	
//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,{});

Platform Availability

Available in the IDE.

Available on all platforms., BlackBerry 10, and Windows Desktop platforms.

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

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


//Defining the properties for ImageGallery with info property.
var imgGalBasic = { id: "imgGallery",isVisible: true};

var imgGalLayout = {containerWeight:100};
	
//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,{});
imgGallery.info = {key:"ImageGal"};
	
//Reading the info of ImageGallery
alert("ImageGallery info is ::"+imgGallery.info);

Platform Availability

Not available in the IDE.

Available on all platforms.

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

Syntax

isVisible

Type

Boolean

Read/Write

Yes - (Read and Write)

Remarks

The default value for this property is true. If set to false, the widget is not displayed. If set to true, the widget is displayed.

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

Example


//Defining the properties for ImageGallery with isVisible: true
var imgGalBasic = { id: "imgGallery", isVisible: true};

var imgGalLayout = {containerWeight:100};

//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,{});

//Reading the Visibility of ImageGallery
alert("ImageGallery Visibility is ::"+imgGallery.isVisible);

Platform Availability

Available in the IDE.

Available on all platforms.

Specifies the number of images to be displayed per row in an ImageGallery at a time.

Syntax

itemsPerRow

Type

Number

Read/Write

No

Example


//Defining the properties for ImageGallery with sitemsPerRow:3
var imgGalBasic = { id: "imgGallery",
	isVisible: true, 
	skin: "gradroundfocusbtn",
	focusSkin: "gradroundfocusbtn",
	selectedIndex:3, spaceBetweenImages: 50};
	var imgGalLayout = {containerWeight:100};
	var imgGalPSP = {itemsPerRow:3};
	
//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,imgGalPSP);

Platform Availability

Available in the IDE.

This property is available only on Server side Mobile Web (advanced) platform.

Specifies the position of the navigation bar for the ImageGallery. The pageview indicator either appears on the top or bottom of the ImageGallery.

Syntax

navigationBarPosition

Type

String

Read/Write

No

Example


//Defining the properties for ImageGallery with navigationBarPosition:"Bottom"
var imgGalBasic = { id: "imgGallery", 
	isVisible: true, 
	skin: "gradroundfocusbtn",
	focusSkin: "gradroundfocusbtn",
	selectedIndex:3, spaceBetweenImages: 50};

var imgGalLayout = {containerWeight:100};

var imgGalPSP = {itemsPerRow:3, navigationBarPosition:"Bottom"};
	
//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,imgGalPSP);

Platform Availability

Available in the IDE.

This property is available only on Server side Mobile Web (advanced) platform.

Specifies the number of rows to be displayed in each page.

Syntax

noofRowsPerPage

Type

Number

Read/Write

Yes - (Read and Write)

Remarks

This property is displayed only when viewType is set to IMAGE_GALLERY_VIEW_TYPE_PAGEVIEW.

Example


//Defining the properties for ImageGallery with noofRowsPerPage:4.
var imgGalBasic={id:"imagegallery1",
	isVisible:true, 
	skin:"imgGalskin",
	focusSkin:"imgGalFSkin",
	text:"Click Here",
	toolTip:"sample text"};
	var imgGalLayout={containerWeight:100, 
	padding:[5,5,5,5], 
	margin:[5,5,5,5], 
	hExpand:true, 
	vExpand:false, 
	displayText:true};

var imgGalPSP={viewType: constants.IMAGE_GALLERY_VIEW_TYPE_PAGEVIEW, viewConfig: {noofRowsPerPage:4}};

//Creating the ImageGallery.
var imagegallery1 = new kony.ui.ImageGallery(imgGalBasic,imgGalLayout,imgGalPSP);

Platform Availability

Available in the IDE.

This property is available on Desktop Web.

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.

Properties Local Flag Value Widget Flag Value Action
Mirror/retain FlexPositionProperties true true Use the designed layout from widget for all locales. Widget layout overrides everything else.
Mirror/retain FlexPositionProperties true false Use Mirror FlexPositionProperties since locale-level Mirror is true.
Mirror/retain FlexPositionProperties true not specified Use Mirror FlexPositionProperties since locale-level Mirror is true.
Mirror/retain FlexPositionProperties false true Use the designed layout from widget for all locales. Widget layout overrides everything else.
Mirror/retain FlexPositionProperties false false Use the Design/Model-specific default layout.
Mirror/retain FlexPositionProperties false not specified Use the Design/Model-specific default layout.
Mirror/retain FlexPositionProperties not specified true Use the designed layout from widget for all locales. Widget layout overrides everything else.
Mirror/retain FlexPositionProperties not specified false Use the Design/Model-specific default layout.
Mirror/retain FlexPositionProperties not specified not specified Use the Design/Model-specific default layout.
 

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
  • iOS
  • Android

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.

Properties Local Flag Value Widget Flag Value Action
Mirror/retain FlexPositionProperties true true Use the designed layout from widget for all locales. Widget layout overrides everything else.
Mirror/retain FlexPositionProperties true false Use Mirror FlexPositionProperties since locale-level Mirror is true.
Mirror/retain FlexPositionProperties true not specified Use Mirror FlexPositionProperties since locale-level Mirror is true.
Mirror/retain FlexPositionProperties false true Use the designed layout from widget for all locales. Widget layout overrides everything else.
Mirror/retain FlexPositionProperties false false Use the Design/Model-specific default layout.
Mirror/retain FlexPositionProperties false not specified Use the Design/Model-specific default layout.
Mirror/retain FlexPositionProperties not specified true Use the designed layout from widget for all locales. Widget layout overrides everything else.
Mirror/retain FlexPositionProperties not specified false Use the Design/Model-specific default layout.
Mirror/retain FlexPositionProperties not specified not specified Use the Design/Model-specific default layout.
 

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 the 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
  • iOS
  • Android

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.

Properties Local Flag Value Widget Flag Value Action
Mirror/retain FlexPositionProperties true true Use the designed layout from widget for all locales. Widget layout overrides everything else.
Mirror/retain FlexPositionProperties true false Use Mirror FlexPositionProperties since locale-level Mirror is true.
Mirror/retain FlexPositionProperties true not specified Use Mirror FlexPositionProperties since locale-level Mirror is true.
Mirror/retain FlexPositionProperties false true Use the designed layout from widget for all locales. Widget layout overrides everything else.
Mirror/retain FlexPositionProperties false false Use the Design/Model-specific default layout.
Mirror/retain FlexPositionProperties false not specified Use the Design/Model-specific default layout.
Mirror/retain FlexPositionProperties not specified true Use the designed layout from widget for all locales. Widget layout overrides everything else.
Mirror/retain FlexPositionProperties not specified false Use the Design/Model-specific default layout.
Mirror/retain FlexPositionProperties not specified not specified Use the Design/Model-specific default layout.
 

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
  • iOS
  • Android

Indicates the currently selected image in the ImageGallery. The index is with respect to the order in which data is set with data property. Programmatically setting the selectedIndex will not make any visible differences in the row, however it will bring the row at the index into the view able area on the screen. Setting it to null/nil clears the selection state.

Syntax

selectedIndex

Type

Number

Read/Write

Yes - (Read and Write)

Remarks

On Windows Phone platform, you cannot write data to this property.

If data contains the sections then the selectedIndex indicates the selected row index within the section.

Example


//Defining the properties for ImageGallery with selectedIndex:3 (setSelectedIndex)
var imgGalBasic = { id: "imgGallery",
	isVisible: true, 
	skin: "gradroundfocusbtn",
	focusSkin: "gradroundfocusbtn",
	imageWhileDownloading: "ApplicationIcon.png",
	imageWhenFailed: "AppIcon.png",
	selectedIndex:3};

var imgGalLayout = {containerWeight:100};

//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,{});

//getSelectedIndex
alert("Selected Index:"+imgGallery.selectedIndex);

Platform Availability

Not available in the IDE.

Available on all platforms..

Returns the selected data object (input array) corresponding to the selected image of the ImageGallery. If no image is selected, null/nil is returned.

Syntax

selectedItem

Type

JSObject

Read/Write

Read only

Example


//Defining the properties for ImageGallery with selectedIndex:3 (setSelectedIndex)
var imgGalBasic = { id: "imgGallery",
	isVisible: true, 
	skin: "gradroundfocusbtn",
	focusSkin: "gradroundfocusbtn",
	imageWhileDownloading: "ApplicationIcon.png",
	imageWhenFailed: "AppIcon.png",
	selectedIndex:3};

var imgGalLayout = {containerWeight:100};

//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,{});

//getSelectedItem
alert("selected Item:"+imgGallery.selectedItem);

Platform Availability

Not available in the IDE

Available on all platforms..

Specifies the look and feel of the ImageGallery when not in focus.

Syntax

skin

Type

String

Read/Write

Yes - (Read and Write)

Example


//Defining the properties for ImageGallery with skin: "gradroundfocusbtn"
var imgGalBasic = { id: "imgGallery",
	isVisible: true, 
	skin: "gradroundfocusbtn"};

var imgGalLayout = {containerWeight:100};

//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,{});
	
//Reading the skin of ImageGallery
alert("ImageGallery skin is ::"+imgGallery.skin);

Platform Availability

Available in the IDE

Available on all platforms..

Specifies the space between the images in the ImageGallery.

Syntax

spaceBetweenImages

Type

Number

Read/Write

No

Example


//Defining the properties for ImageGallery with spaceBetweenImages: 50
var imgGalBasic = { id: "imgGallery",
	isVisible: true, 
	skin: "gradroundfocusbtn",
	focusSkin: "gradroundfocusbtn",
	imageWhileDownloading: "ApplicationIcon.png",
	imageWhenFailed: "AppIcon.png",
	selectedIndex:3, spaceBetweenImages: 50};

var imgGalLayout = {containerWeight:100};

//Creating the ImageGallery.
var imgGallery = new kony.ui.ImageGallery2(imgGalBasic,imgGalLayout,{});

Platform Availability

Available in the IDE.

Available on all platforms., and Windows Phone platforms.

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

Specifies the appearance of the Image Gallery as Default view or Page view.

Syntax

viewType

Type

Number

Read/Write

Yes - (Read and Write)

Remarks

The default value for this property is IMAGE_GALLERY_VIEW_TYPE_DEFAULT.

You can select one of the following available views:

  • IMAGE_GALLERY_VIEW_TYPE_DEFAULT - This is the default selection and if this option is unchanged, the appearance of the image gallery remains unchanged.
  • IMAGE_GALLERY_VIEW_TYPE_PAGEVIEW - The images appears as a pageview. When this option is selected, the noofRowsPerPage is displayed.

Example


//Defining the properties for ImageGallery with viewType:IMAGE_GALLERY_VIEW_TYPE_DEFAULT.
var imgGalBasic={id:"imagegallery1",
	isVisible:true, 
	skin:"imgGalskin",
	focusSkin:"imgGalFSkin",
	text:"Click Here",
	toolTip:"sample text"};

var imgGalLayout={containerWeight:100, 
	padding:[5,5,5,5], 
	margin:[5,5,5,5], 
	hExpand:true, 
	vExpand:false, 
	displayText:true};

var imgGalPSP={viewType: constants.IMAGE_GALLERY_VIEW_TYPE_DEFAULT };
	
//Creating the ImageGallery.
var imagegallery1 = new kony.ui.ImageGallery(imgGalBasic,imgGalLayout,imgGalPSP);

Platform Availability

Available in the IDE.

This property is available on Desktop Web.

Specifies the view configuration parameters when the viewType is set as IMAGE_GALLERY_VIEW_TYPE_PAGEVIEW for Desktop Web platform.

Syntax

viewConfig

Type

JSObject

Read/Write

Yes - (Read and Write)

Example


//Defining the properties for ImageGallery with viewConfig:noofRowsPerPage.
var imgGalBasic={id:"imagegallery1",
	isVisible:true, 
	skin:"imgGalskin",
	focusSkin:"imgGalFSkin",
	text:"Click Here",
	toolTip:"sample text"};

var imgGalLayout={containerWeight:100, 
	padding:[5,5,5,5], 
	margin:[5,5,5,5], 
	hExpand:true, 
	vExpand:false, 
	displayText:true};

var imgGalPSP={viewType: constants.IMAGE_GALLERY_VIEW_TYPE_PAGEVIEW,
 viewConfig: {noofRowsPerPage: 5} };

//Creating the ImageGallery.
var imagegallery1 = new kony.ui.ImageGallery(imgGalBasic,imgGalLayout,imgGalPSP);

Platform Availability

Available in the IDE.

This property is available on Desktop Web.