public class DefaultDocumentRequestHandler

  1. Object
  2. DefaultDocumentRequestHandler

ImplementsAsyncDocumentRequestHandler, DocumentRequestHandler

Known subtypesAsyncDocumentRequestHandlerImpl

Default implementation of the HTML components document request handler to allow simple HTML support in Codename One. This version includes only the basics supported by MIDP e.g. resources and jar file URL’s such as jar:// and res://

Constructors

public DefaultDocumentRequestHandler()

Methods

public static Resources getResFile()Allows URL’s referring to a res:// local resource to default to this file
public static void setResFile(Resources res)Allows URL’s referring to a local:// local resource to default to this file
public void resourceRequestedAsync(DocumentInfo docInfo, IOCallback callback)This method is called by HTMLComponent when a resource is requested asynchronously.
public InputStream resourceRequested(DocumentInfo docInfo)Implementations should return the document in the requested url as an InputStream This is triggered only for the main document requested and not for its resources.
protected void visitingURL(String url)This method can be invoked to indicate a URL was visited fro tracking
public boolean wasURLVisited(String url)Returns true if the URL was visited, requires trackVisitedURLs to be true
public boolean isTrackVisitedURLs()Allows tracking whether a URL was visited or not
public void setTrackVisitedURLs(boolean trackVisitedURLs)Allows tracking whether a URL was visited or not

Inherited methods

Constructor details

DefaultDocumentRequestHandler

public DefaultDocumentRequestHandler()

Method details

getResFile

public static Resources getResFile()
Allows URL’s referring to a res:// local resource to default to this file

Returns

the resFile

setResFile

public static void setResFile(Resources res)
Allows URL’s referring to a local:// local resource to default to this file

Parameters

res Resources
the resource

resourceRequestedAsync

public void resourceRequestedAsync(DocumentInfo docInfo, IOCallback callback)
This method is called by HTMLComponent when a resource is requested asynchronously. This method should return immediately and start a process of fetching the requested resource on another thread. When the resource was fetched, the HTMLComponent.streamReady should be called.

Parameters

docInfo DocumentInfo
A DocumentInfo object representing the requested URL and its attributes
callback IOCallback
The HTMLComponent that should be called back when the stream was fetched.

resourceRequested

public InputStream resourceRequested(DocumentInfo docInfo)
Implementations should return the document in the requested url as an InputStream This is triggered only for the main document requested and not for its resources.

Parameters

docInfo DocumentInfo
A DocumentInfo object representing the requested URL and its attributes

Returns

the document at the URL as an InputStream

visitingURL

protected void visitingURL(String url)
This method can be invoked to indicate a URL was visited fro tracking

Parameters

url String
the url

wasURLVisited

public boolean wasURLVisited(String url)
Returns true if the URL was visited, requires trackVisitedURLs to be true

Parameters

url String
the url

Returns

true if it was visited

isTrackVisitedURLs

public boolean isTrackVisitedURLs()
Allows tracking whether a URL was visited or not

Returns

the trackVisitedURLs

setTrackVisitedURLs

public void setTrackVisitedURLs(boolean trackVisitedURLs)
Allows tracking whether a URL was visited or not

Parameters

trackVisitedURLs boolean
the trackVisitedURLs to set