com.hcl.domino.richtext.records

Interface CDHotspotBegin

All Superinterfaces:

MemoryStructure, ResizableMemoryStructure, RichTextRecord<WSIG>

public interface CDHotspotBegin
extends RichTextRecord<WSIG>

Since:

1.0.2

Author:

Jesse Gallagher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CDHotspotBegin.Flag
static class	CDHotspotBegin.Type

Method Summary

Modifier and Type	Method and Description
int	getDataLength()
default String	getDisplayFileName()
Set<CDHotspotBegin.Flag>	getFlags()
WSIG	getHeader()
CDHotspotBegin.Type	getHotspotType()
default String	getSubformValue() Retrieves the subform name or formula for a SUBFORM-type hotspot.
default String	getUniqueFileName()
CDHotspotBegin	setDataLength(int dataLength)
default CDHotspotBegin	setFileNames(String uniqueFileName, String displayFileName) Sets the variable data portion of this structure to the provided string values.
default CDHotspotBegin	setFileNamesRaw(byte[] uniqueFileName, byte[] displayFileName, boolean appendNulls) Sets the variable data portion of this structure to the provided LMBCS-encoded string values.
CDHotspotBegin	setFlags(Collection<CDHotspotBegin.Flag> flags)
CDHotspotBegin	setHotspotType(CDHotspotBegin.Type type)

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>

getHotspotType

CDHotspotBegin.Type getHotspotType()

setHotspotType

CDHotspotBegin setHotspotType(CDHotspotBegin.Type type)

getFlags

Set<CDHotspotBegin.Flag> getFlags()

setFlags

CDHotspotBegin setFlags(Collection<CDHotspotBegin.Flag> flags)

getDataLength

int getDataLength()

setDataLength

CDHotspotBegin setDataLength(int dataLength)

setFileNames

default CDHotspotBegin setFileNames(String uniqueFileName,
                                    String displayFileName)

Sets the variable data portion of this structure to the provided string values. The structure must have been allocated with enough space to hold the LMBCS-encoded versions of both names and null terminators for each.

This is for use when the hotspot type is CDHotspotBegin.Type.FILE.

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

Parameters:

uniqueFileName - the internal unique name of the file attachment

displayFileName - the display name of the file attachment

appendNulls - whether this method should append null bytes after each name

Returns:

this record

setFileNamesRaw

default CDHotspotBegin setFileNamesRaw(byte[] uniqueFileName,
                                       byte[] displayFileName,
                                       boolean appendNulls)

Sets the variable data portion of this structure to the provided LMBCS-encoded string values. The structure must have been allocated with enough space to hold both and, if specified, the added null values.

This is for use when the hotspot type is CDHotspotBegin.Type.FILE.

Parameters:

uniqueFileName - the internal unique name of the file attachment

displayFileName - the display name of the file attachment

appendNulls - whether this method should append null bytes after each name

Returns:

this record

getUniqueFileName

default String getUniqueFileName()

getDisplayFileName

default String getDisplayFileName()

getSubformValue

default String getSubformValue()

Retrieves the subform name or formula for a SUBFORM-type hotspot.

Returns:

a string name or formula

Throws:

IllegalStateException - if the type is not CDHotspotBegin.Type.SUBFORM