Titanium.UI.WebView

Object of Titanium.UI.

Platform	Since
Android	0.8
iPhone	0.8
iPad	0.8
Mobile Web	1.8

Summary

The Web View allows you to open an HTML5 based view which can load either local or remote content. The content can be any valid web content such as HTML, PDF, SVG or other WebKit supported content types. The Web View is created by the method Titanium.UI.createWebView.

Description

Creating webviews are more expensive than creating pure native views because of the requirement to load the HTML browser into memory.

Since a webview internally wants to handle its own events, scrolling and other related touch events against it's own view surface, you cannot have both Titanium style events against the webview instance and internal Javascript events in the DOM. You must choose between one or the other.

Code Examples

Basic Web View to external URL example

Create a web view to a remote URL and open the window as modal.

var webview = Titanium.UI.createWebView({url:'http://www.appcelerator.com'});
    var window = Titanium.UI.createWindow();
    window.add(webview);
    window.open({modal:true});

Methods

Name	Summary
add	Adds a child to this view's hierarchy.
addEventListener	Adds the specified callback as an event listener for the named event.
animate	Animates this view.
canGoBack	returns true if the webview can go back in history
canGoForward	returns true if the webview can go forward in history
convertPointToView	Translates a point from this view's coordinate system to another view's coordinate system. (Android, iPhone, iPad only.)
evalJS	invoke JavaScript inside the context of the webview and optionally, return a result
fireEvent	Fires a synthesized event to any registered listeners.
getAnchorPoint	Gets the value of the anchorPoint property. (iPhone, iPad only.)
getAnimatedCenterPoint	Gets the value of the animatedCenterPoint property. (Android, iPhone, iPad only.)
getBackgroundColor	Gets the value of the backgroundColor property.
getBackgroundDisabledColor	Gets the value of the backgroundDisabledColor property. (Android only.)
getBackgroundDisabledImage	Gets the value of the backgroundDisabledImage property. (Android only.)
getBackgroundFocusedColor	Gets the value of the backgroundFocusedColor property. (Android only.)
getBackgroundFocusedImage	Gets the value of the backgroundFocusedImage property. (Android only.)
getBackgroundGradient	Gets the value of the backgroundGradient property. (iPhone, iPad, Mobile Web only.)
getBackgroundImage	Gets the value of the backgroundImage property.
getBackgroundLeftCap	Gets the value of the backgroundLeftCap property. (iPhone, iPad only.)
getBackgroundSelectedColor	Gets the value of the backgroundSelectedColor property. (Android, Mobile Web only.)
getBackgroundSelectedImage	Gets the value of the backgroundSelectedImage property. (Android, Mobile Web only.)
getBackgroundTopCap	Gets the value of the backgroundTopCap property. (iPhone, iPad only.)
getBorderColor	Gets the value of the borderColor property.
getBorderRadius	Gets the value of the borderRadius property.
getBorderWidth	Gets the value of the borderWidth property.
getBottom	Gets the value of the bottom property.
getCenter	Gets the value of the center property.
getData	Gets the value of the data property. (Android, iPhone, iPad only.)
getEnableZoomControls	Gets the value of the enableZoomControls property. (Android only.)
getFocusable	Gets the value of the focusable property. (Android only.)
getHeight	Gets the value of the height property.
getHtml	Gets the value of the html property.
getKeepScreenOn	Gets the value of the keepScreenOn property. (Android only.)
getLayout	Gets the value of the layout property.
getLeft	Gets the value of the left property.
getLoading	Gets the value of the loading property.
getOpacity	Gets the value of the opacity property.
getPluginState	Gets the value of the pluginState property. (Android only.)
getRight	Gets the value of the right property.
getScalesPageToFit	Gets the value of the scalesPageToFit property. (Android, iPhone, iPad only.)
getSize	Gets the value of the size property.
getSoftKeyboardOnFocus	Gets the value of the softKeyboardOnFocus property. (Android only.)
getTop	Gets the value of the top property.
getTouchEnabled	Gets the value of the touchEnabled property.
getTransform	Gets the value of the transform property. (Android, iPhone, iPad only.)
getUrl	Gets the value of the url property.
getVisible	Gets the value of the visible property.
getWidth	Gets the value of the width property.
getZIndex	Gets the value of the zIndex property.
goBack	go back one entry in history to the previous page
goForward	go forward one entry in history to the page before the current page
hide	Hides this view.
reload	reload the current webpage
remove	Removes a child view from this view's hierarchy.
removeEventListener	Removes the specified callback as an event listener for the named event.
repaint	force the webview to repaint its contents
setAnchorPoint	Sets the value of the anchorPoint property. (iPhone, iPad only.)
setBackgroundColor	Sets the value of the backgroundColor property.
setBackgroundDisabledColor	Sets the value of the backgroundDisabledColor property. (Android only.)
setBackgroundDisabledImage	Sets the value of the backgroundDisabledImage property. (Android only.)
setBackgroundFocusedColor	Sets the value of the backgroundFocusedColor property. (Android only.)
setBackgroundFocusedImage	Sets the value of the backgroundFocusedImage property. (Android only.)
setBackgroundGradient	Sets the value of the backgroundGradient property. (iPhone, iPad, Mobile Web only.)
setBackgroundImage	Sets the value of the backgroundImage property.
setBackgroundLeftCap	Sets the value of the backgroundLeftCap property. (iPhone, iPad only.)
setBackgroundSelectedColor	Sets the value of the backgroundSelectedColor property. (Android, Mobile Web only.)
setBackgroundSelectedImage	Sets the value of the backgroundSelectedImage property. (Android, Mobile Web only.)
setBackgroundTopCap	Sets the value of the backgroundTopCap property. (iPhone, iPad only.)
setBasicAuthentication	set the basic authentication for the webview instance to be used on subsequent url requests (Android, iPhone, iPad only.)
setBorderColor	Sets the value of the borderColor property.
setBorderRadius	Sets the value of the borderRadius property.
setBorderWidth	Sets the value of the borderWidth property.
setBottom	Sets the value of the bottom property.
setCenter	Sets the value of the center property.
setData	Sets the value of the data property. (Android, iPhone, iPad only.)
setEnableZoomControls	Sets the value of the enableZoomControls property. (Android only.)
setFocusable	Sets the value of the focusable property. (Android only.)
setHeight	Sets the value of the height property.
setHtml	Sets the value of the html property.
setKeepScreenOn	Sets the value of the keepScreenOn property. (Android only.)
setLayout	Sets the value of the layout property.
setLeft	Sets the value of the left property.
setLoading	Sets the value of the loading property.
setOpacity	Sets the value of the opacity property.
setPluginState	Sets the value of the pluginState property. (Android only.)
setRight	Sets the value of the right property.
setScalesPageToFit	Sets the value of the scalesPageToFit property. (Android, iPhone, iPad only.)
setSize	Sets the value of the size property.
setSoftKeyboardOnFocus	Sets the value of the softKeyboardOnFocus property. (Android only.)
setTop	Sets the value of the top property.
setTouchEnabled	Sets the value of the touchEnabled property.
setTransform	Sets the value of the transform property. (Android, iPhone, iPad only.)
setUrl	Sets the value of the url property.
setVisible	Sets the value of the visible property.
setWidth	Sets the value of the width property.
setZIndex	Sets the value of the zIndex property.
show	Makes this view visible.
stopLoading	stop loading a currently loading page
toImage	Returns an image of the rendered view, as a Blob. (Android, iPhone, iPad only.)

