DocInfoListContainer (POI API Documentation)

Have the contents printer out into an OutputStream, used when writing a Modified: poi/site/publish/apidocs/org/apache/poi/hslf/record/CurrentUserAtom.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hslf/record/CurrentUserAtom.html?rev=1765697&r1=1765696&r2=1765697&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hslf/record/CurrentUserAtom.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hslf/record/CurrentUserAtom.html Wed Oct 19 19:06:24 2016 @@ -35,7 +35,7 @@

Frames

Frames

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

java.lang.Object
+
- org.apache.poi.hslf.record.Record
- +
  - org.apache.poi.hslf.record.RecordContainer
  - +
    - org.apache.poi.hslf.record.DocInfoListContainer
    +
  +
+

+
+
+
```
public final class DocInfoListContainer
+extends RecordContainer
```
+
A container record that specifies information about the document and document display settings.
+

+ +

+ + +
Field Summary
+
- + + +
  Fields inherited from class org.apache.poi.hslf.record.RecordContainer
  +_children
+
- + + +
  Fields inherited from class org.apache.poi.hslf.record.Record
  +logger
+

+ +

+ + +

Constructor Summary

+ + + + + + + + + + +

Constructors
Modifier	Constructor and Description
`protected`	`DocInfoListContainer(byte[] source, + int start, + int len)` + Set things up, and find our more interesting children +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`long`	`getRecordType()` + We are of type 0x7D0 +
`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.RecordContainer
+addChildAfter, addChildBefore, appendChildRecord, findFirstOfType, getChildRecords, handleParentAwareRecords, isAnAtom, moveChildBefore, moveChildrenAfter, moveChildrenBefore, removeChild, setChildRecord, writeOut

+ + +
Methods inherited from class org.apache.poi.hslf.record.Record
+buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    DocInfoListContainer
    +
```
protected DocInfoListContainer(byte[] source,
+                    int start,
+                    int len)
```
    +
    Set things up, and find our more interesting children
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getRecordType
    +
```
public long getRecordType()
```
    +
    We are of type 0x7D0
    +
    +
    Specified by:
    +
    getRecordType in class Record
    +
    +
  + + + +
  - +
    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
    +
    +
    Specified by:
    +
    writeOut in class Record
    +
    Throws:
    +
    java.io.IOException
    +
  +
+

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

getRawData()

int

getRecordInstance()

Gets the record instance from the header

long

getRecordType()

Gets the record type.

boolean

isCompressed()

void

setData(byte[] data)

Sets the embedded data.

void

setLastOnDiskOffset(int offset)

Update the Record's idea of where on disk it lives, after a write out.

void

setPersistId(int id)

Set our sheet ID, as found from a PersistPtrHolder

void

updateOtherRecordReferences(java.util.Map<java.lang.Integer,java.lang.Integer> oldToNewReferencesLookup)

Offer the record the list of records that have changed their location as part of the writeout.

void

writeOut(java.io.OutputStream out)

Write the contents of the record back, so it can be written @@ -414,6 +420,17 @@ implements Returns:

the record type.

+ +

+
getRecordInstance
+
```
public int getRecordInstance()
```
+
Gets the record instance from the header
+
Returns:
record instance
+

Direct Known Subclasses:
-
AnimationInfoAtom, ColorSchemeAtom, Comment2000Atom, CString, DocumentAtom, ExControlAtom, ExEmbedAtom, ExHyperlinkAtom, ExMediaAtom, ExObjListAtom, ExObjRefAtom, ExOleObjAtom, ExOleObjStg, FontEntityAtom, He adersFootersAtom, InteractiveInfoAtom, MasterTextPropAtom, NotesAtom, OEPlaceholderAtom, OutlineTextRefAtom, PositionDependentRecordAtom, PPDrawing, PPDrawingGroup, RoundTripHFPlaceholder12, SlideAtom, SlidePersistAtom, SoundData, SSSlideInfoAtom, StyleTextProp9Atom, StyleTextPropAtom, TextBytesAtom, TextCharsAtom, TextHeaderAtom, TextRulerAtom, TextSpecInfoAtom, TxInteractiveInfoAtom, TxMasterStyleAtom, UnknownRecordPlaceholder
+
AnimationInfoAtom, ColorSchemeAtom, Comment2000Atom, CString, DocumentAtom, ExControlAtom, ExEmbedAtom, ExHyperlinkAtom, ExMediaAtom, ExObjListAtom, ExObjRefAtom, ExOleObjAtom, ExOleObjStg, FontEntityAtom, He adersFootersAtom, InteractiveInfoAtom, MasterTextPropAtom, NotesAtom, OEPlaceholderAtom, OutlineTextRefAtom, PositionDependentRecordAtom, PPDrawing, PPDrawingGroup, RoundTripHFPlaceholder12, SlideAtom, SlidePersistAtom, SoundData, SSSlideInfoAtom, StyleTextProp9Atom, StyleTextPropAtom, TextBytesAtom, TextCharsAtom, TextHeaderAtom, TextRulerAtom, TextSpecInfoAtom, TxInteractiveInfoAtom, TxMasterStyleAtom, UnknownRecordPlaceholder, VBAInfoAtom

Modified: poi/site/publish/apidocs/org/apache/poi/hslf/record/RecordContainer.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hslf/record/RecordContainer.html?rev=1765697&r1=1765696&r2=1765697&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hslf/record/RecordContainer.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hslf/record/RecordContainer.html Wed Oct 19 19:06:24 2016 @@ -99,7 +99,7 @@

Direct Known Subclasses:: AnimationInfo, Comment2000, DummyRecordWithChildren, EscherTextboxWrapper, ExEmbed, ExHyperlink, ExMCIMovie, ExObjList, ExVideoContainer, FontCollection, HeadersFootersContainer, InteractiveInfo, PositionDependentRecordContainer, SlideListWithText, Sound, SoundCollection; AnimationInfo, Comment2000, DocInfoListContainer, DummyRecordWithChildren, EscherTextboxWrapper, ExEmbed, ExHyperlink, ExMCIMovie, ExObjList, ExVideoContainer, FontCollection, HeadersFootersContainer, InteractiveInfo, PositionDependentRecordContainer, SlideListWithText, Sound, SoundCollection, VBAInfoContainer

Modified: poi/site/publish/apidocs/org/apache/poi/hslf/record/UserEditAtom.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hslf/record/UserEditAtom.html?rev=1765697&r1=1765696&r2=1765697&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hslf/record/UserEditAtom.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hslf/record/UserEditAtom.html Wed Oct 19 19:06:24 2016 @@ -35,7 +35,7 @@

Prev Class
Next Class
Next Class

Frames

Prev Class
Next Class
Next Class

Frames

VBAInfoAtom (POI API Documentation)

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

java.lang.Object
+
- org.apache.poi.hslf.record.Record
- +
  - org.apache.poi.hslf.record.RecordAtom
  - +
    - org.apache.poi.hslf.record.VBAInfoAtom
    +
  +
+

+
+
+
```
public final class VBAInfoAtom
+extends RecordAtom
```
+
An atom record that specifies a reference to the VBA project storage.
+

+ +

+ + +
Field Summary
+
- + + +
  Fields inherited from class org.apache.poi.hslf.record.Record
  +logger
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
VBAInfoAtom(byte[] source, + int start, + int len) +
Constructs the vba atom record from its source data.
+
+

Constructors
Constructor and Description
`VBAInfoAtom(byte[] source, + int start, + int len)` + Constructs the vba atom record from its source data. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`long`	`getPersistIdRef()`
`long`	`getRecordType()` + Gets the record type. +
`long`	`getVersion()`
`boolean`	`isHasMacros()`
`void`	`setHasMacros(boolean hasMacros)`
`void`	`setPersistIdRef(long persistIdRef)`
`void`	`setVersion(long version)`
`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, isAnAtom

