Java Doc for InteractiveInfoAtom.java in  » Collaboration » poi-3.0.2-beta2 » org » apache » poi » hslf » record » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Collaboration » poi 3.0.2 beta2 » org.apache.poi.hslf.record 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.poi.hslf.record.Record
      org.apache.poi.hslf.record.RecordAtom
         org.apache.poi.hslf.record.InteractiveInfoAtom

InteractiveInfoAtom
public class InteractiveInfoAtom extends RecordAtom (Code)
Tne atom that holds metadata on Links in the document. (The actual link is held Document.ExObjList.ExHyperlink)
author:
   Nick Burch
author:
   Yegor Kozlov


Field Summary
final public static  intACTION_CUSTOMSHOW
    
final public static  intACTION_HYPERLINK
    
final public static  intACTION_JUMP
    
final public static  intACTION_MACRO
    
final public static  intACTION_MEDIA
    
final public static  intACTION_NONE
    
final public static  intACTION_OLE
    
final public static  intACTION_RUNPROGRAM
    
final public static  intJUMP_ENDSHOW
    
final public static  intJUMP_FIRSTSLIDE
    
final public static  intJUMP_LASTSLIDE
    
final public static  intJUMP_LASTSLIDEVIEWED
    
final public static  intJUMP_NEXTSLIDE
    
final public static  intJUMP_NONE
    
final public static  intJUMP_PREVIOUSSLIDE
    

Constructor Summary
protected  InteractiveInfoAtom()
     Constructs a brand new link related atom record.
protected  InteractiveInfoAtom(byte[] source, int start, int len)
     Constructs the link related atom record from its source data.

Method Summary
public  bytegetAction()
     Hyperlink Action.
public  bytegetFlags()
     Flags

  • Bit 1: Animated.
  • public  intgetHyperlinkID()
         Gets the link number.
    public  bytegetHyperlinkType()
        
    public  bytegetJump()
        
    public  bytegetOleVerb()
         Only valid when action == OLEAction.
    public  longgetRecordType()
         Gets the record type.
    public  intgetSoundRef()
         a reference to a sound in the sound collection.
    public  voidsetAction(byte val)
        
    public  voidsetFlags(byte val)
         Flags

  • Bit 1: Animated.
  • public  voidsetHyperlinkID(int number)
        
    public  voidsetHyperlinkType(byte val)
        
    public  voidsetJump(byte val)
        
    public  voidsetOleVerb(byte val)
         Only valid when action == OLEAction.
    public  voidsetSoundRef(int val)
         a reference to a sound in the sound collection.
    public  voidwriteOut(OutputStream out)
        

    Field Detail
    ACTION_CUSTOMSHOW
    final public static int ACTION_CUSTOMSHOW(Code)



    ACTION_HYPERLINK
    final public static int ACTION_HYPERLINK(Code)



    ACTION_JUMP
    final public static int ACTION_JUMP(Code)



    ACTION_MACRO
    final public static int ACTION_MACRO(Code)



    ACTION_MEDIA
    final public static int ACTION_MEDIA(Code)



    ACTION_NONE
    final public static int ACTION_NONE(Code)
    Action Table



    ACTION_OLE
    final public static int ACTION_OLE(Code)



    ACTION_RUNPROGRAM
    final public static int ACTION_RUNPROGRAM(Code)



    JUMP_ENDSHOW
    final public static int JUMP_ENDSHOW(Code)



    JUMP_FIRSTSLIDE
    final public static int JUMP_FIRSTSLIDE(Code)



    JUMP_LASTSLIDE
    final public static int JUMP_LASTSLIDE(Code)



    JUMP_LASTSLIDEVIEWED
    final public static int JUMP_LASTSLIDEVIEWED(Code)



    JUMP_NEXTSLIDE
    final public static int JUMP_NEXTSLIDE(Code)



    JUMP_NONE
    final public static int JUMP_NONE(Code)
    Jump Table



    JUMP_PREVIOUSSLIDE
    final public static int JUMP_PREVIOUSSLIDE(Code)




    Constructor Detail
    InteractiveInfoAtom
    protected InteractiveInfoAtom()(Code)
    Constructs a brand new link related atom record.



    InteractiveInfoAtom
    protected InteractiveInfoAtom(byte[] source, int start, int len)(Code)
    Constructs the link related atom record from its source data.
    Parameters:
      source - the source data as a byte array.
    Parameters:
      start - the start offset into the byte array.
    Parameters:
      len - the length of the slice in the byte array.




    Method Detail
    getAction
    public byte getAction()(Code)
    Hyperlink Action.

    see ACTION_* constants for the list of actions

    hyperlink action.



    getFlags
    public byte getFlags()(Code)
    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.




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



    getHyperlinkType
    public byte getHyperlinkType()(Code)
    hyperlink type hyperlink type



    getJump
    public byte getJump()(Code)
    Jump

    see JUMP_* constants for the list of actions

    jump



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



    getRecordType
    public long getRecordType()(Code)
    Gets the record type. the record type.



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



    setAction
    public void setAction(byte val)(Code)
    Hyperlink Action

    see ACTION_* constants for the list of actions


    Parameters:
      val - hyperlink action.



    setFlags
    public void setFlags(byte val)(Code)
    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.




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



    setHyperlinkType
    public void setHyperlinkType(byte val)(Code)
    hyperlink type
    Parameters:
      val - hyperlink type



    setJump
    public void setJump(byte val)(Code)
    Jump

    see JUMP_* constants for the list of actions


    Parameters:
      val - jump



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



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



    writeOut
    public void writeOut(OutputStream out) throws IOException(Code)
    Write the contents of the record back, so it can be written to disk
    Parameters:
      out - the output stream to write to.
    throws:
      IOException - if an error occurs.



    Methods inherited from org.apache.poi.hslf.record.RecordAtom
    public Record[] getChildRecords()(Code)(Java Doc)
    public boolean isAnAtom()(Code)(Java Doc)

    Fields inherited from org.apache.poi.hslf.record.Record
    protected POILogger logger(Code)(Java Doc)

    Methods inherited from org.apache.poi.hslf.record.Record
    public static Record buildRecordAtOffset(byte[] b, int offset)(Code)(Java Doc)
    public static Record createRecordForType(long type, byte[] b, int start, int len)(Code)(Java Doc)
    public static Record[] findChildRecords(byte[] b, int start, int len)(Code)(Java Doc)
    abstract public Record[] getChildRecords()(Code)(Java Doc)
    abstract public long getRecordType()(Code)(Java Doc)
    abstract public boolean isAnAtom()(Code)(Java Doc)
    public static void writeLittleEndian(int i, OutputStream o) throws IOException(Code)(Java Doc)
    public static void writeLittleEndian(short s, OutputStream o) throws IOException(Code)(Java Doc)
    abstract public void writeOut(OutputStream o) throws IOException(Code)(Java Doc)

    Methods inherited from java.lang.Object
    native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
    public boolean equals(Object obj)(Code)(Java Doc)
    protected void finalize() throws Throwable(Code)(Java Doc)
    final native public Class getClass()(Code)(Java Doc)
    native public int hashCode()(Code)(Java Doc)
    final native public void notify()(Code)(Java Doc)
    final native public void notifyAll()(Code)(Java Doc)
    public String toString()(Code)(Java Doc)
    final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
    final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
    final public void wait() throws InterruptedException(Code)(Java Doc)

    www.java2java.com | Contact Us
    Copyright 2009 - 12 Demo Source and Support. All rights reserved.
    All other trademarks are property of their respective owners.