com.google.appinventor.components.runtime

Class WebViewer

java.lang.Object

com.google.appinventor.components.runtime.VisibleComponent

com.google.appinventor.components.runtime.AndroidViewComponent

com.google.appinventor.components.runtime.WebViewer

All Implemented Interfaces:

Component

public final class WebViewer
extends AndroidViewComponent

Component for displaying web pages This is a very limited form of browser. You can view web pages and click on links. It also handles Javascript. There are lots of things that could be added, but this component is mostly for viewing individual pages. It's not intended to take the place of the browser.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WebViewer.WebViewInterface Allows the setting of properties to be monitored from the javascript in the WebView

Field Summary

Fields inherited from class com.google.appinventor.components.runtime.AndroidViewComponent

container

Fields inherited from interface com.google.appinventor.components.runtime.Component

ACCELEROMETER_SENSITIVITY_MODERATE, ACCELEROMETER_SENSITIVITY_STRONG, ACCELEROMETER_SENSITIVITY_WEAK, ALIGNMENT_CENTER, ALIGNMENT_NORMAL, ALIGNMENT_OPPOSITE, ASSET_DIRECTORY, BUTTON_SHAPE_DEFAULT, BUTTON_SHAPE_OVAL, BUTTON_SHAPE_RECT, BUTTON_SHAPE_ROUNDED, COLOR_BLACK, COLOR_BLUE, COLOR_CYAN, COLOR_DEFAULT, COLOR_DKGRAY, COLOR_GRAY, COLOR_GREEN, COLOR_LTGRAY, COLOR_MAGENTA, COLOR_NONE, COLOR_ORANGE, COLOR_PINK, COLOR_RED, COLOR_WHITE, COLOR_YELLOW, DEFAULT_VALUE_COLOR_BLACK, DEFAULT_VALUE_COLOR_BLUE, DEFAULT_VALUE_COLOR_CYAN, DEFAULT_VALUE_COLOR_DEFAULT, DEFAULT_VALUE_COLOR_DKGRAY, DEFAULT_VALUE_COLOR_GRAY, DEFAULT_VALUE_COLOR_GREEN, DEFAULT_VALUE_COLOR_LTGRAY, DEFAULT_VALUE_COLOR_MAGENTA, DEFAULT_VALUE_COLOR_NONE, DEFAULT_VALUE_COLOR_ORANGE, DEFAULT_VALUE_COLOR_PINK, DEFAULT_VALUE_COLOR_RED, DEFAULT_VALUE_COLOR_WHITE, DEFAULT_VALUE_COLOR_YELLOW, DIRECTION_EAST, DIRECTION_MAX, DIRECTION_MIN, DIRECTION_NONE, DIRECTION_NORTH, DIRECTION_NORTHEAST, DIRECTION_NORTHWEST, DIRECTION_SOUTH, DIRECTION_SOUTHEAST, DIRECTION_SOUTHWEST, DIRECTION_WEST, FONT_DEFAULT_SIZE, LAYOUT_ORIENTATION_HORIZONTAL, LAYOUT_ORIENTATION_VERTICAL, LENGTH_FILL_PARENT, LENGTH_PREFERRED, LENGTH_UNKNOWN, SLIDER_MAX_VALUE, SLIDER_MIN_VALUE, SLIDER_THUMB_VALUE, TOAST_LENGTH_LONG, TOAST_LENGTH_SHORT, TYPEFACE_DEFAULT, TYPEFACE_MONOSPACE, TYPEFACE_SANSSERIF, TYPEFACE_SERIF

Constructor Summary

Constructors

Constructor and Description
WebViewer(ComponentContainer container) Creates a new WebViewer component.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	CanGoBack()
boolean	CanGoForward()
void	ClearCaches() Clear the webview cache, both ram and disk.
void	ClearLocations() Clear Stored Location permissions.
java.lang.String	CurrentPageTitle() Returns the title of the page currently being viewed
java.lang.String	CurrentUrl() Returns the URL currently being viewed
boolean	FollowLinks() Indicates whether to follow links when they are tapped in the WebViewer
void	FollowLinks(boolean follow) Determines whether to follow links when they are tapped
android.view.View	getView() Returns the View that is displayed in the UI.
void	GoBack() Go back to the previously viewed page.
void	GoForward() Go forward in the history list
void	GoHome() Loads the page from the home URL.
void	GoToUrl(java.lang.String url) Load the given URL
void	Height(int height) Specifies the component's vertical height, measured in pixels.
java.lang.String	HomeUrl() Returns the URL of the page the WebVewier should load
void	HomeUrl(java.lang.String url) Specifies the URL of the page the WebVewier should load
boolean	IgnoreSslErrors() Determines whether SSL Errors are ignored.
void	IgnoreSslErrors(boolean ignoreSslErrors) Determines whether or not to ignore SSL Errors
boolean	PromptforPermission() Determine if the user should be prompted for permission to use the geolocation API while in the webviewer.
void	PromptforPermission(boolean prompt) Determine if the user should be prompted for permission to use the geolocation API while in the webviewer.
void	UsesLocation(boolean uses) Specifies whether or not this WebViewer can access the JavaScript Location API.
java.lang.String	WebViewString() Gets the web view string
void	WebViewString(java.lang.String newString) Sets the web view string
void	Width(int width) Specifies the component's horizontal width, measured in pixels.

