JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.event
Class AdfCalendarEvent

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.event.AdfBaseEvent
               |
               +--oracle.adf.view.js.event.AdfPhasedEvent
                     |
                     +--oracle.adf.view.js.event.AdfComponentEvent
                           |
                           +--oracle.adfinternal.view.js.event.AdfCalendarEvent

public class AdfCalendarEvent
extends AdfComponentEvent

_button

private Object _button

_clickCount

private Object _clickCount

EVENT_TYPE

public static Object EVENT_TYPE

_keyStroke

private Object _keyStroke

_providerId

private Object _providerId

setRoot

public Object setRoot

_triggerDate

private Object _triggerDate

_triggerHour

private Object _triggerHour

_triggerMin

private Object _triggerMin

_triggerType

private Object _triggerType

AdfCalendarEvent

public AdfCalendarEvent(Object source,
                        String triggerDate,
                        Number triggerHour,
                        Number triggerMin,
                        Object keyStroke,
                        Object clickCount,
                        Object button,
                        Object triggerType,
                        String providerId)

Calendar Event class

Parameters:

source	-	Source of the CalendarActivity event
triggerDate	-	The date string (e.g., 07/31/2008) of the calendar's day area where the user clicked.
triggerHour	-	The hour of the calendar's free space area where the user clicked. This will be null if the user clicked in the all-day free space area.
triggerMin	-	The minute of the calendar's free space area where the user clicked. This will be null if the user clicked in the all-day free space area.
keyStroke	-	AdfKeyStroke object with the keystroke information that triggered the event.
clickCount	-	number of button clicks: 0, 1, 2
button	-	"NONE", "LEFT", or "RIGHT"
triggerType	-	"MOUSE", "FOCUS", "KEY", "HOVER", "CONTEXT_MENU"
providerId	-	An optional provider identifier for the event TODO Do I need an enum for the client api as well? AdfCalendarEventType and AdfCalendarEventButton

AddMarshalledProperties

protected Object AddMarshalledProperties(Object properties)

Override of AddMarshalledProperties to add clientId property.

Parameters:

properties

Return:

Object

Overrides:

AdfBaseEvent.AddMarshalledProperties(Object)

Init

protected Object Init(Object source,
                      String triggerDate,
                      Number triggerHour,
                      Number triggerMin,
                      Object keyStroke,
                      Object clickCount,
                      Object button,
                      Object triggerType,
                      Object providerId)

Initializes the instance. Subclasses of AdfObject must call their superclass' Init

Parameters:

source
triggerDate	-	The date string (e.g., 07/31/2008) of the calendar's day area where the user clicked.
triggerHour	-	The hour of the calendar's free space area where the user clicked. This will be null if the user clicked in the all-day free space area.
triggerMin	-	The minute of the calendar's free space area where the user clicked. This will be null if the user clicked in the all-day free space area.
keyStroke
clickCount
button
triggerType
providerId

Return:

Object

Overrides:

AdfObject.Init()

propagatesToServer

public Boolean propagatesToServer()

Override to cause the event to propagate to the server.

Return:

Boolean - null true if the event should propagate to the server if not canceled

See also:

AdfBaseEvent.cancel()

AdfBaseEvent.isCancelable()

AdfBaseEvent.isCanceled()

Overrides:

AdfBaseEvent.propagatesToServer()

queue

public static Object queue(Object component,
                           Object triggerDate,
                           Object triggerHour,
                           Object triggerMin,
                           Object keyStroke,
                           Object clickCount,
                           Object button,
                           Object triggerType,
                           Object providerId)

Convenience function for queueing a Calendar event from a component.

Parameters:

component
triggerDate
triggerHour
triggerMin
keyStroke
clickCount
button
triggerType
providerId

Return:

Object

Overrides:

AdfComponentEvent.queue(Boolean)