WebView
The Webview is the core container used for rendering your application code. You can control certain behaviours of the webview by using this API class.
Enabling the API
This API is part of the coreapi extension that is included automatically.
extensions: ["coreapi"]
JavaScript Usage
Be sure to review the JavaScript API Usage guide for important information about using this API in JavaScript
Ruby Usage
Be sure to review the Ruby API Usage guide for important information about using this API in Ruby
Methods
active_tab()
Use Rho::NativeTabbar.currentTab property: returns the current tab index.
Synchronous Return:
- INTEGER
Method Access:
-
Class Method: This method can only be accessed via the API class object.
- JavaScript:
Rho.WebView.active_tab() - Ruby:
Rho::WebView.active_tab()
- JavaScript:
currentLocation(INTEGER tabIndex)
Returns the relative url (location) of the current page(without server and port); the last URL loaded to WebView from controller action.
Parameters
- tabIndex : INTEGER Optional Default: -1
TabBar tab index. If no tab bar present, index is ignored. Current location of active WebView.
Synchronous Return:
- STRING
Method Access:
-
Class Method: This method can only be accessed via the API class object.
- Ruby:
Rho::WebView.currentLocation(INTEGER tabIndex)
- Ruby:
currentURL(INTEGER tabIndex)
Returns the actual URL in WebView. This works the same as the JavaScript window.location.href.
Parameters
- tabIndex : INTEGER Optional Default: -1
TabBar tab index. If no tab bar present, index is ignored. Current url of active WebView.
Synchronous Return:
- STRING
Method Access:
-
Class Method: This method can only be accessed via the API class object.
- Ruby:
Rho::WebView.currentURL(INTEGER tabIndex)
- Ruby:
executeJavascript(STRING JavaScriptText, INTEGER tabIndex)
Execute JavaScript on the current page from your controller.
Parameters
- javascriptText : STRING
The call to the JavaScript method on the current page, such as "test();".
- tabIndex : INTEGER Optional Default: -1
TabBar tab index. If no tab bar present, index is ignored. Execute JavaScript in active WebView.
Synchronous Return:
- Void
Method Access:
-
Class Method: This method can only be accessed via the API class object.
- Ruby:
Rho::WebView.executeJavascript(STRING JavaScriptText, INTEGER tabIndex)
- Ruby:
full_screen_mode(BOOLEAN enable)
Use WebView.fullScreen property: Switch to/from full screen mode.
Parameters
- enable : BOOLEAN
Synchronous Return:
- Void
Method Access:
-
Class Method: This method can only be accessed via the API class object.
- JavaScript:
Rho.WebView.full_screen_mode(BOOLEAN enable) - Ruby:
Rho::WebView.full_screen_mode(BOOLEAN enable)
- JavaScript:
navigate(STRING url, INTEGER tabIndex)
Force WebView to navigate to a URL.
navigateBack(INTEGER tabIndex)
Force WebView to navigate to the previous page using Browser back.
refresh(INTEGER tabIndex)
Force WebView to refresh the current page.
Parameters
- tabIndex : INTEGER Optional Default: -1
TabBar tab index. If no tab bar present, index is ignored. Refresh active WebView.
Synchronous Return:
- Void
Method Access:
-
Class Method: This method can only be accessed via the API class object.
- JavaScript:
Rho.WebView.refresh(INTEGER tabIndex) - Ruby:
Rho::WebView.refresh(INTEGER tabIndex)
- JavaScript:
save(STRING format, STRING path, INTEGER tabIndex)
Save current page to file system.
Parameters
- format : STRING
Format of the saved page.
Possible Values :
- WebView.SAVE_FORMAT_JPEG - (jpeg)
- Save as jpeg image
- path : STRING
Path to the file/folder to save the page.
- tabIndex : INTEGER Optional Default: -1
TabBar tab index. If no tab bar present, index is ignored. If tabbar index ommited then active WebView will be saved.
Synchronous Return:
- Void
Method Access:
-
Class Method: This method can only be accessed via the API class object.
- JavaScript:
Rho.WebView.save(STRING format, STRING path, INTEGER tabIndex) - Ruby:
Rho::WebView.save(STRING format, STRING path, INTEGER tabIndex)
- JavaScript:
setCookie(STRING url, STRING cookie)
When WebView loads the specified url (either by selecting link or from calling WebView.navigate), it will add this cookie to the HTTP request.Not implemented for Zebra Technologies' WebKit.
Parameters
- url : STRING
Set a cookie to be used by WebView for this url.
- cookie : STRING
One or more name/value pairs of the format "NAME=VALUE". Separate multiple name/value pairs with a semicolon, such as "NAME1=VALUE1; NAME2=VALUE2".
Synchronous Return:
- Void
Method Access:
-
Class Method: This method can only be accessed via the API class object.
- Ruby:
Rho::WebView.setCookie(STRING url, STRING cookie)
- Ruby:
set_menu_items(HASH menuItems)
Use Rho::Application.nativeMenu property: set native menu items.
Properties
activeTab : INTEGER Read Only
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.activeTab - Ruby:
Rho::WebView.activeTab
- JavaScript:
cacheSize : INTEGER Read Only
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.cacheSize - Ruby:
Rho::WebView.cacheSize
- JavaScript:
enableCache : BOOLEAN Read Only
Default: true
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.enableCache - Ruby:
Rho::WebView.enableCache
- JavaScript:
enablePageLoadingIndication : BOOLEAN Read Only
Default: true
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.enablePageLoadingIndication - Ruby:
Rho::WebView.enablePageLoadingIndication
- JavaScript:
enableWebPlugins : BOOLEAN Read Only
Default: true
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.enableWebPlugins - Ruby:
Rho::WebView.enableWebPlugins
- JavaScript:
enableZoom : BOOLEAN Read Only
Default: true
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.enableZoom - Ruby:
Rho::WebView.enableZoom
- JavaScript:
fontFamily : STRING Read Only
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.fontFamily - Ruby:
Rho::WebView.fontFamily
- JavaScript:
framework : STRING Read Only
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.framework - Ruby:
Rho::WebView.framework
- JavaScript:
fullScreen : BOOLEAN
Default: false
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.fullScreen - Ruby:
Rho::WebView.fullScreen
- JavaScript:
navigationTimeout : INTEGER
scrollTechnique : STRING Read Only
Default: FingerScroll
Possible Values (STRING):
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.scrollTechnique - Ruby:
Rho::WebView.scrollTechnique
- JavaScript:
textZoomLevel : INTEGER
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.textZoomLevel - Ruby:
Rho::WebView.textZoomLevel
- JavaScript:
userAgent : STRING Read Only
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.userAgent - Ruby:
Rho::WebView.userAgent
- JavaScript:
viewportEnabled : BOOLEAN Read Only
Default: true
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.viewportEnabled - Ruby:
Rho::WebView.viewportEnabled
- JavaScript:
viewportWidth : INTEGER Read Only
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.viewportWidth - Ruby:
Rho::WebView.viewportWidth
- JavaScript:
zoomPage : FLOAT
Property Access:
-
Class: This property can only be accessed via the API class object.
- JavaScript:
Rho.WebView.zoomPage - Ruby:
Rho::WebView.zoomPage
- JavaScript:
Examples
#call JavaScript alert on the current page Rho::WebView.executeJavascript("alert('This is Webview.executejavascript function');")
#call JQuery Mobile from a Ruby controller Rho::WebView.executeJavascript("$.mobile.changePage('#my_page');")
function greet(name) { alert("Hello, "+name); }
#call a custom JavaScript function from Ruby Rho::WebView.executeJavascript("greet('John Doe');")
# Toggle fullScreen on / off Rho::WebView.fullScreen = !Rho::WebView.fullScreen
// Fullscreen can also be invoked from JavaScript Rho.WebView.fullScreen = true; Rho.WebView.fullScreen = false;
#Force WebView to navigate to a URL. Rho::WebView.navigate(url_for(:action => :my_action))
#Navigate out of the local application and into an externally-served site Rho::WebView.navigate("http://www.example.com");
//Navigate out of the local application and into an externally-served site Rho.WebView.navigate("http://www.example.com");
#Force WebView to navigate to the previous page using Browser back. Rho::WebView.navigateBack
//Force WebView to navigate to the previous page using Browser back.
Rho.WebView.navigateBack();
# Update database or variables here # ... # Refresh the current page to show new information Rho::WebView.refresh
# Reload the page on WebView number 2 Rho::WebView.refresh(2)
// Reload the current page Rho.WebView.refresh() // Reload the page on WebView number 3 Rho.WebView.refresh(3)