org.zkoss.zk.ui.event
Class Events

java.lang.Object
  org.zkoss.zk.ui.event.Events

public class Events
extends java.lang.Object

Utilities to handle events.

Author:

tomyeh

Field Summary

static java.lang.String	ON_BLUR The onBlur event (used with Event).
static java.lang.String	ON_BOOKMARK_CHANGED The onBookmarkChanged event (used with BookmarkEvent) to notify that user pressed BACK, FORWARD or specified URL directly that causes the bookmark is changed (but still in the same desktop).
static java.lang.String	ON_CANCEL The onCancel event (used with KeyEvent).
static java.lang.String	ON_CHANGE The onChange event (used with InputEvent).
static java.lang.String	ON_CHANGING The onChanging event (used with InputEvent).
static java.lang.String	ON_CHECK The onCheck event (used with CheckEvent).
static java.lang.String	ON_CLICK The onClick event (used with MouseEvent).
static java.lang.String	ON_CLIENT_INFO The onClientInfo event (used with ClientInfoEvent).
static java.lang.String	ON_CLOSE The onClose event (used with Event) used to denote the close button is pressed.
static java.lang.String	ON_CREATE The onCreate event (used with CreateEvent) to notify a compoent that it (and its children) has been created by ZK's evaluating a ZUML page.
static java.lang.String	ON_CTRL_KEY The onCtrlKey event (used with KeyEvent).
static java.lang.String	ON_DOUBLE_CLICK The onDoubleClick event (used with MouseEvent).
static java.lang.String	ON_DROP The onDrop event (used with DropEvent).
static java.lang.String	ON_ERROR The onError event (used with ErrorEvent).
static java.lang.String	ON_FOCUS The onFocus event (used with Event).
static java.lang.String	ON_MODAL The onModal event (used with Event) to notify a component shall become modal.
static java.lang.String	ON_MOVE The onMove event (used with MoveEvent).
static java.lang.String	ON_NOTIFY The onNotify event (used with Event).
static java.lang.String	ON_OK The onOK event (used with KeyEvent).
static java.lang.String	ON_OPEN The onOpen event (used with OpenEvent).
static java.lang.String	ON_PIGGYBACK The onPiggyback event (used with Event) used to notify a root component that the client has sent a request to the server.
static java.lang.String	ON_RENDER The onRender event (used with RenderOnDemand).
static java.lang.String	ON_RIGHT_CLICK The onRightClick event (used with MouseEvent).
static java.lang.String	ON_SCROLL The onScroll event (used with ScrollEvent).
static java.lang.String	ON_SCROLLING The onScrolling event (used with ScrollEvent).
static java.lang.String	ON_SELECT The onSelect event (used with SelectEvent).
static java.lang.String	ON_SELECTION The onSelection event (used with SelectionEvent).
static java.lang.String	ON_SIZE The onSize event (used with SizeEvent).
static java.lang.String	ON_SORT The onSort event (used with Event) to notify a request for sorting.
static java.lang.String	ON_TIMER The onTimer event (used with Event).
static java.lang.String	ON_UPLOAD The onUpload event (used with UploadEvent.
static java.lang.String	ON_USER The onUser event.
static java.lang.String	ON_Z_INDEX The onZIndex event (used with ZIndexEvent).

Method Summary

static boolean	inEventListener() Returns whether the current thread is an event listener.
static boolean	isListened(Component comp, java.lang.String evtnm, boolean asap) Returns whether an event handler or listener is available for the specified component and event.
static boolean	isListenerAvailable(Component comp, java.lang.String evtnm, boolean asap) Deprecated. As of release 2.4.0, replaced by isListened(org.zkoss.zk.ui.Component, java.lang.String, boolean)
static boolean	isValid(java.lang.String name) Returns whether an event name is valid.
static void	postEvent(Event event) Posts an event.
static void	postEvent(java.lang.String name, Component target, java.lang.Object data) Posts a generic event (aka, an instance of Event).
static void	sendEvent(Component comp, Event event) Sends the event to the specified component and process it immediately.
static void	sendEvent(Event event) Sends the event the target specified in the event.

Methods inherited from class java.lang.Object

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

Field Detail

ON_CLICK

public static final java.lang.String ON_CLICK

The onClick event (used with MouseEvent).

See Also:

Constant Field Values

ON_RIGHT_CLICK

public static final java.lang.String ON_RIGHT_CLICK

The onRightClick event (used with MouseEvent).

See Also:

Constant Field Values

ON_DOUBLE_CLICK

public static final java.lang.String ON_DOUBLE_CLICK

The onDoubleClick event (used with MouseEvent).

See Also:

Constant Field Values

ON_OK

public static final java.lang.String ON_OK

The onOK event (used with KeyEvent).

See Also:

Constant Field Values

ON_CANCEL

public static final java.lang.String ON_CANCEL

The onCancel event (used with KeyEvent).

See Also:

Constant Field Values

ON_CTRL_KEY

public static final java.lang.String ON_CTRL_KEY

The onCtrlKey event (used with KeyEvent).

See Also:

Constant Field Values

ON_CHANGE

public static final java.lang.String ON_CHANGE

The onChange event (used with InputEvent).

See Also:

Constant Field Values

ON_CHANGING

public static final java.lang.String ON_CHANGING

The onChanging event (used with InputEvent).

See Also:

Constant Field Values

ON_ERROR

public static final java.lang.String ON_ERROR

The onError event (used with ErrorEvent).

See Also:

Constant Field Values

ON_SCROLL

public static final java.lang.String ON_SCROLL

The onScroll event (used with ScrollEvent).

See Also:

Constant Field Values

ON_SCROLLING

public static final java.lang.String ON_SCROLLING

The onScrolling event (used with ScrollEvent).

See Also:

Constant Field Values

ON_SELECT

public static final java.lang.String ON_SELECT

The onSelect event (used with SelectEvent).

See Also:

Constant Field Values

ON_SELECTION

public static final java.lang.String ON_SELECTION

The onSelection event (used with SelectionEvent).

See Also:

Constant Field Values

ON_CHECK

public static final java.lang.String ON_CHECK

The onCheck event (used with CheckEvent).

See Also:

Constant Field Values

ON_MOVE

public static final java.lang.String ON_MOVE

The onMove event (used with MoveEvent).

See Also:

Constant Field Values

ON_SIZE

public static final java.lang.String ON_SIZE

The onSize event (used with SizeEvent).

See Also:

Constant Field Values

ON_Z_INDEX

public static final java.lang.String ON_Z_INDEX

The onZIndex event (used with ZIndexEvent).

See Also:

Constant Field Values

ON_OPEN

public static final java.lang.String ON_OPEN

The onOpen event (used with OpenEvent).

See Also:

Constant Field Values

ON_CLOSE

public static final java.lang.String ON_CLOSE

The onClose event (used with Event) used to denote the close button is pressed.

See Also:

Constant Field Values

ON_RENDER

public static final java.lang.String ON_RENDER

The onRender event (used with RenderOnDemand).

See Also:

Constant Field Values

ON_TIMER

public static final java.lang.String ON_TIMER

The onTimer event (used with Event). Sent when a timer is up.

See Also:

Constant Field Values

ON_FOCUS

public static final java.lang.String ON_FOCUS

The onFocus event (used with Event). Sent when a component gets a focus.

See Also:

Constant Field Values

ON_BLUR

public static final java.lang.String ON_BLUR

The onBlur event (used with Event). Sent when a component loses a focus.

See Also:

Constant Field Values

ON_DROP

public static final java.lang.String ON_DROP

The onDrop event (used with DropEvent). Sent when a component is dragged and drop to another.

See Also:

Constant Field Values

ON_NOTIFY

public static final java.lang.String ON_NOTIFY

The onNotify event (used with Event). It is not used by any component, but it is, rather, designed to let users add customized events.

See Also:

Constant Field Values

ON_SORT

public static final java.lang.String ON_SORT

The onSort event (used with Event) to notify a request for sorting.

See Also:

Constant Field Values

ON_UPLOAD

public static final java.lang.String ON_UPLOAD

The onUpload event (used with UploadEvent.

See Also:

Constant Field Values

ON_BOOKMARK_CHANGED

public static final java.lang.String ON_BOOKMARK_CHANGED

The onBookmarkChanged event (used with BookmarkEvent) to notify that user pressed BACK, FORWARD or specified URL directly that causes the bookmark is changed (but still in the same desktop).

All root components of all pages of the desktop will recieve this event.

See Also:

Constant Field Values

ON_CLIENT_INFO

public static final java.lang.String ON_CLIENT_INFO

The onClientInfo event (used with ClientInfoEvent).

See Also:

Constant Field Values

ON_CREATE

public static final java.lang.String ON_CREATE

The onCreate event (used with CreateEvent) to notify a compoent that it (and its children) has been created by ZK's evaluating a ZUML page.

See Also:

Constant Field Values

ON_MODAL

public static final java.lang.String ON_MODAL

The onModal event (used with Event) to notify a component shall become modal. Currently, only ZUL's window components support it.

See Also:

Constant Field Values

ON_PIGGYBACK

public static final java.lang.String ON_PIGGYBACK

The onPiggyback event (used with Event) used to notify a root component that the client has sent a request to the server. It is meaningful only if it is registered to the root component. Once registered, it is called each time the client sends a request to the server. The onPiggyback's event listener is processed after all other events are processed.

The onPiggyback event is designed to let developers piggyback the least-emergent UI updates to the client.

Since:

2.4.0

See Also:

Constant Field Values

ON_USER

public static final java.lang.String ON_USER

The onUser event. It is a generic event that an application developer might send from the client. ZK doesn't use this event.

See Also:

Constant Field Values

Method Detail

isValid

public static final boolean isValid(java.lang.String name)

Returns whether an event name is valid.

The event name must start with on and the third character must be upper case.

inEventListener

public static final boolean inEventListener()

Returns whether the current thread is an event listener.

isListened

public static boolean isListened(Component comp,
                                 java.lang.String evtnm,
                                 boolean asap)

Returns whether an event handler or listener is available for the specified component and event.

A event handler is either a public method named onXxx or a ZUL attribute named onXxx, where onXxx is the event name. A event listener is EventListener being added by Component.addEventListener(java.lang.String, org.zkoss.zk.ui.event.EventListener) and Page.addEventListener(java.lang.String, org.zkoss.zk.ui.event.EventListener).

Unlike Component.isListenerAvailable(java.lang.String, boolean), which checks only the event listener, this method check both event handlers and listeners, i.e., the onXxx members defined in ZUML, the onXxx method defined in the implementation class, and the event listener registered.

Parameters:

asap - whether to check only non-deferrable listener, i.e., not implementing Deferrable, or Deferrable.isDeferrable() is false.

See Also:

Deferrable, Component.isListenerAvailable(java.lang.String, boolean)

isListenerAvailable

public static boolean isListenerAvailable(Component comp,
                                          java.lang.String evtnm,
                                          boolean asap)

Deprecated. As of release 2.4.0, replaced by isListened(org.zkoss.zk.ui.Component, java.lang.String, boolean)

Returns whether an event handler or listener is available for the specified component and event.

sendEvent

public static void sendEvent(Component comp,
                             Event event)

Sends the event to the specified component and process it immediately. This method can only be called when processing an event. It is OK to send event to component from another page as long as they are in the same desktop.

sendEvent

public static void sendEvent(Event event)

Sends the event the target specified in the event.

Note: Event.getTarget() cannot be null.

postEvent

public static final void postEvent(Event event)

Posts an event.

Note: if the target of an event is not attached to the page yet, the event is ignored silently.

postEvent

public static final void postEvent(java.lang.String name,
                                   Component target,
                                   java.lang.Object data)

Posts a generic event (aka, an instance of Event).