com.hcl.domino.richtext

Enum RichTextWriter.CaptionPosition

java.lang.Object

java.lang.Enum<RichTextWriter.CaptionPosition>

com.hcl.domino.richtext.RichTextWriter.CaptionPosition

All Implemented Interfaces:

Serializable, Comparable<RichTextWriter.CaptionPosition>

Enclosing interface:

RichTextWriter

public static enum RichTextWriter.CaptionPosition
extends Enum<RichTextWriter.CaptionPosition>

Enum of available positions to place the caption of a file hotspot

Author:

Karsten Lehmann

Enum Constant Summary

Enum Constants

Enum Constant and Description
BELOWCENTER
MIDDLECENTER

Method Summary

Modifier and Type	Method and Description
static RichTextWriter.CaptionPosition	valueOf(String name) Returns the enum constant of this type with the specified name.
static RichTextWriter.CaptionPosition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BELOWCENTER

public static final RichTextWriter.CaptionPosition BELOWCENTER

MIDDLECENTER

public static final RichTextWriter.CaptionPosition MIDDLECENTER

Method Detail

values

public static RichTextWriter.CaptionPosition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RichTextWriter.CaptionPosition c : RichTextWriter.CaptionPosition.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RichTextWriter.CaptionPosition valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null