Package com.atlassian.confluence.content.render.xhtml

Enum ConversionContextOutputType

java.lang.Object

java.lang.Enum<ConversionContextOutputType>

com.atlassian.confluence.content.render.xhtml.ConversionContextOutputType

All Implemented Interfaces:

Serializable, Comparable<ConversionContextOutputType>

public enum ConversionContextOutputType
extends Enum<ConversionContextOutputType>

XHTML Successor to RenderContextOutputType. This contains a superset of the constants in that class. The original String values are available at value().

Enum Constant Summary

Enum Constants

Enum Constant	Description
DIFF	Used when rendering is occurring in a diff, such as one within a notification.
DISPLAY	Used when rendering is occurring in display mode, such as when viewing a Confluence page.
EMAIL	Used when rendering is occurring in a notification, such as one received via email by "Watch"ing a Confluence page
FEED	Used when rendering is occurring in a feed, such as from using Confluence's built-in RSS feeds
HTML_EXPORT	Used when rendering is occurring in an HTML export, such as from using Confluence's export space mechanism
PDF	Used when rendering is occurring in a PDF document, such as from using Confluence's "Export to PDF" option
PREVIEW	Used when rendering is occurring in preview mode, such as on the preview tab when editing a Confluence page
WORD	Used when rendering is occurring in a Word document, such as from using Confluence's "Edit in Word" option

Method Summary

Modifier and Type	Method	Description
String	value()
static ConversionContextOutputType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ConversionContextOutputType[]	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

PREVIEW

public static final ConversionContextOutputType PREVIEW

Used when rendering is occurring in preview mode, such as on the preview tab when editing a Confluence page

DISPLAY

public static final ConversionContextOutputType DISPLAY

Used when rendering is occurring in display mode, such as when viewing a Confluence page. This is the default type.

WORD

public static final ConversionContextOutputType WORD

Used when rendering is occurring in a Word document, such as from using Confluence's "Edit in Word" option

PDF

public static final ConversionContextOutputType PDF

Used when rendering is occurring in a PDF document, such as from using Confluence's "Export to PDF" option

HTML_EXPORT

public static final ConversionContextOutputType HTML_EXPORT

Used when rendering is occurring in an HTML export, such as from using Confluence's export space mechanism

FEED

public static final ConversionContextOutputType FEED

Used when rendering is occurring in a feed, such as from using Confluence's built-in RSS feeds

EMAIL

public static final ConversionContextOutputType EMAIL

Used when rendering is occurring in a notification, such as one received via email by "Watch"ing a Confluence page

DIFF

public static final ConversionContextOutputType DIFF

Used when rendering is occurring in a diff, such as one within a notification. Diffs are cached, so it is vital that in this context content be rendered the same for all users who can see the page, regardless of other permissions.

Method Detail

values

public static ConversionContextOutputType[] 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 (ConversionContextOutputType c : ConversionContextOutputType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ConversionContextOutputType 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

value

public String value()