com.hcl.domino.richtext.records

Interface RichTextRecord<T extends CDSignature>

Type Parameters:

T - the signature type of this record

All Superinterfaces:

MemoryStructure, ResizableMemoryStructure

All Known Subinterfaces:

CDAction, CDActionBar, CDActionBarExt, CDActionByForm, CDActionDBCopy, CDActionDelete, CDActionFolder, CDActionFormula, CDActionHeader, CDActionJavaAgent, CDActionLotusScript, CDActionModifyField, CDActionNewsletter, CDActionReadMarks, CDActionReply, CDActionRunAgent, CDActionSendDocument, CDActionSendMail, CDBegin, CDBlobPart, CDCaption, CDColor, CDDataFlags, CDDDEBegin, CDEmbeddedControl, CDEnd, CDEvent, CDExt2Field, CDExtField, CDField, CDFieldHint, CDFileHeader, CDFileSegment, CDGraphic, CDHotspotBegin, CDHotspotEnd, CDIDName, CDImageHeader, CDImageHeader2, CDImageSegment, CDKeyword, CDParagraph, CDText

public interface RichTextRecord<T extends CDSignature>
extends ResizableMemoryStructure

Base interface for rich text records. We provide sub interfaces for selected record types with extended functionality.

Method Summary

Modifier and Type	Method and Description
default int	getCDRecordLength() Returns the total length of the CD record including the signature bytes containing the type and length
ByteBuffer	getData() Returns the raw CD record data including the header signature (containing the type and length of the record)
default ByteBuffer	getDataWithoutHeader() Returns the raw CD record data without the header signature (containing the type and length of the record)
T	getHeader()
default int	getPayloadLength() Returns the size of the CD record payload (the data without the record header bytes)
default int	getRecordHeaderLength() Returns the length of the signature bytes containing the record type and total lengths at the beginning of getData()
default Set<RecordType>	getType() Returns the type of the record, if known.
default short	getTypeValue() Returns a numeric type constant for the record

Methods inherited from interface com.hcl.domino.richtext.structures.ResizableMemoryStructure

getVariableData, resize, resizeVariableData

Method Detail

getHeader

T getHeader()

getTypeValue

default short getTypeValue()

Returns a numeric type constant for the record

Returns:

type

getType

default Set<RecordType> getType()

Returns the type of the record, if known.

Returns:

a set of RecordType values that have the value getTypeValue() (there may be duplicates like PABHIDE/VMTEXTBOX or ACTION/VMPOLYRGN)

getDataWithoutHeader

default ByteBuffer getDataWithoutHeader()

Returns the raw CD record data without the header signature (containing the type and length of the record)

Returns:

data without header

getData

ByteBuffer getData()

Returns the raw CD record data including the header signature (containing the type and length of the record)

Specified by:

getData in interface MemoryStructure

Returns:

data with header

getPayloadLength

default int getPayloadLength()

Returns the size of the CD record payload (the data without the record header bytes)

Returns:

payload length

getCDRecordLength

default int getCDRecordLength()

Returns the total length of the CD record including the signature bytes containing the type and length

Returns:

length

getRecordHeaderLength

default int getRecordHeaderLength()

Returns the length of the signature bytes containing the record type and total lengths at the beginning of getData()

Returns:

signature length