org.zkoss.zk.ui.event
Class URIEvent

java.lang.Object
  extended by org.zkoss.zk.ui.event.Event
      extended by org.zkoss.zk.ui.event.URIEvent
All Implemented Interfaces:
java.io.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
URIEvent(java.lang.String name, Component target, java.lang.String uri)
          Constructs an URI update event.
 
Method Summary
 java.lang.String getURI()
          Returns the URI (never null).
static 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 Detail

URIEvent

public URIEvent(java.lang.String name,
                Component target,
                java.lang.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 Detail

getURIEvent

public static final URIEvent getURIEvent(AuRequest request)
Converts an AU request to an URI event.

Since:
5.0.0

getURI

public java.lang.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://).



Copyright © 2005-2011 Potix Corporation. All Rights Reserved. SourceForge.net Logo