Package org.apache.poi.hslf.record

Class InteractiveInfoAtom

  • public class InteractiveInfoAtom
extends RecordAtom
    Tne atom that holds metadata on Links in the document. (The actual link is held Document.ExObjList.ExHyperlink)

    • Method Detail

      • getHyperlinkID

        public int getHyperlinkID()
        Gets the link number. You will normally look the ExHyperlink with this number to get the details.
        Returns:
        the link number

      • setHyperlinkID

        public void setHyperlinkID​(int number)
        Sets the persistent unique identifier of the link
        Parameters:
        number - the persistent unique identifier of the link

      • getSoundRef

        public int getSoundRef()
        a reference to a sound in the sound collection.

      • setSoundRef

        public void setSoundRef​(int val)
        a reference to a sound in the sound collection.
        Parameters:
        val - a reference to a sound in the sound collection

      • getAction

        public byte getAction()
        Hyperlink Action.

        see ACTION_* constants for the list of actions

        Returns:
        hyperlink action.

      • setAction

        public void setAction​(byte val)
        Hyperlink Action

        see ACTION_* constants for the list of actions

        Parameters:
        val - hyperlink action.

      • getOleVerb

        public byte getOleVerb()
        Only valid when action == OLEAction. OLE verb to use, 0 = first verb, 1 = second verb, etc.

      • setOleVerb

        public void setOleVerb​(byte val)
        Only valid when action == OLEAction. OLE verb to use, 0 = first verb, 1 = second verb, etc.

      • getJump

        public byte getJump()
        Jump

        see JUMP_* constants for the list of actions

        Returns:
        jump

      • setJump

        public void setJump​(byte val)
        Jump

        see JUMP_* constants for the list of actions

        Parameters:
        val - jump

      • getFlags

        public byte getFlags()
        Flags

      • Bit 1: Animated. If 1, then button is animated
      • Bit 2: Stop sound. If 1, then stop current sound when button is pressed.
      • Bit 3: CustomShowReturn. If 1, and this is a jump to custom show, then return to this slide after custom show.