HemfCommentRecord (POI API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.hemf.record
Class HemfCommentRecord

java.lang.Object
  org.apache.poi.hemf.record.HemfCommentRecord

All Implemented Interfaces:: HemfRecord

@Internal public class HemfCommentRecord
extends java.lang.Object
implements HemfRecord
extends java.lang.Object
implements HemfRecord

This is the outer comment record that is recognized by the initial parse by HemfRecordType.comment. However, there are four types of comment: EMR_COMMENT, EMR_COMMENT_EMFPLUS, EMR_COMMENT_EMFSPOOL, and EMF_COMMENT_PUBLIC. To get the underlying comment, call getComment().

Field Summary
`static long`	`COMMENT_EMFPLUS`
`static long`	`COMMENT_EMFSPOOL`
`static long`	`COMMENT_PUBLIC`

Constructor Summary
`HemfCommentRecord()`

Method Summary
`AbstractHemfComment`	`getComment()`
`HemfRecordType`	`getRecordType()`
`long`	`init(LittleEndianInputStream leis, long recordId, long recordSize)` Init record from stream

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

Field Detail

COMMENT_EMFSPOOL

public static final long COMMENT_EMFSPOOL

See Also:: Constant Field Values

COMMENT_EMFPLUS

public static final long COMMENT_EMFPLUS

See Also:: Constant Field Values

COMMENT_PUBLIC

public static final long COMMENT_PUBLIC

See Also:: Constant Field Values

Constructor Detail

HemfCommentRecord

public HemfCommentRecord()

Method Detail

getRecordType

public HemfRecordType getRecordType()

Specified by:: getRecordType in interface HemfRecord

init

public long init(LittleEndianInputStream leis,
                 long recordId,
                 long recordSize)
          throws java.io.IOException

Description copied from interface: HemfRecord

Init record from stream

Specified by:: init in interface HemfRecord

Parameters:: leis - the little endian input stream
Returns:: count of processed bytes
Throws:: java.io.IOException

getComment

public AbstractHemfComment getComment()