Android - An Open Handset Alliance Project

android.webkit
public class

android.webkit.WebView

java.lang.Object
	android.view.View				Drawable.Callback KeyEvent.Callback
		android.view.ViewGroup			ViewManager ViewParent
			android.widget.AbsoluteLayout
				android.webkit.WebView

The Android SDK provides a custom scheme to load assets from the application's .apk file in WebView. The prefix "file:///android_asset/" will cause WebView to load content from the current application's assets folder. For example, a myimage.gif file in the /assets folder can be used in the html image tag as:

Also see ViewGroup.LayoutParams for layout attributes.

Summary

XML Attributes inherited from class android.view.ViewGroup

android:clipChildren, android:clipToPadding

Attribute name	Related methods
android:clipChildren	setClipChildren(boolean)	Defines whether a child is limited to draw inside of its bounds or not.
android:clipToPadding	setClipToPadding(boolean)	Defines whether the ViewGroup will clip its drawing surface so as to exclude the padding area.

XML Attributes inherited from class android.view.View

Attribute name	Related methods
android:background	setBackground(int)	A drawable to use as the background.
android:clickable	setClickable(boolean)	Defines whether this view reacts to click events.
android:drawingCacheQuality	setDrawingCacheQuality(int)	Defines the quality of translucent drawing caches.
android:fadingEdge	setVerticalFadingEdgeEnabled(boolean)	Defines which edges should be fadeded on scrolling.
android:fadingEdgeLength	getVerticalFadingEdgeLength()	Defines the length of the fading edges.
android:fitStatusBar		Boolean internal attribute to adjust view layout based on the status bar location.
android:focusType	setFocusType(int)	Sets the circumstances under which this view will take focus.
android:focusable	setFocusable(boolean)	Boolean that controls whether a view can take focus.
android:focusableInTouchMode	setFocusableInTouchMode(boolean)	Boolean that controls whether a view can take focus while in touch mode.
android:freezeDisabled	setFreezeDisabled(boolean)	If set, no icicle will be saved for this view when it is being frozen.
android:id	setId(int)	Supply an identifier name for this view, to later retrieve it with View.findViewById() or Activity.findViewById().
android:nextFocusDown		Defines the next view to give focus to when the next focus is FOCUS_DOWN If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.
android:nextFocusLeft		Defines the next view to give focus to when the next focus is FOCUS_LEFT.
android:nextFocusRight		Defines the next view to give focus to when the next focus is FOCUS_RIGHT If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.
android:nextFocusUp		Defines the next view to give focus to when the next focus is FOCUS_UP If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.
android:padding	setPadding(int,int,int,int)	Sets the padding, in pixels, of all four edges.
android:paddingBottom	setPadding(int,int,int,int)	Sets the padding, in pixels, of the bottom edge; see padding.
android:paddingLeft	setPadding(int,int,int,int)	Sets the padding, in pixels, of the left edge; see padding.
android:paddingRight	setPadding(int,int,int,int)	Sets the padding, in pixels, of the right edge; see padding.
android:paddingTop	setPadding(int,int,int,int)	Sets the padding, in pixels, of the top edge; see padding.
android:scrollX		The initial horizontal scroll offset, in pixels.
android:scrollY		The initial vertical scroll offset, in pixels.
android:scrollbarDefaultDelayBeforeFade		Delay in milliseconds before the scrollbars disappear.
android:scrollbarFadeDuration		Duration in milliseconds of the fade when the scrollbars disappear.
android:scrollbarSize		Sets the width of vertical scrollbars and height of horizontal scrollbars.
android:scrollbarThumbHorizontal		Drawable for horizontal scrollbars' thumb.
android:scrollbarThumbVertical		Drawable for vertical scrollbars' thumb.
android:scrollbarTrackHorizontal		Drawable for horizontal scrollbars' track.
android:scrollbarTrackVertical		Drawable for vertical scrollbars' track.
android:scrollbars		Defines which scrollbars should be displayed on scrolling or not.
android:visibility	setVisibility(int)	Controls the initial visibility of the view.

Constants inherited from class android.view.ViewGroup

FLAG_SUPPORT_STATIC_TRANSFORMATIONS, PERSISTENT_ALL_CACHES, PERSISTENT_ANIMATION_CACHE, PERSISTENT_NO_CACHE, PERSISTENT_SCROLLING_CACHE

			Value
int	FLAG_SUPPORT_STATIC_TRANSFORMATIONS	When set, this ViewGroup supports static transformations on children; this causes getChildStaticTransformation(View, android.view.animation.Transformation) to be invoked when a child is drawn.	2048	0x00000800
int	PERSISTENT_ALL_CACHES	Used to indicate that all drawing caches should be kept in memory.	3	0x00000003
int	PERSISTENT_ANIMATION_CACHE	Used to indicate that the animation drawing cache should be kept in memory.	1	0x00000001
int	PERSISTENT_NO_CACHE	Used to indicate that no drawing cache should be kept in memory.	0	0x00000000
int	PERSISTENT_SCROLLING_CACHE	Used to indicate that the scrolling drawing cache should be kept in memory.	2	0x00000002

