Package com.adobe.xfa

Class EventPseudoModel.EventInfo

java.lang.Object
com.adobe.xfa.EventPseudoModel.EventInfo
Enclosing class:
EventPseudoModel
public static class EventPseudoModel.EventInfo extends Object
Encapsulates the state of EventPseudoModel. A caller will typically use instances of this class to save and restore the state of the EventPseudoModel when firing a nested event.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EventInfo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getCommitKey()
    Returns how a form field was committed.
    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
    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.
    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.
    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
    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
    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 faultstring 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.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • EventInfo

      public EventInfo()

  • Method Details

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

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

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

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

    • 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 faultstring returned from executing a Web Service connection.
      Parameters:
      sSOAPFaultCode - the SOAP faultstring returned from executing a Web Service connection.

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