org.zkoss.calendar.event

Class CalendarsEvent

java.lang.Object

org.zkoss.zk.ui.event.Event

org.zkoss.calendar.event.CalendarsEvent

All Implemented Interfaces:

java.io.Serializable

public class CalendarsEvent
extends org.zkoss.zk.ui.event.Event

The event is used for Calendars when user create/update/edit the calendar item.

The event is able to stop or clear the dragging ghost from server to client, that is, when application developer doesn't invoke the stopClearGhost(), the dragging ghost will be cleared by default. Otherwise, application developer has to responsibly invoke the clearGhost().

Author:

jumperchen,jimmy

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ON_DAY_CLICK
static java.lang.String	ON_ITEM_CREATE
static java.lang.String	ON_ITEM_EDIT
static java.lang.String	ON_ITEM_TOOLTIP
static java.lang.String	ON_ITEM_UPDATE
static java.lang.String	ON_WEEK_CLICK

Constructor Summary

Constructors

Constructor and Description
CalendarsEvent(java.lang.String name, org.zkoss.zk.ui.Component target, CalendarItem ce, java.util.Date beginDate, java.util.Date endDate, int x, int y, int dtwd, int dthgh)

Method Summary

Modifier and Type	Method and Description
void	clearGhost() Clears the dragging ghost from server to client.
java.util.Date	getBeginDate() Returns the update beginning date.
CalendarItem	getCalendarItem() Returns the calendar item.
static org.zkoss.zk.ui.event.Event	getClickEvent(org.zkoss.zk.au.AuRequest request, java.lang.String cmd)
static CalendarsEvent	getCreateEvent(org.zkoss.zk.au.AuRequest request) Creates an instance of Event based on the specified request.
int	getDesktopHeight() Returns the pixel height of the client's desktop.
int	getDesktopWidth() Returns the pixel width of the client's desktop.
static CalendarsEvent	getEditEvent(org.zkoss.zk.au.AuRequest request)
java.util.Date	getEndDate() Returns the update end date.
static org.zkoss.zk.ui.event.Event	getTooltipEvent(org.zkoss.zk.au.AuRequest request)
static CalendarsEvent	getUpdateEvent(org.zkoss.zk.au.AuRequest request)
int	getX() Returns the x coordination of the mouse pointer relevant to the component.
int	getY() Returns the y coordination of the mouse pointer relevant to the component.
void	stopClearGhost() Stops to clear the dragging ghost command from server to client.

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

Field Detail

ON_ITEM_CREATE

public static final java.lang.String ON_ITEM_CREATE

See Also:

Constant Field Values

ON_ITEM_EDIT

public static final java.lang.String ON_ITEM_EDIT

See Also:

Constant Field Values

ON_ITEM_UPDATE

public static final java.lang.String ON_ITEM_UPDATE

See Also:

Constant Field Values

ON_DAY_CLICK

public static final java.lang.String ON_DAY_CLICK

See Also:

Constant Field Values

ON_WEEK_CLICK

public static final java.lang.String ON_WEEK_CLICK

See Also:

Constant Field Values

ON_ITEM_TOOLTIP

public static final java.lang.String ON_ITEM_TOOLTIP

See Also:

Constant Field Values

Constructor Detail

CalendarsEvent

public CalendarsEvent(java.lang.String name,
                      org.zkoss.zk.ui.Component target,
                      CalendarItem ce,
                      java.util.Date beginDate,
                      java.util.Date endDate,
                      int x,
                      int y,
                      int dtwd,
                      int dthgh)

Method Detail

getCreateEvent

public static CalendarsEvent getCreateEvent(org.zkoss.zk.au.AuRequest request)

Creates an instance of Event based on the specified request.

getEditEvent

public static CalendarsEvent getEditEvent(org.zkoss.zk.au.AuRequest request)

getUpdateEvent

public static CalendarsEvent getUpdateEvent(org.zkoss.zk.au.AuRequest request)

getClickEvent

public static org.zkoss.zk.ui.event.Event getClickEvent(org.zkoss.zk.au.AuRequest request,
                                                        java.lang.String cmd)

getTooltipEvent

public static org.zkoss.zk.ui.event.Event getTooltipEvent(org.zkoss.zk.au.AuRequest request)

stopClearGhost

public void stopClearGhost()

Stops to clear the dragging ghost command from server to client.

Note: If the method is invoked, application developer has to invoke clearGhost() to clear the dragging ghost.

clearGhost

public void clearGhost()

Clears the dragging ghost from server to client.

The CalendarsEvent will clear the ghost by default, except invoking stopClearGhost().

getBeginDate

public java.util.Date getBeginDate()

Returns the update beginning date. If the event name is onItemEdit, null is assumed.

getEndDate

public java.util.Date getEndDate()

Returns the update end date. If the event name is onItemEdit, null is assumed.

getCalendarItem

public CalendarItem getCalendarItem()

Returns the calendar item. If the event name is onItemCreate, null is assumed.

getX

public final int getX()

Returns the x coordination of the mouse pointer relevant to the component.

getY

public final int getY()

Returns the y coordination of the mouse pointer relevant to the component.

getDesktopWidth

public int getDesktopWidth()

Returns the pixel width of the client's desktop.

getDesktopHeight

public int getDesktopHeight()

Returns the pixel height of the client's desktop.