Methods inherited from class com.google.appinventor.components.runtime.AndroidViewComponent

Column, Column, CopyHeight, CopyWidth, getDispatchDelegate, Height, Row, Row, Visible, Visible, Width

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebViewer

public WebViewer(ComponentContainer container)

Creates a new WebViewer component.

Parameters:

container - container the component will be placed in

Method Detail

WebViewString

public java.lang.String WebViewString()

Gets the web view string

Returns:

string

WebViewString

public void WebViewString(java.lang.String newString)

Sets the web view string

getView

public android.view.View getView()

Description copied from class: AndroidViewComponent

Returns the View that is displayed in the UI.

Specified by:

getView in class AndroidViewComponent

Width

public void Width(int width)

Description copied from class: AndroidViewComponent

Specifies the component's horizontal width, measured in pixels.

Overrides:

Width in class AndroidViewComponent

Parameters:

width - in pixels

Height

public void Height(int height)

Description copied from class: AndroidViewComponent

Specifies the component's vertical height, measured in pixels.

Overrides:

Height in class AndroidViewComponent

Parameters:

height - in pixels

HomeUrl

public java.lang.String HomeUrl()

Returns the URL of the page the WebVewier should load

Returns:

URL of the page the WebVewier should load

HomeUrl

public void HomeUrl(java.lang.String url)

Specifies the URL of the page the WebVewier should load

Parameters:

url - URL of the page the WebVewier should load

CurrentUrl

public java.lang.String CurrentUrl()

Returns the URL currently being viewed

Returns:

URL of the page being viewed

CurrentPageTitle

public java.lang.String CurrentPageTitle()

Returns the title of the page currently being viewed

Returns:

title of the page being viewed

FollowLinks

public boolean FollowLinks()

Indicates whether to follow links when they are tapped in the WebViewer

Returns:

true or false

FollowLinks

public void FollowLinks(boolean follow)

Determines whether to follow links when they are tapped

Parameters:

follow -

IgnoreSslErrors

public boolean IgnoreSslErrors()

Determines whether SSL Errors are ignored. Set to true to use self signed certificates

Returns:

true or false

IgnoreSslErrors

public void IgnoreSslErrors(boolean ignoreSslErrors)

Determines whether or not to ignore SSL Errors

Parameters:

ignoreErrors - set to true to ignore SSL errors

GoHome

public void GoHome()

Loads the page from the home URL. This happens automatically when home URL is changed.

GoBack

public void GoBack()

Go back to the previously viewed page.

GoForward

public void GoForward()

Go forward in the history list

CanGoForward

public boolean CanGoForward()

Returns:

true if the WebViewer can go forward in the history list

CanGoBack

public boolean CanGoBack()

Returns:

true if the WebViewer can go back in the history list

GoToUrl

public void GoToUrl(java.lang.String url)

Load the given URL

UsesLocation

public void UsesLocation(boolean uses)

Specifies whether or not this WebViewer can access the JavaScript Location API.

Parameters:

uses - -- Whether or not the API is available

PromptforPermission

public boolean PromptforPermission()

Determine if the user should be prompted for permission to use the geolocation API while in the webviewer.

Returns:

true if prompting is required. False assumes permission is granted.

PromptforPermission

public void PromptforPermission(boolean prompt)

Determine if the user should be prompted for permission to use the geolocation API while in the webviewer.

Parameters:

prompt - set to true to require prompting. False assumes permission is granted.

ClearLocations

public void ClearLocations()

Clear Stored Location permissions. When the geolocation API is used in the WebViewer, the end user is prompted on a per URL basis for whether or not permission should be granted to access their location. This function clears this information for all locations. As the permissions interface is not available on phones older then Eclair, this function is a no-op on older phones.

ClearCaches

public void ClearCaches()

Clear the webview cache, both ram and disk. This is useful when using the webviewer to poll a page that may not be sending appropriate cache control headers. This is particularly useful when using the webviwer to look at a Fusion Table.