+ + +
Methods inherited from class org.apache.poi.hslf.record.Record
+buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    VBAInfoAtom
    +
```
public VBAInfoAtom(byte[] source,
+           int start,
+           int len)
```
    +
    Constructs the vba atom record from its source data.
    +
    Parameters:
    source - the source data as a byte array.
    start - the start offset into the byte array.
    len - the length of the slice in the byte array.
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getRecordType
    +
```
public long getRecordType()
```
    +
    Gets the record type.
    +
    +
    Specified by:
    +
    getRecordType in class Record
    +
    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
    +
    +
    Specified by:
    +
    writeOut in class Record
    +
    Parameters:
    out - the output stream to write to.
    +
    Throws:
    +
    java.io.IOException - if an error occurs.
    +
  + + + +
  - +
    getPersistIdRef
    +
```
public long getPersistIdRef()
```
    +
  + + + +
  - +
    setPersistIdRef
    +
```
public void setPersistIdRef(long persistIdRef)
```
    +
  + + + +
  - +
    isHasMacros
    +
```
public boolean isHasMacros()
```
    +
  + + + +
  - +
    setHasMacros
    +
```
public void setHasMacros(boolean hasMacros)
```
    +
  + + + +
  - +
    getVersion
    +
```
public long getVersion()
```
    +
  + + + +
  - +
    setVersion
    +
```
public void setVersion(long version)
```
    +
  +
+

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

Class DocInfoListContainer

Field Summary

Fields inherited from class org.apache.poi.hslf.record.RecordContainer

Fields inherited from class org.apache.poi.hslf.record.Record

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.hslf.record.RecordContainer

Methods inherited from class org.apache.poi.hslf.record.Record

Methods inherited from class java.lang.Object

Constructor Detail

DocInfoListContainer

Method Detail

getRecordType

writeOut

getRecordInstance

Class VBAInfoAtom

Field Summary

Fields inherited from class org.apache.poi.hslf.record.Record

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.hslf.record.RecordAtom

Methods inherited from class org.apache.poi.hslf.record.Record

Methods inherited from class java.lang.Object

Constructor Detail

VBAInfoAtom

Method Detail

getRecordType

writeOut

getPersistIdRef

setPersistIdRef

isHasMacros

setHasMacros

getVersion

setVersion