to top
Android APIs
public class

WebIconDatabase

extends Object
java.lang.Object
   ↳ android.webkit.WebIconDatabase

Class Overview

Functions for manipulating the icon database used by WebView. These functions require that a WebView be constructed before being invoked and WebView.getIconDatabase() will return a WebIconDatabase object. This WebIconDatabase object is a single instance and all methods operate on that single object.

Summary

Nested Classes
interface WebIconDatabase.IconListener Interface for receiving icons from the database. 
Public Methods

? Examples 		void close()
Close the shared instance of the icon database.

? Examples 		static WebIconDatabase getInstance()
Get the global instance of WebIconDatabase.

? Examples 		void open( String path)
Open a the icon database and store the icons in the given path.

? Examples 		void releaseIconForPageUrl( String url)
Release the icon for the given page url.

? Examples 		void removeAllIcons()
Removes all the icons in the database.

? Examples 		void requestIconForPageUrl( String url, WebIconDatabase.IconListener listener)
Request the Bitmap representing the icon for the given page url.

? Examples 		void retainIconForPageUrl( String url)
Retain the icon for the given page url.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public void close ()

Added in API level 1

Close the shared instance of the icon database.

public static WebIconDatabase getInstance ()

Added in API level 1

Get the global instance of WebIconDatabase.

Returns
  • A single instance of WebIconDatabase. It will be the same instance for the current process each time this method is called.

public void open (String path)

Added in API level 1

Open a the icon database and store the icons in the given path.

Parameters
path The directory path where the icon database will be stored.

public void releaseIconForPageUrl (String url)

Added in API level 1

Release the icon for the given page url.

Parameters
url The page's url.

public void removeAllIcons ()

Added in API level 1

Removes all the icons in the database.

public void requestIconForPageUrl (String url, WebIconDatabase.IconListener listener)

Added in API level 1

Request the Bitmap representing the icon for the given page url. If the icon exists, the listener will be called with the result.

Parameters
url The page's url.
listener An implementation on IconListener to receive the result.

public void retainIconForPageUrl (String url)

Added in API level 1

Retain the icon for the given page url.

Parameters
url The page's url.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.