EventPseudoModel (The Adobe Experience Manager SDK 2020.7.3902.20200716T022312Z-200604)

java.lang.Object
- com.adobe.xfa.Obj
- - com.adobe.xfa.PseudoModel
  - - com.adobe.xfa.EventPseudoModel

All Implemented Interfaces:

Peer
```
public class EventPseudoModel
extends PseudoModel
```
EventPseudoModel describes the state of an event that is being fired. Instances are available to scripts as the $event object.
Users of this class will not typically create instances of this class directly, but will query the AppModel to find the existing instance of the "$event" object.

See Also:

AppModel.lookupPseudoModel(String)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EventPseudoModel.EventInfo
Encapsulates the state of EventPseudoModel.

Nested Classes
Modifier and Type	Class and Description
`static class`	`EventPseudoModel.EventInfo` Encapsulates the state of EventPseudoModel.

Field Summary
- Fields inherited from interface com.adobe.xfa.ut.Peer
  ATTR_CHANGED, CHILD_ADDED, CHILD_REMOVED, DESCENDENT_ADDED, DESCENDENT_ATTR_CHANGED, DESCENDENT_REMOVED, DESCENDENT_VALUE_CHANGED, PARENT_CHANGED, PERMS_LOCK_CLEARED, PERMS_LOCK_SET, PROTO_ATTR_CHANGED, PROTO_CHILD_ADDED, PROTO_CHILD_REMOVED, PROTO_DESCENDENT_ADDED, PROTO_DESCENDENT_ATTR_CHANGED, PROTO_DESCENDENT_REMOVED, PROTO_DESCENDENT_VALUE_CHANGED, PROTO_VALUE_CHANGED, UPDATED, VALUE_CHANGED

Constructor Summary

Constructors
Constructor and Description

EventPseudoModel(AppModel appModel)

