Package org.zkoss.zk.ui.event

Class URIEvent

java.lang.Object

org.zkoss.zk.ui.event.Event

org.zkoss.zk.ui.event.URIEvent

All Implemented Interfaces:

Serializable

public class URIEvent
extends Event

The URI update event used with onURIChange to notify that the associated URI is changed by the user. Currently it is supported only by ZUL's iframe component (and only if iframe contains a ZK page).

A typical use of this event is to support a better bookmarking for a page containing iframe.

Unlike BookmarkEvent, this event is sent to the component (iframe) directly.

Since:

3.5.0

Author:

tomyeh

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
URIEvent(String name, Component target, String uri)	Constructs an URI update event.

Method Summary

Modifier and Type	Method	Description
String	getURI()	Returns the URI (never null).
static final URIEvent	getURIEvent(AuRequest request)	Converts an AU request to an URI event.

Methods inherited from class org.zkoss.zk.ui.event.Event

getData, getEvent, getName, getPage, getTarget, isPropagatable, stopPropagation, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

URIEvent

public URIEvent(String name,
 Component target,
 String uri)

Constructs an URI update event.

Parameters:

target - the component to receive the event.

uri - the URI. Note: it doesn't include the context path unless it starts with a protocol (such as http://).

Method Details

getURIEvent

public static final URIEvent getURIEvent(AuRequest request)

Converts an AU request to an URI event.

Since:

5.0.0

getURI

public String getURI()

Returns the URI (never null). Notice that it does not include the context path, unless it starts with a protocol (such as http://).