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

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

public class RedirectEvent
extends Event

Event to redirect.

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	TYPE_300_REDIRECT Redirection because of 3xx response.
	static int	TYPE_JAVASCRIPT Javascript redirection using location.
	static int	TYPE_META Meta-refresh redirection.
	static int	TYPE_SINGLE_FRAME_REDIRECT Redirection because the original page contained a single frame.

Fields inherited from class net.rim.device.api.browser.field.Event

EVENT_BROWSER_CONTENT_CHANGED, EVENT_CANCEL_REQUEST_RESOURCE, EVENT_CLOSE, EVENT_ERROR_DISPLAY, EVENT_EXECUTING_SCRIPT, EVENT_FULL_WINDOW, EVENT_HISTORY, EVENT_LONG_RUNNING_SCRIPT, EVENT_REDIRECT, EVENT_SET_HEADER, EVENT_SET_HTTP_COOKIE, EVENT_STOP, EVENT_TICK_CONTENT_READ, EVENT_UI_DIRECTION_REQUEST, EVENT_URL_REQUESTED, PUBLIC_EVENT_THRESHOLD

Constructor Summary
	RedirectEvent(Object src, String location, Event originalEvent, int type) Creates a new RedirectEvent instance.
	RedirectEvent(Object src, String location, Event originalEvent, int type, int timerValue) Creates a new RedirectEvent instance.

Method Summary
	String	getLocation() Retrieves location for redirection.
	Event	getOriginalEvent() Originally generated event.
	int	getTimerValue() Timer value when this event was started.
	int	getType() Retrieves redirection type.

Methods inherited from class net.rim.device.api.browser.field.Event

getSource, getSourceURL, getUID, resolveUrl

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_300_REDIRECT

public static final int TYPE_300_REDIRECT

Redirection because of 3xx response.

The source for this type of event should be an HttpConnection.

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

TYPE_SINGLE_FRAME_REDIRECT

public static final int TYPE_SINGLE_FRAME_REDIRECT

Redirection because the original page contained a single frame.

The source for this type of event should be an HttpConnection.

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

TYPE_JAVASCRIPT

public static final int TYPE_JAVASCRIPT

Javascript redirection using location.

The source for this type of event should be a BrowserContent object.

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

TYPE_META

public static final int TYPE_META

Meta-refresh redirection.

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

Constructor Detail

RedirectEvent

public RedirectEvent(Object src,
                     String location,
                     Event originalEvent,
                     int type)

Creates a new RedirectEvent instance.

Parameters:

src - Source of event.

location - Location for redirection.

originalEvent - Originally generated event.

type - Redirection event type.

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

RedirectEvent

public RedirectEvent(Object src,
                     String location,
                     Event originalEvent,
                     int type,
                     int timerValue)

Creates a new RedirectEvent instance.

Parameters:

src - Source of event.

location - Location for redirection.

originalEvent - Originally generated event.

type - Redirection event type.

timerValue - If a timer was used in this event then the initial timer value in milliseconds.

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

Method Detail

getLocation

public String getLocation()

Retrieves location for redirection.

Returns:

Redirection location.

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

getType

public int getType()

Retrieves redirection type.

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

getOriginalEvent

public Event getOriginalEvent()

Originally generated event.

Returns:

an event generated that may have caused 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

getTimerValue

public int getTimerValue()

Timer value when this event was started.

Returns:

expiry time associated with this event when it was invoked.

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