Constructors
Constructor and Description
`EventPseudoModel(AppModel appModel)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`cancelAction(String sAction)` Determines whether the specified action has been canceled.
`boolean`	`cancelEvent(String sEvent)` Determines whether the specified event has been canceled.
`void`	`emit()` Fires the event defined by the current event state.
`boolean`	`getCancelAction()` Determines whether the current action event has been canceled.
`String`	`getCanceledAction()` Returns the name of the canceled action.
`String`	`getChange()` Returns the text typed or pasted into the field.
`String`	`getClassAtom()` Returns the atomic name of this element's class.
`String`	`getClassName()` Gets the name of this object's class.
`int`	`getCommitKey()` Returns how a form field was committed.
`EventPseudoModel.EventInfo`	`getEventInfo()` Returns the current event state object.
`String`	`getFullText()` Returns the full (untruncated) value of the field.
`boolean`	`getKeyDown()` Returns whether the arrow key was used to make the selection.
`boolean`	`getModifier()` Returns whether the modifier key is down during the event.
`int`	`getName()` Returns the code that identifies the current event.
`String`	`getNameAsString()` Returns the name of the event as a String.
`String`	`getNewContentType()` Returns the contentType after the field change.
`String`	`getNewText()` Returns the value after the field change.
`String`	`getPrevContentType()` Returns the contentType of prevText.
`String`	`getPrevText()` Returns the value before the field changes.
`boolean`	`getReenter()` Returns whether this event is happening immediately after the user committed this field.
`ScriptTable`	`getScriptTable()`
`int`	`getSelEnd()` Returns the end position of the current text selection during a change event.
`int`	`getSelStart()` Returns the start position of the current text selection during a change event.
`boolean`	`getShift()` Returns whether the shift key is down during the event.
`String`	`getSOAPFaultCode()` Returns the SOAP faultcode returned from executing a Web Service connection.
`String`	`getSOAPFaultString()` Returns the SOAP faultstring returned from executing a Web Service connection.
`Obj`	`getTarget()` Returns the target object that triggered the event.
`boolean`	`isAction(String sOperation)`
`void`	`reset()` Resets the event state to all-empty values.
`void`	`sendMessenge(ExFull error, int eSeverity)` Send message to host so it can be logged
`void`	`setCancelAction(boolean bCancelAction, String sSource)`
`void`	`setChange(String sChange)` Sets the text typed or pasted into the field.
`void`	`setCommitKey(int nCommitKey)` Sets how a form field value was committed.
`void`	`setEventInfo(EventPseudoModel.EventInfo eventInfo)` Sets the event state to the state contained within an EventInfo object.
`void`	`setFullText(String sFullText)` Sets the full (untruncated) value of the field.
`void`	`setKeyDown(boolean bKeyDown)` Sets whether the arrow key was used to make the selection.
`void`	`setModifier(boolean bModifier)` Sets whether the modifier key is down during the event.
`void`	`setName(int eName)` Sets the code that identifies the current event.
`void`	`setName(String sName)` Sets the name of the event using a String.
`void`	`setNewContentType(String sNewContentType)` Sets the contentType after the field change.
`void`	`setNewText(String sNewText)` Sets the value after the field change.
`void`	`setPrevContentType(String sPrevContentType)` Sets the contentType of prevText.
`void`	`setPrevText(String sPrevText)` Sets the value before the field changes.
`void`	`setReenter(boolean bReenter)` Sets whether this event is happening immediately after the user committed this field.
`void`	`setSelEnd(int nSelEnd)` Sets the end position of the current text selection during a change event.
`void`	`setSelStart(int nSelStart)` Sets the start position of the current text selection during a change event.
`void`	`setShift(boolean bShift)` Sets whether the shift key is down during the event.
`void`	`setSOAPFaultCode(String sSOAPFaultCode)` Sets the SOAP faultcode returned from executing a Web Service connection.
`void`	`setSOAPFaultString(String sSOAPFaultString)` Sets the SOAP faultstring returned from executing a Web Service connection.
`void`	`setTarget(Obj target)` Sets the target object that triggered the event.
`boolean`	`validateUsage(int nVersion, int nAvailability, boolean bUpdateVersion)` Validate if the given Version and Availability flags are valid for the current document
`boolean`	`validateUsageFailedIsFatal(int nVersion, int nAvailability)` Determines if disallowing a version should be considered a fatal error.

Methods inherited from class com.adobe.xfa.PseudoModel
getAliasObject, getEventTable

Methods inherited from class com.adobe.xfa.Obj
addPeer, addPeeredNode, clearPeers, deafen, getClassTag, getPeer, getScriptMethodInfo, getScriptProperty, getScriptThis, invokeFunction, isDeaf, isMute, isSameClass, isSameClass, isSameClass, mute, notifyPeers, peerRemoved, removePeer, removePeeredNode, setClass, setClassTag, setScriptProperty, unDeafen, unMute, updateFromPeer

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

- Constructor Detail
  - EventPseudoModel
```
public EventPseudoModel(AppModel appModel)
```
- Method Detail
  - getPrevText
```
public String getPrevText()
```
    Returns the value before the field changes.
    
    Returns:
    
    the value before the field changes.
  - setPrevText
```
public void setPrevText(String sPrevText)
```
    Sets the value before the field changes.
    
    Parameters:
    
    sPrevText - the value before the field changes.
  - getPrevContentType
```
public String getPrevContentType()
```
    Returns the contentType of prevText.
    For example, if prevContentType="text/html", then prevText will contain an XHTML fragment.
    
    Returns:
    
    the contentType of prevText.
  - setPrevContentType
```
public void setPrevContentType(String sPrevContentType)
```
    Sets the contentType of prevText.
    
    Parameters:
    
    sPrevContentType - the contentType of prevText.
  - getChange
```
public String getChange()
```
    Returns the text typed or pasted into the field.
    
    Returns:
    
    the text typed or pasted into the field.
  - setChange
```
public void setChange(String sChange)
```
    Sets the text typed or pasted into the field.
    
    Parameters:
    
    sChange - the text typed or pasted into the field.
  - getNewText
```
public String getNewText()
```
    Returns the value after the field change.
    
    Returns:
    
    the value after the field change.
  - setNewText
```
public void setNewText(String sNewText)
```
    Sets the value after the field change.
    
    Parameters:
    
    sNewText - the value after the field change.
  - getNewContentType
```
public String getNewContentType()
```
    Returns the contentType after the field change.
    
    Returns:
    
    the contentType after the field change.
  - setNewContentType
```
public void setNewContentType(String sNewContentType)
```
    Sets the contentType after the field change.
    
    Parameters:
    
    sNewContentType - the contentType after the field change.
  - getFullText
```
public String getFullText()
```
    Returns the full (untruncated) value of the field.
    If the user pastes into a field, the field may truncate the pasted text. Content type is determined by $event.newContentType.
    
    Returns:
    
    the full (untruncated) value of the field.
  - setFullText
```
public void setFullText(String sFullText)
```
    Sets the full (untruncated) value of the field.
    If the user pastes into a field, the field may truncate the pasted text. Content type is determined by $event.newContentType.
    
    Parameters:
    
    sFullText - the full (untruncated) value of the field.
  - getCommitKey
```
public int getCommitKey()
```
    Returns how a form field was committed.
    
    Returns:
    
    how a form field was committed.
  - setCommitKey
```
public void setCommitKey(int nCommitKey)
```
    Sets how a form field value was committed.
    
    Parameters:
    
    nCommitKey - how a form field was committed.
  - getKeyDown
```
public boolean getKeyDown()
```
    Returns whether the arrow key was used to make the selection.
    Available only for listbox and combobox.
    
    Returns:
    
    true if the arrow key was used to make the selection.
  - setKeyDown
```
public void setKeyDown(boolean bKeyDown)
```
    Sets whether the arrow key was used to make the selection.
    Available only for listbox and combobox.
    
    Parameters:
    
    bKeyDown - true if the arrow key was used to make the selection.
  - getModifier
```
public boolean getModifier()
```
    Returns whether the modifier key is down during the event.
    For the Microsoft Windows platform, the modifier key is CTRL.
    
    Returns:
    
    true if the modifier key is down during the event.
  - setModifier
```
public void setModifier(boolean bModifier)
```
    Sets whether the modifier key is down during the event.
    For the Microsoft Windows platform, the modifier key is CTRL.
    
    Parameters:
    
    bModifier - true if the modifier key is down during the event.
  - getName
```
public int getName()
```
    Returns the code that identifies the current event.
    The code must be one of the ScriptHandler.ACTIVITY_* values.
    
    Returns:
    
    the code that identifies the current event.
    
    See Also:
    
    ScriptHandler
  - setName
```
public void setName(int eName)
```
    Sets the code that identifies the current event.
    The code must be one of the ScriptHandler.ACTIVITY_* values.
    
    Parameters:
    
    eName - a code that defines the current event.
    
    See Also:
    
    ScriptHandler
  - getNameAsString
```
public String getNameAsString()
```
    Returns the name of the event as a String.
    
    Returns:
    
    the name of the event as a String.
  - setName
```
public void setName(String sName)
```
    Sets the name of the event using a String.
    
    Parameters:
    
    sName - the name of the event.
  - getSelEnd
```
public int getSelEnd()
```
    Returns the end position of the current text selection during a change event.
    
    Returns:
    
    the end position of the current text selection.
  - setSelEnd
```
public void setSelEnd(int nSelEnd)
```
    Sets the end position of the current text selection during a change event.
    
    Parameters:
    
    nSelEnd - the end position of the current text selection.
  - getSelStart
```
public int getSelStart()
```
    Returns the start position of the current text selection during a change event.
    
    Returns:
    
    the start position of the current text selection.
  - setSelStart
```
public void setSelStart(int nSelStart)
```
    Sets the start position of the current text selection during a change event.
    
    Parameters:
    
    nSelStart - the start position of the current text selection during a change event.
  - getShift
```
public boolean getShift()
```
    Returns whether the shift key is down during the event.
    
    Returns:
    
    true if the shift key is down during the event.
  - setShift
```
public void setShift(boolean bShift)
```
    Sets whether the shift key is down during the event.
    
    Parameters:
    
    bShift - true if the shift key is down during the event.
  - getTarget
```
public Obj getTarget()
```
    Returns the target object that triggered the event.
    
    Returns:
    
    the target object that triggered the event.
  - setTarget
```
public void setTarget(Obj target)
```
    Sets the target object that triggered the event.
    
    Parameters:
    
    target - the target object that triggered the event.
  - getSOAPFaultCode
```
public String getSOAPFaultCode()
```
    Returns the SOAP faultcode returned from executing a Web Service connection.
    
    Returns:
    
    the SOAP faultcode returned from executing a Weg Service connection.
  - setSOAPFaultCode
```
public void setSOAPFaultCode(String sSOAPFaultCode)
```
    Sets the SOAP faultcode returned from executing a Web Service connection.
    
    Parameters:
    
    sSOAPFaultCode - the SOAP faultCode.
  - getSOAPFaultString
```
public String getSOAPFaultString()
```
    Returns the SOAP faultstring returned from executing a Web Service connection.
    
    Returns:
    
    the SOAP faultstring returned from executing a Web Service connection.
  - setSOAPFaultString
```
public void setSOAPFaultString(String sSOAPFaultString)
```
    Sets the SOAP faultstring returned from executing a Web Service connection.
    
    Parameters:
    
    sSOAPFaultString - the SOAP faultstring returned from executing a Web Service connection.
  - getReenter
```
public boolean getReenter()
```
    Returns whether this event is happening immediately after the user committed this field.
    
    Returns:
    
    true if this enter event is happening immediately after the user committed this field.
  - setReenter
```
public void setReenter(boolean bReenter)
```
    Sets whether this event is happening immediately after the user committed this field. Available only during the 'enter' event.
    
    Parameters:
    
    bReenter - true if this enter event is happening immediately after the user committed this field.
  - getCancelAction
```
public boolean getCancelAction()
```
    Determines whether the current action event has been canceled.
    
    Returns:
    
    true if the current action event has been canceled.
  - getCanceledAction
```
public String getCanceledAction()
```
    Returns the name of the canceled action.
    
    Returns:
    
    the name of the canceled action.
  - setCancelAction
```
public void setCancelAction(boolean bCancelAction,
                            String sSource)