Properties

Name	Type	Summary
anchorPoint	`Point`	Anchor point where animation should occur, relative to the view's boundaries. (iPhone, iPad only.)
animatedCenterPoint	`Point`	Current position of the view during an animation. (Android, iPhone, iPad only.) read-only
backgroundColor	String	Background color of the view.
backgroundDisabledColor	String	Disabled background color of the view. (Android only.)
backgroundDisabledImage	String	Disabled background image for the view, specified as a local file path or URL. (Android only.)
backgroundFocusedColor	String	Focused background color of the view. (Android only.)
backgroundFocusedImage	String	Focused background image for the view, specified as a local file path or URL. (Android only.)
backgroundGradient	`Gradient`	A background gradient for the view. (iPhone, iPad, Mobile Web only.)
backgroundImage	String	Background image for the view, specified as a local file path or URL.
backgroundLeftCap	Number	Size of the left end cap. (iPhone, iPad only.)
backgroundSelectedColor	String	Selected background color of the view. (Android, Mobile Web only.)
backgroundSelectedImage	String	Selected background image url for the view, specified as a local file path or URL. (Android, Mobile Web only.)
backgroundTopCap	Number	Size of the top end cap. (iPhone, iPad only.)
borderColor	String	Border color of the view.
borderRadius	Number	Border radius of the view.
borderWidth	Number	Border width of the view.
bottom	Number or String	View's bottom position, in platform-specific units.
center	`Point`	View's center position, in the parent view's coordinates.
data	Object	a data blob or file that is used to load the web document (Android, iPhone, iPad only.)
enableZoomControls	Boolean	sets whether the zoom controls are enabled (Android only.)
focusable	Boolean	Whether view should be focusable while navigating with the trackball. (Android only.)
height	Number or String	View height, in platform-specific units.
html	String	the html content of the web document
keepScreenOn	Boolean	Whether to keep the device screen on. (Android only.)
layout	String	Specifies how the view positions its children. One of: 'absolute', 'vertical', or 'horizontal'.
left	Number or String	View's left position, in platform-specific units.
loading	Boolean	boolean indicating if the webview is loading content
opacity	Number	Opacity of this view, from 0.0 (transparent) to 1.0 (opaque).
pluginState	Number	set how plugins are processed. Accepts one of `Titanium.UI.Android.WEBVIEW_PLUGINS_OFF`, `Titanium.UI.Android.WEBVIEW_PLUGINS_ON`, or `Titanium.UI.Android.WEBVIEW_PLUGINS_ON_DEMAND`. See Android documentation for WebSettings.PluginState. Only works on Android devices at API Level 8 or greater. (Android only.)
right	Number or String	View's right position, in platform-specific units.
scalesPageToFit	Boolean	whether the webview should scale it's contents or not (Android, iPhone, iPad only.)
size	Object	Size of the view as a dictionary of width and height properties.
softKeyboardOnFocus	Number	Determines keyboard behavior when this view is focused. (Android only.)
top	Number or String	The view's top position.
touchEnabled	Boolean	Whether view should receive touch events.
transform	`Titanium.UI.2DMatrix` or `Titanium.UI.iOS.3DMatrix`	Transformation matrix to apply to the view. (Android, iPhone, iPad only.)
url	String	the url to the web document. this property will change as the content of the webview changes (such as from internal hyperlinks, etc)
visible	Boolean	Boolean value indicating whether the view is visible.
width	Number or String	View's width, in platform-specific units.
zIndex	Number	Z index position relative to other sibling views.

