Browser

Browser

Use a Browser widget to display HTML content in your application. The HTML content can be static or obtained from a URL.

To learn how to use this widget programmatically, refer VoltMX Iris Widget guide.

Important Considerations

The following are important considerations for a Browser widget:

• For the iOS platform, use a Browser widget as a screen-level widget and move other widgets to the header or footer. Otherwise, dual scrolling bars may be displayed.
• The Browser widget is memory- and performance-intensive. Initial RAM usage is high, and the RAM usage grows in proportion to the size and number of rendered images and static text.
• If there are multiple instances of a Browser widget in the same application, information sharing (for example, cookies) may not behave as expected. Do not place multiple Browser widgets on a form, or more than two Browser widgets in an application.
• Do not use a Browser widget to display rich text. It should be used only to display large HTML content. Use a RichText widget to display rich text.
• Avoid using a Browser widget to create an application that looks and behaves like a web browser. Typically, users expect to use the native browser to browse web content.

Look Properties

Look properties define the appearance of the widget. The following are the major properties you can set:

• Whether the widget is visible.
• The platforms on which the widget is rendered.
• How the widget aligns with its parent widget and neighboring widgets.
• If the widget displays content, where the content appears.

For descriptions of the properties available on the Look tab of the Properties pane, see Look.

Browser Properties

Browser properties specify properties that are available on any platform supported by Volt MX Iris, and assign platform-specific properties.

Master Data

Specifies the content source for the Browser widget. Click Edit button to open the Master Data dialog box, and select one of the following options:

• Content. Displays a text field where you enter or paste the HTML content to be displayed.
• URL. Displays a text box where you specify the URL of an HTML page to display. The URL must begin with http:// .
• Local File. Displays a text box where you specify a local web-based file for launching local HTML content, such as a web app. For more information, see Add Local HTML Content.

Detect Phone Number

Specifies whether the Browser widget supports the detection of phone numbers on the web page and displays them as clickable links. When a user clicks a phone link, the Phone application launches and dials the number.

The option you choose becomes the default for all the platforms. You can change the default option or provide a platform-specific option by forking the Detect Phone Number property. For more information, see Fork a Widget Property.

Native Communication

Specifies whether to enable a web app JavaScript module running in the Browser widget to execute JavaScript code in the Volt MX native context.

Zoom

Specifies whether enable the Zoom feature for the Browser widget. The Zoom feature provides the ability to change the scale of the view area.

The option you choose here becomes the default for all the platforms. You can change the default option or provide a platform-specific option by forking the Zoom property. For more information, see Fork a Widget Property.

Base URL

For the iOS platform, specifies a URL to provide additional web-based functionality.

Enable Cache

For the Windows 8 platform, specifies whether data is cached relative to the Browser widget. For more information, refer to voltmx.evaluateJavaScriptInNativeContext in the VoltMX Iris API Developer's Guide.

Actions

Actions define what happens when an event occurs. On a Browser widget, you can run an action when the following events occur:

• onFailure: The action is triggered when the specified Master Data URL fails to load content.

  Note: This action is executed only for the given request URL, but not for the subsequent web navigation request failures.

• onSuccess: The action is triggered when the specified Master Data URL successfully loads content.

• Note: This action is called only for the given request URL, but not for the subsequent web navigation requests.

• onPageStarted: The action is triggered when the specified page starts loading.

• onPageFinished: The action is triggered when the specified page has finished loading.
• onTouchStart: The action is triggered when the user touches the touch surface. This event occurs asynchronously.
• onTouchMove: The action is triggered when the touch moves on the touch surface continuously until movement ends. This event occurs asynchronously.
• onTouchEnd: The action is triggered when the user touch is released from the touch surface. This event occurs asynchronously.
• onReceive: The action is triggered when the specified page has loaded and has an event callback such as digest authentication (Android).

Placement Inside a Widget

The following table summarizes where a Calendar widget can be placed:

Flex Form	Yes
VBox Form	Yes
FlexContainer	Yes
FlexScrollContainer	Yes
ScrollBox	Horizontal Orientation -YesVertical Orientation- Yes
Tab	Yes
Segment	No
Popup	Yes
Template	Header- NoFooter- No

Widget Appearance on Platforms

The appearance of the Browser widget varies as follows:

Platform	Appearance
Android
iOS
SPA