Package ro.sync.ecss.dita

Enum Class DITAImposedReferenceType

java.lang.Object

java.lang.Enum<DITAImposedReferenceType>

ro.sync.ecss.dita.DITAImposedReferenceType

All Implemented Interfaces:

Serializable, Comparable<DITAImposedReferenceType>, Constable

@API(type=NOT_EXTENDABLE,
     src=PRIVATE)
public enum DITAImposedReferenceType
extends Enum<DITAImposedReferenceType>

Specifies how a reference should be inserted in a document: xref, figure, variable, etc

Since:

25.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIGURE	fig with title and image
MEDIA	media reference: images, audio, video, youtube, html documents
NOT_IMPOSED	Let someone else (usually the schema aware) decide what's better.
VARIABLE	ph with keyref
XREF	xref with href/keyref (common case)

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MEDIA

public static final DITAImposedReferenceType MEDIA

media reference: images, audio, video, youtube, html documents

XREF

public static final DITAImposedReferenceType XREF

xref with href/keyref (common case)

FIGURE

public static final DITAImposedReferenceType FIGURE

fig with title and image

VARIABLE

public static final DITAImposedReferenceType VARIABLE

ph with keyref

NOT_IMPOSED

public static final DITAImposedReferenceType NOT_IMPOSED

Let someone else (usually the schema aware) decide what's better.
This is usually associated with drag'n drop or double click actions

Method Details

values

public static DITAImposedReferenceType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DITAImposedReferenceType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null