public class

WebView

extends View

java.lang.Object
↳	com.neomades.ui.View
	↳	com.neomades.ui.WebView

Class Overview

A View that displays web pages.

This class is the basis upon which you can roll your own web browser or simply display some online content within your Screen. It includes methods to navigate forward and backward through a history, zoom in and out, perform text searches and more. A WebView could load an URL with the loadURL(String) method or a part of HTML code with the loadHTML(String, String, String) method.
A WebView will enforce a MATCH_PARENT stretch mode in both directions.

WebView and network security

Permission

To use this class, the WEB_VIEW permission must be declared in the URS file.

App Transport Security for iOS

WebView connections, like other HTTP connections in the application, must follow the ATS requirements:

The HTTP connection must use HTTPS
The negotiated Transport Layer Security (TLS) version of the contacted server must be TLS 1.2.
The digital certificate of the server must follow the X. 509 norm and must be trusted by a certificate authority.
The leaf server certificate must be signed with RSA or ECC keys.
The connection must use either the AES-128 or AES-256 symmetric cipher.

If the back end server the WebView must contact is outside of your scope (a third party server for example), the ATS requirements can be bypassed by configuring the URS of the project. However, in that case, you will have to justify it in iTunes Connect when the application will be prepared for publication and Apple may reject the application.

Full documentation about ATS and network security are available at NeoMAD documentation.

Javascript and HTML errors

By default, a WebView provides no browser-like widgets, does not enable JavaScript and web page errors are ignored.

Summary

XML Attributes
Attribute Name	Related Method	Description
horizontalScroll	setHorizontalScroll(boolean)	If the scrollview could scroll horizontally
openUrlEnabled	setOpenURLEnabled(boolean)
padding	setPadding(int)	eg: 10dp or 10 (dp is the default unit)
paddingBottom	setPaddingBottom(int)	eg: 10dp or 10 (dp is the default unit)
paddingLeft	setPaddingLeft(int)	eg: 10dp or 10 (dp is the default unit)
paddingRight	setPaddingRight(int)	eg: 10dp or 10 (dp is the default unit)
paddingTop	setPaddingTop(int)	eg: 10dp or 10 (dp is the default unit)
readOnly	setReadOnly(boolean)	If the text inside is not editable
textZoom	setTextZoom(int)
verticalScroll	setVerticalScroll(boolean)	If the scrollview could scroll vertically
zoomEnabled	setZoomEnabled(boolean)

[Expand]

Inherited XML Attributes

From class com.neomades.ui.View

[Expand]

Inherited Constants

From interface com.neomades.ui.Alignment

From interface com.neomades.ui.StretchMode

Public Constructors
	WebView()

Public Methods
boolean	canGoBack() Returns if this `WebView` can go back in the history.
boolean	canGoForward() Returns if this `WebView` can go forward in the history.
void	clearCache() Clears the cache of the WebView.
void	clearCookies() Clears all the stored cookie.
List<HttpCookie>	getCookies() Gets the cookies of the WebView for the current URL.
void	goBack() Goes back in the history of this WebView.
void	goForward() Goes forward in the history of this WebView.
void	loadHTML(String html, String mimeType, String baseURL) Loads the given data into this WebView using a 'base' scheme URL.
void	loadURL(String url) Loads the given URL.
void	reload() Reloads the current URL.
void	setCookiePolicy(CookiePolicy policy) Sets the cookie policy of the Webview.
void	setHorizontalScroll(boolean enabled) Sets if this `WebView` should display the horizontal scrollbar when scrolling.
void	setOpenURLEnabled(boolean openUrlEnabled) Sets if a click on a link should open the page in this WebView or in the browser.
void	setPadding(int leftDp, int topDp, int rightDp, int bottomDp) Has no effect on WebView.
void	setPadding(int uniformPaddingDp) Has no effect on WebView.
void	setPaddingBottom(int paddingBottomDp) Has no effect on WebView.
void	setPaddingLeft(int paddingLeftDp) Has no effect on WebView.
void	setPaddingRight(int paddingRightDp) Has no effect on WebView.
void	setPaddingTop(int paddingTopDp) Has no effect on WebView.
void	setReadOnly(boolean readOnly) Sets this `WebView` in read-only mode.
void	setTextZoom(int textZoom) By default, this property is `100` %.
void	setVerticalScroll(boolean enabled) Sets if this `WebView` should display the vertical scrollbar when scrolling.
void	setZoomEnabled(boolean enabled) Sets this `WebView` can zoom-in or zoom-out content.
void	stopLoading() Stops the current load.