Constants inherited from class android.view.View

DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, GONE, INVISIBLE, NORMAL_FOCUS, NO_ID, VIEW_LOG_TAG, VISIBLE, WEAK_FOCUS

			Value
int	DRAWING_CACHE_QUALITY_AUTO	Enables automatic quality mode for the drawing cache.	0	0x00000000
int	DRAWING_CACHE_QUALITY_HIGH	Enables high quality mode for the drawing cache.	1048576	0x00100000
int	DRAWING_CACHE_QUALITY_LOW	Enables low quality mode for the drawing cache.	524288	0x00080000
int	FOCUS_BACKWARD	Use with focusSearch(int).	1	0x00000001
int	FOCUS_DOWN	Use with focusSearch(int).	130	0x00000082
int	FOCUS_FORWARD	Use with focusSearch(int).	2	0x00000002
int	FOCUS_LEFT	Use with focusSearch(int).	17	0x00000011
int	FOCUS_RIGHT	Use with focusSearch(int).	66	0x00000042
int	FOCUS_UP	Use with focusSearch(int).	33	0x00000021
int	GONE	This view is invisible, and it doesn't take any space for layout purposes.	8	0x00000008
int	INVISIBLE	This view is invisible, but it still takes up space for layout purposes.	4	0x00000004
int	NORMAL_FOCUS	This view wants keystrokes.	0	0x00000000
int	NO_ID	Used to mark a View that has no ID.	-1	0xffffffff
String	VIEW_LOG_TAG	The logging tag used by this class with android.util.Log.	"View"
int	VISIBLE	This view is visible.	0	0x00000000
int	WEAK_FOCUS	This view wants keystrokes, but only if none of its children has focus.	2	0x00000002

Fields inherited from class android.view.ViewGroup

mDisappearingChildren, mGroupFlags, mOnHierarchyChangeListener, mPersistentDrawingCache

Fields inherited from class android.view.View

mBottom, mContext, mLayoutParams, mLeft, mLocation, mOnClickListener, mOnFocusChangeListener, mOnLongClickListener, mOnPopulateContextMenuListener, mPaddingBottom, mPaddingLeft, mPaddingRight, mPaddingTop, mParent, mRight, mScrollX, mScrollY, mTag, mTop

protected		int	mBottom	The distance in pixels from the top edge of this view's parent to the bottom edge of this view.
protected		Context	mContext	The application environment this view lives in.
protected		LayoutParams	mLayoutParams	The layout parameters associated with this view and used by the parent ViewGroup to determine how this view should be laid out.
protected		int	mLeft	The distance in pixels from the left edge of this view's parent to the left edge of this view.
protected	final	int[]	mLocation	Used to store a pair of coordinates, for instance returned values returned by getLocationInWindow(int[]).
protected		OnClickListener	mOnClickListener	Listener used to dispatch click events.
protected		OnFocusChangeListener	mOnFocusChangeListener	Listener used to dispatch focus change events.
protected		OnLongClickListener	mOnLongClickListener	Listener used to dispatch long click events.
protected		OnPopulateContextMenuListener	mOnPopulateContextMenuListener	Listener used to build the context menu.
protected		int	mPaddingBottom	The bottom padding in pixels, that is the distance in pixels between the bottom edge of this view and the bottom edge of its content.
protected		int	mPaddingLeft	The left padding in pixels, that is the distance in pixels between the left edge of this view and the left edge of its content.
protected		int	mPaddingRight	The right padding in pixels, that is the distance in pixels between the right edge of this view and the right edge of its content.
protected		int	mPaddingTop	The top padding in pixels, that is the distance in pixels between the top edge of this view and the top edge of its content.
protected		ViewParent	mParent	The parent this view is attached to.
protected		int	mRight	The distance in pixels from the left edge of this view's parent to the right edge of this view.
protected		int	mScrollX	The offset, in pixels, by which the content of this view is scrolled horizontally.
protected		int	mScrollY	The offset, in pixels, by which the content of this view is scrolled vertically.
protected		Object	mTag	The view's tag.
protected		int	mTop	The distance in pixels from the top edge of this view's parent to the top edge of this view.

Public Constructors

					WebView(Context context)
					WebView(Context context, AttributeSet attrs, Map inflateParams)
					Construct a new WebView with layout parameters.
					WebView(Context context, AttributeSet attrs, Map inflateParams, int defStyle)

