Skip navigation links

oracle.adf.view.rich.event
Class CalendarEvent

java.lang.Object
java.util.EventObject
javax.faces.event.FacesEvent
oracle.adf.view.rich.event.CalendarEvent

All Implemented Interfaces:

java.io.Serializable

public class CalendarEvent

extends javax.faces.event.FacesEvent

/** CalendarEvent class for when a user clicks on empty space -- that is, space that isn't an activity.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

CalendarEvent(javax.faces.component.UIComponent source, java.util.Date triggerDate, CalendarActivity.TimeType timeType, java.awt.AWTKeyStroke keyStroke, int clickCount, MouseButton button, TriggerType triggerType)
Default constructor

Method Summary

MouseButton	getButton() Return the button that triggered the event.
int	getClickCount() Return the number of clicks of the mouse that triggered the event.
java.awt.AWTKeyStroke	getKeyStroke() This returns the keyStroke that triggered the event.
CalendarActivity.TimeType	getTimeType() This returns TimeType in which the user clicked - the all day area or the timed area.
java.util.Date	getTriggerDate() This returns the Date information of the time-slot the user clicked on to trigger the event.
TriggerType	getTriggerType() The triggerType of event.
boolean	isAppropriateListener(javax.faces.event.FacesListener listener)
void	processListener(javax.faces.event.FacesListener listener)
java.lang.String	toString()

Methods inherited from class javax.faces.event.FacesEvent

getComponent, getPhaseId, queue, setPhaseId

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarEvent

public CalendarEvent(javax.faces.component.UIComponent source,
                     java.util.Date triggerDate,
                     CalendarActivity.TimeType timeType,
                     java.awt.AWTKeyStroke keyStroke,
                     int clickCount,
                     MouseButton button,
                     TriggerType triggerType)

Default constructor

Parameters:

source -

triggerDate - The Date object that contains the date information including time about where the user clicked in the calendar.

timeType - An all day activity TimeType.ALLDAY or a timed activity TimeType.TIME. If the user clicked in the all day area then this is TimeType.ALLDAY.

keyStroke - AWTKeyStroke contains the information of what key was pressed that triggered this event, null if none.

clickCount - 0,1, or 2 - the number of clicks of the mouse that triggered this event, if any.

button - the button that was pressed that triggered this event, if any.

triggerType - the information about what triggered this event.

Method Detail

isAppropriateListener

public boolean isAppropriateListener(javax.faces.event.FacesListener listener)

Specified by:

isAppropriateListener in class javax.faces.event.FacesEvent

processListener

public void processListener(javax.faces.event.FacesListener listener)

Specified by:

processListener in class javax.faces.event.FacesEvent

getTriggerDate

public java.util.Date getTriggerDate()

This returns the Date information of the time-slot the user clicked on to trigger the event.

getTimeType

public CalendarActivity.TimeType getTimeType()

This returns TimeType in which the user clicked - the all day area or the timed area.

getKeyStroke

public java.awt.AWTKeyStroke getKeyStroke()

This returns the keyStroke that triggered the event. The mouse down information is in the AWTKeyStroke modifiers. e.g., java.awt.event.InputEvent.BUTTON1_DOWN_MASK

Returns:

the keyStroke object

getClickCount

public int getClickCount()

Return the number of clicks of the mouse that triggered the event. 0 if the mouse didn't trigger the event.

getButton

public MouseButton getButton()

Return the button that triggered the event.

getTriggerType

public TriggerType getTriggerType()

The triggerType of event. If this event was sent because the user hovered over an activity, then the Type would be HOVER. If it is sent because of a key press, then Type would be KEY, etc

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject

Skip navigation links