Event (BlackBerry JDE 6.0.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.rim.device.api.browser.field
Class Event

java.lang.Object
  net.rim.device.api.browser.field.Event

Direct Known Subclasses:: BrowserContentChangedEvent, CloseEvent, ContentReadEvent, ErrorEvent, ExecutingScriptEvent, FullWindowEvent, HistoryEvent, RedirectEvent, SetHeaderEvent, SetHttpCookieEvent, StopEvent, UrlRequestedEvent

public abstract class Event
extends Object
extends Object

Defines general functionality for all browser events.

The various events supported by the browser are all subclasses of this event.

Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

Field Summary
	`static int`	`EVENT_BROWSER_CONTENT_CHANGED` Field values changed due to refresh.
	`static int`	`EVENT_CANCEL_REQUEST_RESOURCE` Notifies rendering application that a previous call for a requested resource has been canceled.
	`static int`	`EVENT_CLOSE` Close browser tab event.
	`static int`	`EVENT_ERROR_DISPLAY` Notifies rendering application that an error message should be displayed to the user.
	`static int`	`EVENT_EXECUTING_SCRIPT` Notifies rendering application that script is being executed.
	`static int`	`EVENT_FULL_WINDOW` Show in full window.
	`static int`	`EVENT_HISTORY` Navigation back in history is requested.
	`static int`	`EVENT_LONG_RUNNING_SCRIPT` Notifies rendering application that a script has been running continuously for too long.
	`static int`	`EVENT_REDIRECT` Redirect event.
	`static int`	`EVENT_SET_HEADER` Set header event.
	`static int`	`EVENT_SET_HTTP_COOKIE` Set HTTP cookie event.
	`static int`	`EVENT_STOP` Stop event.
	`static int`	`EVENT_TICK_CONTENT_READ` Progress changed.
	`static int`	`EVENT_UI_DIRECTION_REQUEST` Notifies rendering application that the UI direction has been set; and to change the position of scrollbars if any.
	`static int`	`EVENT_URL_REQUESTED` URL requested.
	`static int`	`PUBLIC_EVENT_THRESHOLD`

Constructor Summary
	`Event(int uid, Object src)` Creates a new Event instance.

Method Summary
	`Object`	`getSource()` Retrieves the object that triggered this event.
	`String`	`getSourceURL()` Extracts URL from the source object.
	`int`	`getUID()` Retrieves the UID for this event.
	`protected String`	`resolveUrl(String url)` Resolves provided URL.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

PUBLIC_EVENT_THRESHOLD

public static final int PUBLIC_EVENT_THRESHOLD

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_BROWSER_CONTENT_CHANGED

public static final int EVENT_BROWSER_CONTENT_CHANGED

Field values changed due to refresh.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_CLOSE

public static final int EVENT_CLOSE

Close browser tab event.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_EXECUTING_SCRIPT

public static final int EVENT_EXECUTING_SCRIPT

Notifies rendering application that script is being executed.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_FULL_WINDOW

public static final int EVENT_FULL_WINDOW

Show in full window.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_HISTORY

public static final int EVENT_HISTORY

Navigation back in history is requested.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_REDIRECT

public static final int EVENT_REDIRECT

Redirect event.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_SET_HEADER

public static final int EVENT_SET_HEADER

Set header event.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_SET_HTTP_COOKIE

public static final int EVENT_SET_HTTP_COOKIE

Set HTTP cookie event. This event is only triggered when JavaScript on a page sets a cookie, not when a cookie is set by a web server.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_STOP

public static final int EVENT_STOP

Stop event.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_URL_REQUESTED

public static final int EVENT_URL_REQUESTED

URL requested.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_TICK_CONTENT_READ

public static final int EVENT_TICK_CONTENT_READ

Progress changed.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.2

EVENT_UI_DIRECTION_REQUEST

public static final int EVENT_UI_DIRECTION_REQUEST

Notifies rendering application that the UI direction has been set; and to change the position of scrollbars if any.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.1.0

EVENT_ERROR_DISPLAY

public static final int EVENT_ERROR_DISPLAY

Notifies rendering application that an error message should be displayed to the user.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.1.0

EVENT_CANCEL_REQUEST_RESOURCE

public static final int EVENT_CANCEL_REQUEST_RESOURCE

Notifies rendering application that a previous call for a requested resource has been canceled.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.2.0

EVENT_LONG_RUNNING_SCRIPT

public static final int EVENT_LONG_RUNNING_SCRIPT

Notifies rendering application that a script has been running continuously for too long. Unless the event is handled and Boolean.TRUE is returned, the script will be killed.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 6.0.0

Constructor Detail

Event

public Event(int uid,
             Object src)

Creates a new Event instance.

Parameters:: uid - ID for this event (one of this class's EVENT_* data members).; src - Object that triggered this event (typically a BrowserContent object or an HttpConnection).
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

Method Detail

getSource

public final Object getSource()

Retrieves the object that triggered this event.

Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

getSourceURL

public final String getSourceURL()

Extracts URL from the source object.

Returns:: URL associated with event source, if available.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

getUID

public final int getUID()

Retrieves the UID for this event.

Returns:: This event's UID.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

resolveUrl

protected String resolveUrl(String url)

Resolves provided URL. Provided a relative URL, this method returns a canonical (absolute) URL, using the the base provided by this event's source object.

Parameters:: url - URL to be resolved.
Returns:: Absolute URL.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0