com.hcl.domino.richtext.records

Interface CDEmbeddedControl

All Superinterfaces:

MemoryStructure, ResizableMemoryStructure, RichTextRecord<WSIG>

public interface CDEmbeddedControl
extends RichTextRecord<WSIG>

Since:

1.0.24

Author:

Jesse Gallagher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CDEmbeddedControl.Flag
static class	CDEmbeddedControl.Style
static class	CDEmbeddedControl.Type
static class	CDEmbeddedControl.Version

Method Summary

Modifier and Type	Method and Description
CDEmbeddedControl.Type	getControlType()
Set<CDEmbeddedControl.Flag>	getFlags()
WSIG	getHeader()
int	getHeight()
int	getMaxChars()
int	getPercentage()
Set<CDEmbeddedControl.Style>	getStyle() Retrieves potential styles for this control.
CDEmbeddedControl.Version	getVersion()
int	getWidth()
CDEmbeddedControl	setControlType(CDEmbeddedControl.Type type)
CDEmbeddedControl	setFlags(Set<CDEmbeddedControl.Flag> flags)
CDEmbeddedControl	setHeight(int height)
CDEmbeddedControl	setMaxChars(int chars)
CDEmbeddedControl	setPercentage(int percentage)
CDEmbeddedControl	setStyle(CDEmbeddedControl.Style style)
CDEmbeddedControl	setVersion(CDEmbeddedControl.Version version)
CDEmbeddedControl	setWidth(int width)

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>

getStyle

Set<CDEmbeddedControl.Style> getStyle()

Retrieves potential styles for this control. Due to the way this information is stored, multiple CDEmbeddedControl.Style values may match a given value, and which is in effect is based on the type of control.

Returns:

a Set of matching styles

setStyle

CDEmbeddedControl setStyle(CDEmbeddedControl.Style style)

getFlags

Set<CDEmbeddedControl.Flag> getFlags()

setFlags

CDEmbeddedControl setFlags(Set<CDEmbeddedControl.Flag> flags)

getWidth

int getWidth()

setWidth

CDEmbeddedControl setWidth(int width)

getHeight

int getHeight()

setHeight

CDEmbeddedControl setHeight(int height)

getVersion

CDEmbeddedControl.Version getVersion()

setVersion

CDEmbeddedControl setVersion(CDEmbeddedControl.Version version)

getControlType

CDEmbeddedControl.Type getControlType()

setControlType

CDEmbeddedControl setControlType(CDEmbeddedControl.Type type)

getMaxChars

int getMaxChars()

setMaxChars

CDEmbeddedControl setMaxChars(int chars)

getPercentage

int getPercentage()

setPercentage

CDEmbeddedControl setPercentage(int percentage)