Protected Methods
void	onProgressChanged(WebView view, int progress) Override this method in order to listen the loading progress.
boolean	shouldOverrideUrlLoading(WebView webView, String url) Give the host application a chance to take over the control when a new URL is about to be loaded in the current WebView.

[Expand]

Inherited Methods

From class com.neomades.ui.View

View	findView(int viewId) Find view by Id.
int	getId() Returns the identifier of this element, by default all elements return "0".
Object	getTag() Returns this view's tag.
static View	inflateXML(int layoutResId) Inflate view from XMLLayout declared in the URS File.
static View	inflateXML(InputStream xmlStream) @return
boolean	isClickable() Returns if the view is clickable.
boolean	isEnabled() Return a boolean indicating if the view is enabled or not
boolean	isFocusable() Returns if the view is focusable (for the devices that have a keyboard Ui navigation).
boolean	isVisible() Returns if the view is visible
void	runOnUiThread(Runnable action) Calls `action.run()` asynchronously on the `UI-Thread`.
void	setBackground(Background background) Sets the background on this view.
void	setBackground(int backgroundResId) Sets the background on this view with a XML background definition.
void	setBackgroundColor(Color color) Sets the background color on this view.
void	setBackgroundImage(int imageID) Set the background image for this view.
void	setBackgroundImage(Image image) Set the background image for this view.
void	setBorderColor(Color borderColor) Sets the border color on this view.
void	setBorderWidth(int widthInDp) Set the border width (size) in DP units.
void	setClickListener(ClickListener clickListener) Sets a ClickListener to this view.
void	setClickable(boolean clickable) Sets this view clickable.
void	setCornerRadius(int radiusSize) Set the four corners radius, if the view has corners.
void	setDrawingCacheEnabled(boolean enabled) Enables or disables the drawing cache.
void	setEnabled(boolean enabled) Sets the state of this view to enabled or disabled.
void	setFocusable(boolean focusable) Sets the view focusable.
void	setGestureDetector(GestureDetector detector) Sets a `GestureDetector` on this view.
void	setHeight(int heightDp) Sets the height of the view, in dp units (density-independent pixels).
void	setId(int id) Sets a identifier/tag to this element
void	setInvalidateDisabled(boolean disabled) If set to true, force the layout that contains the view to not be draw again when its content changes.
void	setLayoutAlignment(int alignment) Sets the view alignment into its parent.
void	setMargin(int uniformMarginDp) Set the margin outside this view (used by `Layout`), by setting on each side the given value.
void	setMargin(int leftDp, int topDp, int rightDp, int bottomDp) Set the margin outside this view (used by `Layout`).
void	setMarginBottom(int marginBottomDp) Sets the bottom margin with the given value.
void	setMarginLeft(int marginLeftDp) Sets the left margin with the given value.
void	setMarginRight(int marginRightDp) Sets the right margin with the given value.
void	setMarginTop(int marginTopDp) Sets the top margin with the given value.
void	setPadding(int leftDp, int topDp, int rightDp, int bottomDp) Sets the view padding.
void	setPadding(int uniformPaddingDp) Sets the view padding, with for each side the value given in parameter.
void	setPaddingBottom(int paddingBottomDp) Sets the bottom padding with the given value.
void	setPaddingLeft(int paddingLeftDp) Sets the left padding with the given value.
void	setPaddingRight(int paddingRightDp) Sets the right padding with the given value.
void	setPaddingTop(int paddingTopDp) Sets the top padding with the given value.
void	setSize(int widthDp, int heightDp) Sets the size of the view, in dp units (density-independent pixels).
void	setStretchHorizontalMode(int widthMode) Sets the stretch horizontal mode.
void	setStretchMode(int horizontalMode, int verticalMode) Sets the view content stretch mode.
void	setStretchVerticalMode(int heightMode) Sets the stretch vertical mode.
void	setStyle(int styleResId)
void	setStyle(Style style)
void	setTag(Object tag) Sets the tag associated with this view.
void	setTouchListener(TouchListener touchListener) Register a listener to be invoked when a touch event is dispatched to this view.
void	setTransformOrigin(float xOrigin, float yOrigin) Sets the x and y location of the point around which the view will be scaled or rotated when an animation occurs.
void	setVisible(boolean visible) Sets the view's visibility : visible or invisible/hidden
void	setWidth(int widthDp) Sets the width of the view, in dp units (density-independent pixels).

From class java.lang.Object

boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
final Class<?>	getClass() Returns the runtime class of an object.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
final void	wait() Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

XML Attributes

horizontalScroll

If the scrollview could scroll horizontally

Related Methods

setHorizontalScroll(boolean)