Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


oracle.adf.view.rich.event
Class CalendarActivityEvent

java.lang.Object
  extended by java.util.EventObject
      extended by javax.faces.event.FacesEvent
          extended by oracle.adf.view.rich.event.CalendarActivityEvent

All Implemented Interfaces:
java.io.Serializable

public class CalendarActivityEvent
extends javax.faces.event.FacesEvent

An activity event is fired when the user clicks on an activity.

See Also:
Serialized Form

Field Summary

 

Fields inherited from class java.util.EventObject
source

 

Constructor Summary
CalendarActivityEvent(javax.faces.component.UIComponent source, CalendarActivity activity, java.awt.AWTKeyStroke keyStroke, int clickCount, MouseButton button, TriggerType triggerType)
          Default constructor

 

Method Summary
 MouseButton getButton()
          Return the button that triggered the event.
 CalendarActivity getCalendarActivity()
          Returns the calendarActivity for this 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.
 TriggerType getTriggerType()
          The triggerType of event.
 boolean isAppropriateListener(javax.faces.event.FacesListener listener)
           
 void processListener(javax.faces.event.FacesListener listener)
           

 

Methods inherited from class javax.faces.event.FacesEvent
getComponent, getPhaseId, queue, setPhaseId

 

Methods inherited from class java.util.EventObject
getSource, toString

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

CalendarActivityEvent

public CalendarActivityEvent(javax.faces.component.UIComponent source,
                             CalendarActivity activity,
                             java.awt.AWTKeyStroke keyStroke,
                             int clickCount,
                             MouseButton button,
                             TriggerType triggerType)
Default constructor

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

getCalendarActivity

public CalendarActivity getCalendarActivity()
Returns the calendarActivity for this event.

The return value may be null. For example let's say 2 users are looking at the same data. User A deletes activity 1. User B clicks on activity 1, but the activity has been deleted, so CalendarModel.getActivity will return null. The calendarActivityEvent will still be delivered with a null activty such that the end user can be informed that the activity is no longer available.

Returns:
the CalendarActivity source activity. The return value may be null.

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

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.