|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.zkoss.zk.ui.event.Event
public class Event
An event sent to the event handler of a component.
Component
,
Serialized FormConstructor Summary | |
---|---|
Event(java.lang.String name)
Constructs a simple event without target. |
|
Event(java.lang.String name,
Component target)
Constructs a simple event. |
|
Event(java.lang.String name,
Component target,
java.lang.Object data)
Constructs a simple event. |
Method Summary | |
---|---|
java.lang.Object |
getData()
Returns the data accompanies with this event, or null if not available. |
static Event |
getEvent(AuRequest request)
Creates an instance of Event based on the specified request. |
java.lang.String |
getName()
Returns the event name. |
Page |
getPage()
Returns the page owning this event, or null if broadcast. |
Component |
getTarget()
Returns the target component that receives this event, or null if broadcast. |
boolean |
isPropagatable()
Returns whether this event is propagatable. |
void |
stopPropagation()
Stops the propagation for this event. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Event(java.lang.String name)
public Event(java.lang.String name, Component target)
target
- the component to receive this event,
or null to indicate broadcasting the event to all root components.public Event(java.lang.String name, Component target, java.lang.Object data)
target
- the component to receive this event,
or null to indicate broadcasting the event to all root components.data
- an arbitrary dataMethod Detail |
---|
public static Event getEvent(AuRequest request)
Event
based on the specified request.
public final java.lang.String getName()
public final Component getTarget()
public final Page getPage()
public java.lang.Object getData()
public boolean isPropagatable()
Default: true.
It becomes false if stopPropagation()
is called.
If true, the event will be sent to the following event listener
(EventListener
) being registered by Component.addEventListener(int, java.lang.String, org.zkoss.zk.ui.event.EventListener extends org.zkoss.zk.ui.event.Event>)
and Page.addEventListener(java.lang.String, org.zkoss.zk.ui.event.EventListener extends org.zkoss.zk.ui.event.Event>)
.
public void stopPropagation()
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |