Package org.apache.poi.hslf.record
Class InteractiveInfoAtom
- java.lang.Object
-
- org.apache.poi.hslf.record.Record
-
- org.apache.poi.hslf.record.RecordAtom
-
- org.apache.poi.hslf.record.InteractiveInfoAtom
-
- All Implemented Interfaces:
GenericRecord
public class InteractiveInfoAtom extends RecordAtom
Tne atom that holds metadata on Links in the document. (The actual link is held Document.ExObjList.ExHyperlink)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
InteractiveInfoAtom.Action
static class
InteractiveInfoAtom.Jump
static class
InteractiveInfoAtom.Link
-
Field Summary
Fields Modifier and Type Field Description static byte
ACTION_CUSTOMSHOW
static byte
ACTION_HYPERLINK
static byte
ACTION_JUMP
static byte
ACTION_MACRO
static byte
ACTION_MEDIA
static byte
ACTION_NONE
Action Tablestatic byte
ACTION_OLE
static byte
ACTION_RUNPROGRAM
static byte
JUMP_ENDSHOW
static byte
JUMP_FIRSTSLIDE
static byte
JUMP_LASTSLIDE
static byte
JUMP_LASTSLIDEVIEWED
static byte
JUMP_NEXTSLIDE
static byte
JUMP_NONE
Jump Tablestatic byte
JUMP_PREVIOUSSLIDE
static byte
LINK_CustomShow
static byte
LINK_FirstSlide
static byte
LINK_LastSlide
static byte
LINK_NextSlide
Types of hyperlinksstatic byte
LINK_NULL
static byte
LINK_OtherFile
static byte
LINK_OtherPresentation
static byte
LINK_PreviousSlide
static byte
LINK_SlideNumber
static byte
LINK_Url
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte
getAction()
Hyperlink Action.byte
getFlags()
Flags Bit 1: Animated.java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
int
getHyperlinkID()
Gets the link number.byte
getHyperlinkType()
hyperlink typebyte
getJump()
Jumpbyte
getOleVerb()
Only valid when action == OLEAction.long
getRecordType()
Gets the record type.int
getSoundRef()
a reference to a sound in the sound collection.void
setAction(byte val)
Hyperlink Actionvoid
setFlags(byte val)
Flags Bit 1: Animated.void
setHyperlinkID(int number)
Sets the persistent unique identifier of the linkvoid
setHyperlinkType(byte val)
hyperlink typevoid
setJump(byte val)
Jumpvoid
setOleVerb(byte val)
Only valid when action == OLEAction.void
setSoundRef(int val)
a reference to a sound in the sound collection.void
writeOut(java.io.OutputStream out)
Write the contents of the record back, so it can be written to disk-
Methods inherited from class org.apache.poi.hslf.record.RecordAtom
getChildRecords, getMaxRecordLength, isAnAtom, setMaxRecordLength
-
Methods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, getGenericChildren, getGenericRecordType, writeLittleEndian, writeLittleEndian
-
-
-
-
Field Detail
-
ACTION_NONE
public static final byte ACTION_NONE
Action Table- See Also:
- Constant Field Values
-
ACTION_MACRO
public static final byte ACTION_MACRO
- See Also:
- Constant Field Values
-
ACTION_RUNPROGRAM
public static final byte ACTION_RUNPROGRAM
- See Also:
- Constant Field Values
-
ACTION_JUMP
public static final byte ACTION_JUMP
- See Also:
- Constant Field Values
-
ACTION_HYPERLINK
public static final byte ACTION_HYPERLINK
- See Also:
- Constant Field Values
-
ACTION_OLE
public static final byte ACTION_OLE
- See Also:
- Constant Field Values
-
ACTION_MEDIA
public static final byte ACTION_MEDIA
- See Also:
- Constant Field Values
-
ACTION_CUSTOMSHOW
public static final byte ACTION_CUSTOMSHOW
- See Also:
- Constant Field Values
-
JUMP_NONE
public static final byte JUMP_NONE
Jump Table- See Also:
- Constant Field Values
-
JUMP_NEXTSLIDE
public static final byte JUMP_NEXTSLIDE
- See Also:
- Constant Field Values
-
JUMP_PREVIOUSSLIDE
public static final byte JUMP_PREVIOUSSLIDE
- See Also:
- Constant Field Values
-
JUMP_FIRSTSLIDE
public static final byte JUMP_FIRSTSLIDE
- See Also:
- Constant Field Values
-
JUMP_LASTSLIDE
public static final byte JUMP_LASTSLIDE
- See Also:
- Constant Field Values
-
JUMP_LASTSLIDEVIEWED
public static final byte JUMP_LASTSLIDEVIEWED
- See Also:
- Constant Field Values
-
JUMP_ENDSHOW
public static final byte JUMP_ENDSHOW
- See Also:
- Constant Field Values
-
LINK_NextSlide
public static final byte LINK_NextSlide
Types of hyperlinks- See Also:
- Constant Field Values
-
LINK_PreviousSlide
public static final byte LINK_PreviousSlide
- See Also:
- Constant Field Values
-
LINK_FirstSlide
public static final byte LINK_FirstSlide
- See Also:
- Constant Field Values
-
LINK_LastSlide
public static final byte LINK_LastSlide
- See Also:
- Constant Field Values
-
LINK_CustomShow
public static final byte LINK_CustomShow
- See Also:
- Constant Field Values
-
LINK_SlideNumber
public static final byte LINK_SlideNumber
- See Also:
- Constant Field Values
-
LINK_Url
public static final byte LINK_Url
- See Also:
- Constant Field Values
-
LINK_OtherPresentation
public static final byte LINK_OtherPresentation
- See Also:
- Constant Field Values
-
LINK_OtherFile
public static final byte LINK_OtherFile
- See Also:
- Constant Field Values
-
LINK_NULL
public static final byte LINK_NULL
- See Also:
- Constant Field Values
-
-
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 Actionsee
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()
Jumpsee
JUMP_*
constants for the list of actions- Returns:
- jump
-
setJump
public void setJump(byte val)
Jumpsee
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.
-
setFlags
public void setFlags(byte val)
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.
-
getHyperlinkType
public byte getHyperlinkType()
hyperlink type- Returns:
- hyperlink type
-
setHyperlinkType
public void setHyperlinkType(byte val)
hyperlink type- Parameters:
val
- hyperlink type
-
getRecordType
public long getRecordType()
Gets the record type.- Specified by:
getRecordType
in classRecord
- Returns:
- the record type.
-
writeOut
public void writeOut(java.io.OutputStream out) throws java.io.IOException
Write the contents of the record back, so it can be written to disk
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
-
-