com.hcl.domino.richtext.records

Interface CDCaption

All Superinterfaces:

MemoryStructure, ResizableMemoryStructure, RichTextRecord<WSIG>

public interface CDCaption
extends RichTextRecord<WSIG>

Since:

1.0.15

Author:

Jesse Gallagher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CDCaption.Position

Method Summary

Modifier and Type	Method and Description
ColorValue	getFontColor()
FontStyle	getFontID()
WSIG	getHeader()
int	getLength()
CDCaption.Position	getPosition()
default CDCaption	setCaptionText(String captionText) Stores the text for this caption in the variable data portion of this record.
CDCaption	setLength(int length)
CDCaption	setPosition(CDCaption.Position position)

Methods inherited from interface com.hcl.domino.richtext.records.RichTextRecord

getCDRecordLength, getData, getDataWithoutHeader, getPayloadLength, getRecordHeaderLength, getType, getTypeValue

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

getVariableData, resize, resizeVariableData

Method Detail

getHeader

WSIG getHeader()

Specified by:

getHeader in interface RichTextRecord<WSIG>

getLength

int getLength()

setLength

CDCaption setLength(int length)

getPosition

CDCaption.Position getPosition()

setPosition

CDCaption setPosition(CDCaption.Position position)

getFontID

FontStyle getFontID()

getFontColor

ColorValue getFontColor()

setCaptionText

default CDCaption setCaptionText(String captionText)

Stores the text for this caption in the variable data portion of this record.

The buffer will be resized, if necessary, to hold the text value.

This method also sets the wLength property to the appropriate value.

Parameters:

captionText - the caption text to set

Returns:

this record