Package org.jpedal.objects.acroforms.actions

Interface ActionHandler

All Known Implementing Classes:
DefaultActionHandler, org.jpedal.objects.acroforms.actions.EmptyActionHandler
public interface ActionHandler

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FOCUS_EVENT
     
    static final int
    MOUSECLICKED
     
    static final int
    MOUSEENTERED
     
    static final int
    MOUSEEXITED
     
    static final int
    MOUSEPRESSED
     
    static final int
    MOUSERELEASED
     
    static final int
    NOMESSAGE
     
    static final int
    REJECTKEY
     
    static final int
    STOPPROCESSING
     
    static final int
    TODO
     
    static final int
    VALUESCHANGED
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    A(Object e, FormObject formObject, int eventType)
    A action when pressed in active area ?
    void
    Bl(Object e, FormObject formObj)
    Bl action when input focus lost
    void
    C(FormObject formObject)
    C action when another field changes (recalculate this field) [javascript] should not be called other than from internal methods to action changes on other fields.
    void
    C(org.jpedal.objects.raw.PageObject pageObject)
    C action when a page closes
    void
    changeTo(String file, int page, Object location, Integer type, boolean storeView)
     
    void
    D(Object e, FormObject formObj)
    D action when cursor button pressed inside active area
    void
    DP(org.jpedal.objects.raw.PdfObject rootObject)
    DP action, when the document is done printing
    void
    DS(org.jpedal.objects.raw.PdfObject rootObject)
    DS action, when the document is done saving
    void
    E(Object e, FormObject formObject)
    E action when cursor enters active area
    void
    F(FormObject formObject)
    F the display formatting of the field (e.g 2 decimal places) [javascript]
    void
    Fo(Object e, FormObject formObj)
    Fo action on input focus
    org.jpedal.objects.layers.PdfLayerList
    getLayerHandler()
     
    PdfDecoderInt
    getPDFDecoder()
     
    int
    gotoDest(org.jpedal.objects.raw.PdfObject aobj, int mouseclicked, int dest)
     
    void
    init(PdfDecoderInt panel, org.jpedal.objects.Javascript javascript, org.jpedal.objects.acroforms.AcroRenderer defaultAcroRenderer)
     
    int
    K(Object e, FormObject formObject, int actionID)
    K action on - [javascript] keystroke in textfield or combobox modifys the list box selection (can access the keystroke for validity and reject or modify)
    void
    O(org.jpedal.objects.raw.PdfObject pdfObject, int type)
    O action when page containing is opened,
    void
    OpenAction(org.jpedal.objects.raw.PdfObject rootObject)
    OpenAction, when the PDF is opened
    void
    PC(org.jpedal.objects.raw.PdfObject pdfObject, int type)
    PC action when page is closed
    void
    PI(org.jpedal.objects.raw.PdfObject pdfObject, int type)
    PI action when no longer visible in viewer
    void
    PO(org.jpedal.objects.raw.PdfObject pdfObject, int type)
    PO action when page containing is opened, action O from page dictionary, and OpenAction in document catalog should be done first
    void
    processDocumentActions(org.jpedal.io.PdfObjectReader currentPdfFile)
    Provides an opportunity for the ActionHandler to process all document actions
    void
    processFieldActions(FormObject formObject)
    Provides an opportunity for the ActionHandler to process field actions
    void
    processOutlinesActions(org.jpedal.objects.raw.PdfObject outlines)
    Provides an opportunity for the ActionHandler to process all outline actions
    void
    processPageActions(org.jpedal.io.PdfObjectReader currentPdfFile, int page)
    Provides an opportunity for the ActionHandler to process page actions
    void
    PV(org.jpedal.objects.raw.PdfObject pdfObject, int type)
    PV action on viewing containing page
    Object
    setHoverCursor()
    setup hand cursor when hovering and reset, on exiting
    void
    U(Object e, FormObject formObj)
    U action when cursor button released inside active area
    void
    V(Object e, FormObject formObject, int actionID)
    V action when fields value is changed [javascript]
    void
    WC(org.jpedal.objects.raw.PdfObject rootObject)
    WC action, when the document will close
    void
    WP(org.jpedal.objects.raw.PdfObject rootObject)
    WP action, when the document will print
    void
    WS(org.jpedal.objects.raw.PdfObject rootObject)
    WS action, when the document will save
    void
    X(Object e, FormObject formObject)
    X action when cursor exits active area

  • Field Details

  • Method Details

    • A

      void A(Object e, FormObject formObject, int eventType)
      A action when pressed in active area ?some others should now be ignored?
      Parameters:
      e - Object contained by the action
      formObject - - Actual formObject containing data
      eventType - - type of event (Keystroke, focus)

    • E

      void E(Object e, FormObject formObject)
      E action when cursor enters active area
      Parameters:
      e - Object contained by the action
      formObject - - Actual formObject containing data

    • X

      void X(Object e, FormObject formObject)
      X action when cursor exits active area
      Parameters:
      e - Object contained by the action
      formObject - - Actual formObject containing data

    • D

      void D(Object e, FormObject formObj)
      D action when cursor button pressed inside active area
      Parameters:
      e - Object contained by the action
      formObj - - Actual formObject containing data

    • U

      void U(Object e, FormObject formObj)
      U action when cursor button released inside active area
      Parameters:
      e - Object contained by the action
      formObj - - Actual formObject containing data

    • Fo

      void Fo(Object e, FormObject formObj)
      Fo action on input focus
      Parameters:
      e - Object contained by the action
      formObj - - Actual formObject containing data

    • Bl

      void Bl(Object e, FormObject formObj)
      Bl action when input focus lost
      Parameters:
      e - Object contained by the action
      formObj - - Actual formObject containing data

    • PO

      void PO(org.jpedal.objects.raw.PdfObject pdfObject, int type)
      PO action when page containing is opened, action O from page dictionary, and OpenAction in document catalog should be done first
      Parameters:
      pdfObject - - of the opening page
      type - - the type of action

    • O

      void O(org.jpedal.objects.raw.PdfObject pdfObject, int type)
      O action when page containing is opened,
      Parameters:
      pdfObject - - of the opening page
      type - - the type of action

    • PC

      void PC(org.jpedal.objects.raw.PdfObject pdfObject, int type)
      PC action when page is closed
      Parameters:
      pdfObject - - of the opening page
      type - - the type of action

    • PV

      void PV(org.jpedal.objects.raw.PdfObject pdfObject, int type)
      PV action on viewing containing page
      Parameters:
      pdfObject - - of the opening page
      type - - the type of action

    • PI

      void PI(org.jpedal.objects.raw.PdfObject pdfObject, int type)
      PI action when no longer visible in viewer
      Parameters:
      pdfObject - - of the opening page
      type - - the type of action

    • K

      int K(Object e, FormObject formObject, int actionID)
      K action on - [javascript] keystroke in textfield or combobox modifys the list box selection (can access the keystroke for validity and reject or modify)
      Parameters:
      e - - Object contained by the action
      formObject - - Actual formObject containing data
      actionID - - integer value of the actionID
      Returns:
      the action

    • F

      void F(FormObject formObject)
      F the display formatting of the field (e.g 2 decimal places) [javascript]
      Parameters:
      formObject - - Actual formObject containing data

    • V

      void V(Object e, FormObject formObject, int actionID)
      V action when fields value is changed [javascript]
      Parameters:
      e - - Object contained by the action
      formObject - - Actual formObject containing data
      actionID - - integer value of the actionID

    • C

      void C(FormObject formObject)
      C action when another field changes (recalculate this field) [javascript] should not be called other than from internal methods to action changes on other fields.
      Parameters:
      formObject - - Actual formObject containing data

    • C

      void C(org.jpedal.objects.raw.PageObject pageObject)
      C action when a page closes
      Parameters:
      pageObject - the page being closed
      Implementation Note:
      At present, this action is not called when a page is closed

    • WC

      void WC(org.jpedal.objects.raw.PdfObject rootObject)
      WC action, when the document will close
      Parameters:
      rootObject - the root object of the document
      Implementation Note:
      At present, this action is not called when the document is closed

    • WS

      void WS(org.jpedal.objects.raw.PdfObject rootObject)
      WS action, when the document will save
      Parameters:
      rootObject - the root object of the document
      Implementation Note:
      At present, this action is not called when the document will save

    • DS

      void DS(org.jpedal.objects.raw.PdfObject rootObject)
      DS action, when the document is done saving
      Parameters:
      rootObject - the root object of the document
      Implementation Note:
      At present, this action is not called when the document is finished saving

    • WP

      void WP(org.jpedal.objects.raw.PdfObject rootObject)
      WP action, when the document will print
      Parameters:
      rootObject - the root object of the document
      Implementation Note:
      At present, this action is not called when the document will print

    • DP

      void DP(org.jpedal.objects.raw.PdfObject rootObject)
      DP action, when the document is done printing
      Parameters:
      rootObject - the root object of the document
      Implementation Note:
      At present, this action is not called when the document is finished printing

    • OpenAction

      void OpenAction(org.jpedal.objects.raw.PdfObject rootObject)
      OpenAction, when the PDF is opened
      Parameters:
      rootObject - the root object of the document
      Implementation Note:
      At present, this action is not called when the document is opened

    • processDocumentActions

      void processDocumentActions(org.jpedal.io.PdfObjectReader currentPdfFile)
      Provides an opportunity for the ActionHandler to process all document actions
      Parameters:
      currentPdfFile - - The current PDF file reader
      Implementation Note:
      May not be implemented by subclasses

    • processOutlinesActions

      void processOutlinesActions(org.jpedal.objects.raw.PdfObject outlines)
      Provides an opportunity for the ActionHandler to process all outline actions
      Parameters:
      outlines - - The /Outlines object
      Implementation Note:
      May not be implemented by subclasses

    • processPageActions

      void processPageActions(org.jpedal.io.PdfObjectReader currentPdfFile, int page)
      Provides an opportunity for the ActionHandler to process page actions
      Parameters:
      currentPdfFile - - The current PDF file reader
      page - - The number of the page to process
      Implementation Note:
      May not be implemented by subclasses

    • processFieldActions

      void processFieldActions(FormObject formObject)
      Provides an opportunity for the ActionHandler to process field actions
      Parameters:
      formObject - - The field object to process
      Implementation Note:
      May not be implemented by subclasses

    • getPDFDecoder

      PdfDecoderInt getPDFDecoder()

    • setHoverCursor

      Object setHoverCursor()
      setup hand cursor when hovering and reset, on exiting
      Returns:
      hand cursor

    • init

      void init(PdfDecoderInt panel, org.jpedal.objects.Javascript javascript, org.jpedal.objects.acroforms.AcroRenderer defaultAcroRenderer)

    • getLayerHandler

      org.jpedal.objects.layers.PdfLayerList getLayerHandler()

    • changeTo

      void changeTo(String file, int page, Object location, Integer type, boolean storeView)

    • gotoDest

      int gotoDest(org.jpedal.objects.raw.PdfObject aobj, int mouseclicked, int dest)