```
  - setEventInfo
```
public void setEventInfo(EventPseudoModel.EventInfo eventInfo)
```
    Sets the event state to the state contained within an EventInfo object.
    
    Parameters:
    
    eventInfo - the new state
  - getEventInfo
```
public EventPseudoModel.EventInfo getEventInfo()
```
    Returns the current event state object.
    
    Returns:
    
    an EventInfo object that represents the state of the current event.
  - reset
```
public void reset()
```
    Resets the event state to all-empty values.
  - emit
```
public void emit()
```
    Fires the event defined by the current event state. The caller must ensure that the event's name, target and any other properties defined for that event are set before calling this method.
  - cancelAction
```
public boolean cancelAction(String sAction)
```
    Determines whether the specified action has been canceled.
    If the action was canceled, this method as the side effect of setting the name of the canceled action.
    
    Parameters:
    
    sAction - the name of the action. Must be one of: execute, open, print, sign or submit.
    
    See Also:
    
    getCanceledAction()
  - cancelEvent
```
public boolean cancelEvent(String sEvent)
```
    Determines whether the specified event has been canceled.
    
    Parameters:
    
    sEvent - the name of the event
    
    Returns:
    
    true if the event should be executed.
  - isAction
```
public boolean isAction(String sOperation)
```
  - getClassAtom
```
public String getClassAtom()
```
    Description copied from class: Obj
    
    Returns the atomic name of this element's class.
    
    Overrides:
    
    getClassAtom in class Obj
    
    Returns:
    
    the class name as an interned string.
  - getClassName
```
public String getClassName()
```
    Description copied from class: Obj
    
    Gets the name of this object's class. Overriden by derived classes such as Element that have a local name that may be returned instead.
    
    Overrides:
    
    getClassName in class PseudoModel
    
    Returns:
    
    the class name.
  - getScriptTable
```
public ScriptTable getScriptTable()
```
    Overrides:
    
    getScriptTable in class PseudoModel
  - sendMessenge
```
public void sendMessenge(ExFull error,
                         int eSeverity)