Public Methods

	void	addJavascriptInterface(Object obj, String interfaceName)
		Use this function to bind a Java object to Javascript so that the methods can be accessed from Javascript.
	boolean	canGoBack()
		Return true if this WebView has a back history item.
	boolean	canGoBackOrForward(int steps)
		Return true if the page can go back or forward the given number of steps.
	boolean	canGoForward()
		Return true if this WebView has a forward history item.
	void	clearAllUsernamesAndPasswords()
		Clear all the username and password pairs stored in the internal database.
	void	clearCache()
		Clear the resource cache.
	void	clearFormData()
		Make sure that clearing the form data removes the adapter from the currently focused textfield if there is one.
	void	clearHistory()
		Tell the WebView to clear its internal back/forward list.
	void	clearHttpAuthUsernamePassword()
		Clear the HTTP authorization data stored in response to HTTP authentication requests.
	void	clearSslPreferences()
		Clear the SSL preferences table stored in response to proceeding with SSL certificate errors.
	void	computeScroll()
		Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary.
	WebBackForwardList	copyBackForwardList()
		Return the WebBackForwardList for this WebView.
	Bitmap	createSnapshot(int width, int height, float scale)
		Create a snapshot of the page in the given width and height with the given scale.
	void	destroy()
		Destroy the internal state of the WebView.
static	void	disablePlatformNotifications()
		If platform notifications are enabled, this should be called from onPause() or onStop().
	boolean	dispatchTouchEvent(MotionEvent ev)
		Pass the touch screen motion event down to the target view, or this view if it is the target.
static	void	enablePlatformNotifications()
		Enables platform notifications of data state and proxy changes.
	void	findFirst(String find, Message response)
		Find and highlight the first occurance of find, beginning with the start of the page.
	void	findNext(String find, Message response)
		Find and highlight the next occurance of the String find, beginning with the current selection.
	void	findPrevious(String find, Message response)
		Find and highlight the previous occurance of the String find, beginning with the current selection.
	Bitmap	getFavicon()
		Get the favicon for the current page.
	String	getFocusNodePath()
		Return a proper String depending on the type of the focus node.
	String[]	getHttpAuthUsernamePassword(String host, String realm)
		Retrieve the HTTP authentication username and password for a given host & realm pair
	int	getProgress()
		Get the progress for the current page.
	WebSettings	getSettings()
		Return the WebSettings object used to control the settings for this WebView.
	String	getTitle()
		Get the title for the current page.
	String	getUrl()
		Get the url for the current page.
	int	getZoomWidth()
		Return the current zoom width of the WebView.
	void	goBack()
		Go back in the history of this WebView.
	void	goBackOrForward(int steps)
		Go to the history item that is the number of steps away from the current item.
	void	goForward()
		Go forward in the history of this WebView.
	boolean	hasFormData()
		Returns true if there is any form data stored in this WebView's internal database.
	boolean	hasHttpAuthUsernamePassword()
	boolean	hasUsernameAndPassword()
		Returns true if there is a username and password pair stored in the WebView's internal database.
	void	invokeZoomPicker()
		Invoke the graphical zoom picker widget for this WebView.
	void	loadData(String data, String mimeType, String encoding)
		Load the given data into the WebView.
	void	loadDataWithBaseURL(String baseUrl, String data, String mimeType, String encoding, String failUrl)
		Load the given data into the WebView, use the provided URL as the base URL for the content.
	void	loadUrl(String url)
		Load the given url.
	boolean	onKeyDown(int keyCode, KeyEvent event)
		Default implementation of KeyEvent.Callback.onKeyMultiple(): perform press of the view when KEYCODE_DPAD_CENTER or KEYCODE_NEWLINE is released, if the view is enabled and clickable.
	boolean	onKeyUp(int keyCode, KeyEvent event)
		Default implementation of KeyEvent.Callback.onKeyMultiple(): perform clicking of the view when KEYCODE_DPAD_CENTER or KEYCODE_NEWLINE is released.
	void	pauseTimers()
		Pause all layout, parsing, and javascript timers.
	boolean	performLongClick()
		Call this view's OnLongClickListener, if it is defined.
	void	reload()
		Reload the current url.
	boolean	requestChildRectangleOnScreen(View child, Rect rect, boolean immediate)
		Called when a child of this group wants a particular rectangle to be positioned onto the screen.
	boolean	requestFocus(int direction, Rect previouslyFocusedRect)
		Call this to try to give focus to a specific view or to one of its descendants and give it hints about the direction and a specific rectangle that the focus is coming from. This implements the focus type logic (getFocusType()), respecting this group's preference for NORMAL_FOCUS or WEAK_FOCUS.
	void	requestFocusNodeHref(Message hrefMsg)
		Request the href of an anchor element due to getFocusNodePath returning "href." If hrefMsg is null, this method returns immediately and does not dispatch hrefMsg to its target.
	WebBackForwardList	restoreState(Bundle inState)
		Restore the state of this WebView from the given map used in Activity.onThaw.
	void	resumeTimers()
		Resume all layout, parsing, and javascript timers.
	void	savePassword(String host, String username, String password)
		Save the username and password for a particular host in the WebView's internal database.
	WebBackForwardList	saveState(Bundle outState)
		Save the state of this WebView used in Activity.onFreeze.
	void	setDownloadListener(DownloadListener listener)
		Register the interface to be used when content can not be handled by the rendering engine, and should be downloaded instead.
	void	setHttpAuthUsernamePassword(String host, String realm, String username, String password)
		Set the HTTP authentication credentials for a given host and realm.
	void	setLayoutParams(LayoutParams params)
		Set the layout parameters associated with this view.
	void	setWebBackForwardListClient(WebBackForwardListClient client)
		Set the WebBackForwardListClient.
	void	setWebChromeClient(WebChromeClient client)
		Set the chrome handler.
	void	setWebViewClient(WebViewClient client)
		Set the WebViewClient that will receive various notifications and requests.
	void	setZoomWidth(int width)
		Set a new zoom width for the WebView.
	void	stopLoading()
		Stop the current load.