Events

Name	Summary
beforeload	fired before the webview starts loading its content
click	Fired when the device detects a click against the view.
dblclick	Fired when the device detects a double click against the view.
doubletap	Fired when the device detects a double tap against the view. (Android, iPhone, iPad only.)
error	fired when the webview cannot load the content
load	fired when the webview is loaded
longclick	Fired when the device detects a long click. (Android only.)
longpress	Fired when the device detects a long press. (Android, iPhone, iPad only.)
pause	Pause native webview plugins. Add a `pause` handler to your `Titanium.UI.Android.Activity` and invoke this method to pause native plugins. This is important with Flash content as it will continue in the background unless this method is invoked. (Android only.)
pinch	Fired when the device detects a pinch gesture.
resume	Resume native webview plugins. Add a `resume` handler to your `Titanium.UI.Android.Activity` and invoke this method to resume native plugins. (Android only.)
singletap	Fired when the device detects a single tap against the view.
swipe	Fired when the device detects a swipe gesture (left or right) against the view. (iPhone, iPad, Mobile Web only.)
touchcancel	Fired when a touch event is interrupted by the device.
touchend	Fired when a touch event is completed.
touchmove	Fired as soon as the device detects movement of a touch.
touchstart	Fired as soon as the device detects a touch gesture.
twofingertap	Fired when the device detects a two-finger tap against the view.