JavaScript API Reference for Oracle ADF Faces

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adfinternal.view.js.event
Class AdfCalendarEvent

Warning:

• This is an unsupported, internal implementation class.
• Use an API class that might provide equivalent functionality instead.
• This class will change without notice.
• It is not recommended that you use anything in this class.

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

Calendar Event class

Field Summary

private Object	_button
private Object	_clickCount
public static Object	EVENT_TYPE
private Object	_keyStroke
public Object	setRoot
private Object	_triggerDate
private Object	_triggerHour
private Object	_triggerMin
private Object	_triggerType

Fields inherited from oracle.adf.view.js.event.AdfComponentEvent

BLUR_EVENT_TYPE, FOCUS_EVENT_TYPE

Fields inherited from oracle.adf.view.js.event.AdfBaseEvent

AT_TARGET_PHASE, BUBBLING_PHASE, CAPTURING_PHASE

Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfCalendarEvent(Object source, String triggerDate, Number triggerHour, Number triggerMin, Object keyStroke, Object clickCount, Object button, Object triggerType) Calendar Event class

Method Summary

protected Object	AddMarshalledProperties(Object properties) Override of AddMarshalledProperties to add clientId property.
protected Object	Init(Object source, String triggerDate, Number triggerHour, Number triggerMin, Object keyStroke, Object clickCount, Object button, Object triggerType) Initializes the instance.
public Boolean	propagatesToServer() Override to cause the event to propagate to the server.
public static Object	queue(Object component, Object triggerDate, Object triggerHour, Object triggerMin, Object keyStroke, Object clickCount, Object button, Object triggerType) Convenience function for queueing a Calendar event from a component.

Methods inherited from oracle.adf.view.js.event.AdfPhasedEvent

getCurrentTarget, getDoesBubbles, getEventPhase, isCancelable, nextEventPhase, setCurrentTarget, toDebugString

Methods inherited from oracle.adf.view.js.event.AdfBaseEvent

cancel, forceFullSubmit, getClearMessages, getProperties, getRoot, getShowMessages, getSource, getType, isBubblingStopped, isCanceled, IsDeleveryDiscrete, isFullSubmitForced, isImmediate, isPartial, isResponseAnnounced, isResponseExpected, IsUserInputPrevented, isValidationNeeded, noResponseExpected, preventUserInput, setPartial, setRoot, stopBubbling

Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toString

Field Detail

_button

private Object _button

_clickCount

private Object _clickCount

EVENT_TYPE

public static Object EVENT_TYPE

_keyStroke

private Object _keyStroke

setRoot

public Object setRoot

_triggerDate

private Object _triggerDate

_triggerHour

private Object _triggerHour

_triggerMin

private Object _triggerMin

_triggerType

private Object _triggerType

Constructor Detail

AdfCalendarEvent

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

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" TODO Do I need an enum for the client api as well? AdfCalendarEventType and AdfCalendarEventButton

Method Detail

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)

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

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)

Convenience function for queueing a Calendar event from a component.

Parameters:

component
triggerDate
triggerHour
triggerMin
keyStroke
clickCount
button
triggerType

Return:

Object

Overrides:

AdfComponentEvent.queue(Boolean)

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD