JavaScript API Reference for Oracle ADF Faces

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

oracle.adfinternal.view.js.event
Class AdfCalendarActivityEvent

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.AdfCalendarActivityEvent

public class AdfCalendarActivityEvent
extends AdfComponentEvent

AdfCalendarActivityEvent class

Field Summary

private Object	_activityId
private Object	_button
private Object	_clickCount
public static Object	EVENT_TYPE
private Object	_keyStroke
private Object	_providerId
public Object	setRoot
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

AdfCalendarActivityEvent(Object source, Object providerId, Object activityId, Object keyStroke, Object clickCount, Object button, Object triggerType) AdfCalendarActivityEvent class

Method Summary

protected Object	AddMarshalledProperties(Object properties) Override of AddMarshalledProperties to add properties we want sent to the server
protected Object	Init(Object source, Object providerId, Object activityId, 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 providerId, Object activityId, Object keyStroke, Object clickCount, Object button, Object triggerType) Convenience function for queueing a CalendarActivity 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

_activityId

private Object _activityId

_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

_triggerType

private Object _triggerType

Constructor Detail

AdfCalendarActivityEvent

public AdfCalendarActivityEvent(Object source,
Object providerId,
Object activityId,
Object keyStroke,
Object clickCount,
Object button,
Object triggerType)

AdfCalendarActivityEvent class

Parameters:

source	-	Source of the CalendarActivity event
providerId	-	ProviderId of the CalendarActivity event
activityId	-	ActivityId of the CalendarActivity event
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 properties we want sent to the server

Parameters:

properties

Return:

Object

Overrides:

AdfBaseEvent.AddMarshalledProperties(Object)

Init

protected Object Init(Object source,
Object providerId,
Object activityId,
Object keyStroke,
Object clickCount,
Object button,
Object triggerType)

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

Parameters:

source	-	Source of the CalendarActivity event
providerId
activityId	-	ActivityId of the CalendarActivity event
keyStroke	-	AdfKeyStroke object with the keystroke information that triggered
clickCount	-	number of button clicks: 0, 1, 2
button	-	"NONE", "LEFT", or "RIGHT"
triggerType	-	yes, "MOUSE", "FOCUS", "KEY", "HOVER", "CONTEXT_MENU"

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 providerId,
Object activityId,
Object keyStroke,
Object clickCount,
Object button,
Object triggerType)

Convenience function for queueing a CalendarActivity event from a component.

Parameters:

component
providerId
activityId
keyStroke
clickCount
button
triggerType

Return:

Object

Overrides:

AdfComponentEvent.queue(Boolean)

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