Protected Methods

				int	computeHorizontalScrollRange()
					Compute the horizontal range that the horizontal scrollbar represents.
				int	computeVerticalScrollRange()
					Compute the vertical range that the vertical scrollbar represents.
				void	finalize()
					Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
				void	onDraw(Canvas canvas)
					Implement this to do your drawing.
				void	onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect)
					Called by the view system when the focus state of this view changes.
				void	onMeasure(int widthMeasureSpec, int heightMeasureSpec)
					Measure the view and its content to determine the measured width and the measured height.
				void	onScrollChanged(int l, int t, int oldl, int oldt)
					This is called in response to an internal scroll in this view (i.e., the view scrolled its own contents).
				void	onSizeChanged(int w, int h, int ow, int oh)
					This is called during layout when the size of this view has changed.

Methods inherited from class android.widget.AbsoluteLayout

Methods inherited from class android.view.ViewGroup

addView, addView, addView, addView, addViewInLayout, addViewInLayout, addsStatesFromChildren, attachLayoutAnimationParameters, attachViewToParent, bringChildToFront, canAnimate, checkLayoutParams, childDrawableStateChanged, cleanupLayoutState, clearChildFocus, clearDisappearingChildren, clearFocus, debug, detachAllViewsFromParent, detachViewFromParent, detachViewFromParent, dispatchDraw, dispatchFreeze, dispatchFreezeSelfOnly, dispatchKeyEvent, dispatchThaw, dispatchThawSelfOnly, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchWindowFocusChanged, dispatchWindowVisibilityChanged, findFocus, focusSearch, focusableViewAvailable, gatherTransparentRegion, generateLayoutParams, getChildAt, getChildCount, getChildMeasureSpec, getChildStaticTransformation, getChildVisibleRect, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getPeristentDrawingCache, hasFocus, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isChildrenDrawnWithCacheEnabled, isKeepAnimations, measureChild, measureChildWithMargins, measureChildren, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onCreateDrawableState, onInterceptTouchEvent, onLayout, removeAllViews, removeAllViewsInLayout, removeDetachedView, removeView, removeViewAt, removeViewInLayout, requestChildFocus, requestChildRectangleOnScreen, requestFocus, requestTransparentRegion, scheduleLayoutAnimation, setAddsStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setChildrenDrawingCacheEnabled, setChildrenDrawnWithCacheEnabled, setClipChildren, setClipToPadding, setKeepAnimations, setLayoutAnimation, setLayoutAnimationListener, setOnHierarchyChangeListener, setPadding, setPersistentDrawingCache, setSelected, showContextMenuForChild, startLayoutAnimation, updateViewLayout

				void	addView(View child, int index)
					Adds a child view that already has layout parameters set on it.
				void	addView(View child, int index, LayoutParams params)
					Adds a child view with the specified layout parameters.
				void	addView(View child, LayoutParams params)
					Adds a child view with the specified layout parameters.
				void	addView(View child)
					Adds a child view that already has layout parameters set on it.
				boolean	addViewInLayout(View child, int index, LayoutParams params)
					Adds a view during layout.
				boolean	addViewInLayout(View child, int index, LayoutParams params, boolean preventRequestLayout)
					Adds a view during layout.
				boolean	addsStatesFromChildren()
					Returns whether this ViewGroup's drawable states also include its children's drawable states.
				void	attachLayoutAnimationParameters(View child, LayoutParams params, int index, int count)
					Subclasses should override this method to set layout animation parameters on the supplied child.
				void	attachViewToParent(View child, int index, LayoutParams params)
					Attaches a view to this view group.
				void	bringChildToFront(View child)
					Change the z order of the child so it's on top of all other children
				boolean	canAnimate()