Package com.adobe.xfa

Class 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)

    • Constructor Detail

      • EventPseudoModel

        public EventPseudoModel​(AppModel appModel)

    • Method Detail

      • getPrevText

        public java.lang.String getPrevText()
        Returns the value before the field changes.
        Returns:
        the value before the field changes.

      • setPrevText

        public void setPrevText​(java.lang.String sPrevText)
        Sets the value before the field changes.
        Parameters:
        sPrevText - the value before the field changes.

      • getPrevContentType

        public java.lang.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​(java.lang.String sPrevContentType)
        Sets the contentType of prevText.
        Parameters:
        sPrevContentType - the contentType of prevText.

      • getChange

        public java.lang.String getChange()
        Returns the text typed or pasted into the field.
        Returns:
        the text typed or pasted into the field.

      • setChange

        public void setChange​(java.lang.String sChange)
        Sets the text typed or pasted into the field.
        Parameters:
        sChange - the text typed or pasted into the field.

      • getNewText

        public java.lang.String getNewText()
        Returns the value after the field change.
        Returns:
        the value after the field change.

      • setNewText

        public void setNewText​(java.lang.String sNewText)
        Sets the value after the field change.
        Parameters:
        sNewText - the value after the field change.

      • getNewContentType

        public java.lang.String getNewContentType()
        Returns the contentType after the field change.
        Returns:
        the contentType after the field change.

      • setNewContentType

        public void setNewContentType​(java.lang.String sNewContentType)
        Sets the contentType after the field change.
        Parameters:
        sNewContentType - the contentType after the field change.

      • getFullText

        public java.lang.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​(java.lang.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 java.lang.String getNameAsString()
        Returns the name of the event as a String.
        Returns:
        the name of the event as a String.

      • setName

        public void setName​(java.lang.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 java.lang.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​(java.lang.String sSOAPFaultCode)
        Sets the SOAP faultcode returned from executing a Web Service connection.
        Parameters:
        sSOAPFaultCode - the SOAP faultCode.

      • getSOAPFaultString

        public java.lang.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​(java.lang.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 java.lang.String getCanceledAction()
        Returns the name of the canceled action.
        Returns:
        the name of the canceled action.

      • setCancelAction

        public void setCancelAction​(boolean bCancelAction,
                            java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String sOperation)

      • getClassAtom

        public java.lang.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 java.lang.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.

      • 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)