```
    Description copied from class: Obj
    
    Send message to host so it can be logged
    
    Overrides:
    
    sendMessenge in class Obj
    
    Parameters:
    
    error - contains message Id and text
    
    eSeverity - the message severity
    
    See Also:
    
    Obj.sendMessenge(ExFull, int)
  - validateUsage
```
public boolean validateUsage(int nVersion,
                             int nAvailability,
                             boolean bUpdateVersion)
```
    Description copied from class: Obj
    
    Validate if the given Version and Availability flags are valid for the current document
    
    Overrides:
    
    validateUsage in class Obj
    
    Parameters:
    
    nVersion - The target XFA Version
    
    nAvailability - The target Availability flags, this indicates for what clients the script is available
    
    bUpdateVersion - indicates if the model version can be updated by the calling code
    
    Returns:
    
    if true, Version and Availability flags are valid
    
    See Also:
    
    Obj.validateUsage(int, int, boolean)
  - validateUsageFailedIsFatal
```
public boolean validateUsageFailedIsFatal(int nVersion,
                                          int nAvailability)
```
    Description copied from class: Obj
    
    Determines if disallowing a version should be considered a fatal error.
    This method is called after calling Obj.validateUsage(int, int, boolean) when that method returns false.
    
    Overrides:
    
    validateUsageFailedIsFatal in class Obj
    
    Parameters:
    
    nVersion - The target XFA Version
    
    nAvailability - The target Availability flags, this indicates for what clients the script is available
    
    Returns:
    
    true if disallowing nVersion should be considered a fatal error
    
    See Also:
    
    Obj.validateUsageFailedIsFatal(int, int)

Class EventPseudoModel

Nested Class Summary

Field Summary

Fields inherited from interface com.adobe.xfa.ut.Peer

Constructor Summary

Method Summary

Methods inherited from class com.adobe.xfa.PseudoModel

Methods inherited from class com.adobe.xfa.Obj

Methods inherited from class java.lang.Object

Constructor Detail

EventPseudoModel

Method Detail

getPrevText

setPrevText

getPrevContentType

setPrevContentType

getChange

setChange

getNewText

setNewText

getNewContentType

setNewContentType

getFullText

setFullText

getCommitKey

setCommitKey

getKeyDown

setKeyDown

getModifier

setModifier

getName

setName

getNameAsString

setName

getSelEnd

setSelEnd

getSelStart

setSelStart

getShift

setShift

getTarget

setTarget

getSOAPFaultCode

setSOAPFaultCode

getSOAPFaultString

setSOAPFaultString

getReenter

setReenter

getCancelAction

getCanceledAction

setCancelAction

setEventInfo

getEventInfo

reset

emit

cancelAction

cancelEvent

isAction

getClassAtom

getClassName

getScriptTable

sendMessenge

validateUsage

validateUsageFailedIsFatal