Titanium SDK # Titanium.UI.iOS.WebViewConfiguration
A collection of properties used to initialize a web view.
8.0.0
9.2.0# Overview
Use the Titanium.UI.iOS.createWebViewConfiguration method to create and use as a parameter of Titanium.UI.WebView.configuration. Using this you can determine how soon a webpage is rendered, how media playback is handled, the granularity of items that the user can select, and many other options. This property can only be set when creating the webview and will be ignored when set afterwards.
See the example section "Usage of WebViewConfiguration with WebView in iOS". Information on additional available preferences can be derived from the original WebKit sources: WKPreferences.mm (opens new window)
# Properties
# allowsAirPlayMediaPlayback
8.0.0 9.2.0A Boolean value indicating whether AirPlay is allowed.
Default: true
# allowsInlineMediaPlayback
8.0.0 9.2.0A Boolean value indicating whether HTML5 videos play inline or use the native full-screen controller.
You must set this property to play inline video. Set this property to true to play videos inline. Set this property to false to use the native full-screen controller. When adding a video element to a HTML document on the iPhone, you must also include the playsinline attribute. The default value for iPhone is false and the default value for iPad is true.
Default: For iPhone false and for iPad true.
# allowsPictureInPictureMediaPlayback
8.0.0 9.2.0A Boolean value indicating whether HTML5 videos can play picture-in-picture.
Default: true
# apiName READONLY
8.0.0 9.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# bubbleParent
8.0.0 9.2.0Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
# mediaTypesRequiringUserActionForPlayback
8.0.0 9.2.0Determines which media types require a user gesture to begin playing.
Default: Titanium.UI.iOS.AUDIOVISUAL_MEDIA_TYPE_NONE
# preferences
8.0.0 9.2.0The preference settings to be used by the web view.
# processPool
8.0.0 9.2.0The process pool from which to obtain the Web Content process of view.
When a web view is initialized, either a new web content process is created for it from the specified pool or an existing process in that pool is used.
# selectionGranularity
8.0.0 9.2.0The level of granularity with which the user can interactively select content in the web view.
Default: Titanium.UI.iOS.SELECTION_GRANULARITY_DYNAMIC
# suppressesIncrementalRendering
8.0.0 9.2.0A Boolean value indicating whether the web view suppresses content rendering until it is fully loaded into memory.
Default: false
# Methods
# addEventListener
8.0.0 9.2.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
8.0.0 9.2.0Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# fireEvent
8.0.0 9.2.0Fires a synthesized event to any registered listeners.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# removeEventListener
8.0.0 9.2.0Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void