HtmlConvertOption (HCL Domino API 1.0.27-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<HtmlConvertOption>
- - com.hcl.domino.html.HtmlConvertOption

All Implemented Interfaces:

Serializable, Comparable<HtmlConvertOption>
```
public enum HtmlConvertOption
extends Enum<HtmlConvertOption>
```
An enum with existing HTML conversion options to be set via RichTextHTMLConverter.Builder.option(HtmlConvertOption, String).

Please note that we provide an additional option method to set further undocumented options via RichTextHTMLConverter.Builder.options(Collection, String).

See these blog articles to get an idea what can be done with these options:
What if.....we didn’t use tags in our HTML output anymore?
Domino HTML generation and FontConversion=1

Possible values for the "spec" and "tag" attributes to control HTML output (e.g. FontSizeSpec):
- 0 (none) - do not generate anything for the spec
- 1 (native) - use the default HTML generation for the spec
- 2 (outer span tag with style attribute) - surround any native tag with a tag that specifies a style attribute, e.g. ........
- 4 (inner font tag with style attribute) - use a tag with a style attribute inside any native tag, e.g. == ........
- 8 (native tag with style attribute - only applicable if there is a native tag) - use the native tag with a style attribute, e.g. <tt style="font-family: monospace">........</tt>
- 16 (outer span tag with class attribute) - surround any native tag with a tag that specifies a class attribute, e.g. ........
- 32 (native tag with class attribute - only applicable if there is a native tag) - use the native tag with a class attribute, e.g. <tt class="domino-font-monospace">........</tt>

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACFOnItem` run the ActiveContentfilter on open item (useful for HAPI)
`AttachmentLink` CD->HTML attachments don't have <a><img>, just text saying "see attachment..."
`AutoClass` automatically add class names.
`AutoClassField` add classes to field names - experimental
`DisablePassThruHTML` Disables passthru HTML, treating the HTML as plain text.
`FieldChoiceLabel` generate <label> around input tags for checkboxes and radio buttons
`FieldKeywordTrim` flags (see below) to control trimming of keyword values on fields
`FieldName` add field name as inner span
`FontColorSpec`
`FontConversion` FontConversion - the master option 0 (classic) - the original web server handling 1 (style) - use combinations of span and other new tags, as controlled by the remaining options.
`FontFaceMonospaceSpec`
`FontFaceMonospaceTag`
`FontFaceSansserifSpec`
`FontFaceSerifSpec`
`FontFaceSpecificSpec`
`FontSizeBase`
`FontSizeSpec`
`FontStyleBoldSpec`
`FontStyleBoldTag`
`FontStyleItalicSpec`
`FontStyleItalicTag`
`FontStyleStrikethroughSpec`
`FontStyleStrikethroughTag`
`FontStyleUnderlineSpec`
`FontStyleUnderlineTag`
`ForceOutlineExpand` Forces all outlines to be expanded, regardless of their expansion in the Notes rich text.
`ForceRedirectURL` Force using redirect URLs regardless of NAB setting.
`ForceSectionExpand` Forces all sections to be expanded, regardless of their expansion in the Notes® rich text fields.
`LinkArg` Add bits of the link object to the link url.
`LinkHandling` html option version of the HAPI property
`LinkHTMLAlt` alternate html for links
`ListFidelity` enable new code for better representation of indented lists
`MIMEAttachmentLink` similar to AttachmentLink, but for when the Item is type MIME separate option just to not interfere with already released behavior of the other option. This option only has effect if the internal logic of the mime processor would have otherwise produced attachment links. For example, explicitly setting this to 0 will NOT cause attachment links to appear if the internal logic has determined that attachment links will not appear.
`MIMEItemFrame`
`MultiEmbeddedHTMLView` allow multiple embedded view if: 1) page is in raw mode; 2) view is marked render as html
`OfferNotesURLInLink` include a notes:// url when generating doclink urls
`ParagraphIndent` 0 will use <ul> for indenting, 1 will use <div>
`RenderHighlight` for FontConverstion = 0, render the notes highlight text
`RowAtATimeTableAlt` Forces alternate formatting of tables with tabbed sections. All of the tabs are displayed at the same time, one below the other, with the tab labels included as headers.
`SectionAlt` alternate Section representation (no dynamics)
`TableCaptionFromTitle` use the TITLE attribute of the TABLE as the <caption>
`TableStyle` alternate reps for table style ; 1 = dropm ec blank
`TextConvertTabsToSpaces` If set, converts tabs to the number of spaces specified.
`TextExactSpacing` Preserves Notes intraline whitespace (spaces between characters).
`Themes` use xpages style theme files (reduced features from xpages)
`XMLCompatibleHTML` Enable XML-compatible HTML output

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Set<HtmlConvertOption>`	`allSpecs()` Returns all "spec" options, e.g.
`static Set<HtmlConvertOption>`	`allTags()` Returns all "tag" options, e.g.
`String`	`toOption(String value)` Converts this enumerated option to a string value suitable for passing to an HTML converter.
`static String[]`	`toStringArray(Collection<HtmlConvertOption> options)`
`static HtmlConvertOption`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static HtmlConvertOption[]`	`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
 - ForceSectionExpand
```
public static final HtmlConvertOption ForceSectionExpand
```
 Forces all sections to be expanded, regardless of their expansion in the Notes® rich text fields.
 - RowAtATimeTableAlt
```
public static final HtmlConvertOption RowAtATimeTableAlt
```
 Forces alternate formatting of tables with tabbed sections.
 All of the tabs are displayed at the same time, one below the other, with the tab labels included as headers.
 - ForceOutlineExpand
```
public static final HtmlConvertOption ForceOutlineExpand
```
 Forces all outlines to be expanded, regardless of their expansion in the Notes rich text.
 - DisablePassThruHTML
```
public static final HtmlConvertOption DisablePassThruHTML
```
 Disables passthru HTML, treating the HTML as plain text.
 - TextExactSpacing
```
public static final HtmlConvertOption TextExactSpacing
```
 Preserves Notes intraline whitespace (spaces between characters).
 - ListFidelity
```
public static final HtmlConvertOption ListFidelity
```
 enable new code for better representation of indented lists
 - MultiEmbeddedHTMLView
```
public static final HtmlConvertOption MultiEmbeddedHTMLView
```
 allow multiple embedded view if: 1) page is in raw mode; 2) view is marked render as html
 - TextConvertTabsToSpaces
```
public static final HtmlConvertOption TextConvertTabsToSpaces
```
 If set, converts tabs to the number of spaces specified.
 - ACFOnItem
```
public static final HtmlConvertOption ACFOnItem
```
 run the ActiveContentfilter on open item (useful for HAPI)
 - AutoClass
```
public static final HtmlConvertOption AutoClass
```
 automatically add class names.
 - AutoClassField
```
public static final HtmlConvertOption AutoClassField
```
 add classes to field names - experimental
 - FieldName
```
public static final HtmlConvertOption FieldName
```
 add field name as inner span
 - Themes
```
public static final HtmlConvertOption Themes
```
 use xpages style theme files (reduced features from xpages)
 - FieldChoiceLabel
```
public static final HtmlConvertOption FieldChoiceLabel
```
 generate <label> around input tags for checkboxes and radio buttons
 - TableCaptionFromTitle
```
public static final HtmlConvertOption TableCaptionFromTitle
```
 use the TITLE attribute of the TABLE as the <caption>
 - SectionAlt
```
public static final HtmlConvertOption SectionAlt
```
 alternate Section representation (no dynamics)
 - AttachmentLink
```
public static final HtmlConvertOption AttachmentLink
```
 CD->HTML attachments don't have <a><img>, just text saying "see attachment..."
 - TableStyle
```
public static final HtmlConvertOption TableStyle
```
 alternate reps for table style ; 1 = dropm ec blank
 - OfferNotesURLInLink
```
public static final HtmlConvertOption OfferNotesURLInLink
```
 include a notes:// url when generating doclink urls
 - MIMEAttachmentLink
```
public static final HtmlConvertOption MIMEAttachmentLink
```
 similar to AttachmentLink, but for when the Item is type MIME separate option just to not interfere with already released behavior of the other option.
 This option only has effect if the internal logic of the mime processor would have otherwise produced attachment links.
 For example, explicitly setting this to 0 will NOT cause attachment links to appear if the internal logic has determined that attachment links will not appear.
 - LinkArg
```
public static final HtmlConvertOption LinkArg
```
 Add bits of the link object to the link url.
 - ForceRedirectURL
```
public static final HtmlConvertOption ForceRedirectURL
```
 Force using redirect URLs regardless of NAB setting. This is just to create the URLs not to process them.
 - LinkHandling
```
public static final HtmlConvertOption LinkHandling
```
 html option version of the HAPI property
 - LinkHTMLAlt
```
public static final HtmlConvertOption LinkHTMLAlt
```
 alternate html for links
 - MIMEItemFrame
```
public static final HtmlConvertOption MIMEItemFrame
```
 - RenderHighlight
```
public static final HtmlConvertOption RenderHighlight
```
 for FontConverstion = 0, render the notes highlight text
 - ParagraphIndent
```
public static final HtmlConvertOption ParagraphIndent
```
 0 will use <ul> for indenting, 1 will use <div>
 - FieldKeywordTrim
```
public static final HtmlConvertOption FieldKeywordTrim
```
 flags (see below) to control trimming of keyword values on fields
 - XMLCompatibleHTML
```
public static final HtmlConvertOption XMLCompatibleHTML
```
 Enable XML-compatible HTML output
 - FontConversion
```
public static final HtmlConvertOption FontConversion
```
 FontConversion - the master option
 - 0 (classic) - the original web server handling
 - 1 (style) - use combinations of span and other new tags, as controlled by the remaining options.
 - FontSizeBase
```
public static final HtmlConvertOption FontSizeBase
```
 - FontColorSpec
```
public static final HtmlConvertOption FontColorSpec
```
 - FontFaceSerifSpec
```
public static final HtmlConvertOption FontFaceSerifSpec
```
 - FontFaceSansserifSpec
```
public static final HtmlConvertOption FontFaceSansserifSpec
```
 - FontFaceMonospaceSpec
```
public static final HtmlConvertOption FontFaceMonospaceSpec
```
 - FontFaceSpecificSpec
```
public static final HtmlConvertOption FontFaceSpecificSpec
```
 - FontSizeSpec
```
public static final HtmlConvertOption FontSizeSpec
```
 - FontStyleBoldSpec
```
public static final HtmlConvertOption FontStyleBoldSpec
```
 - FontStyleItalicSpec
```
public static final HtmlConvertOption FontStyleItalicSpec
```
 - FontStyleUnderlineSpec
```
public static final HtmlConvertOption FontStyleUnderlineSpec
```
 - FontStyleStrikethroughSpec
```
public static final HtmlConvertOption FontStyleStrikethroughSpec
```
 - FontFaceMonospaceTag
```
public static final HtmlConvertOption FontFaceMonospaceTag
```
 - FontStyleBoldTag
```
public static final HtmlConvertOption FontStyleBoldTag
```
 - FontStyleItalicTag
```
public static final HtmlConvertOption FontStyleItalicTag
```
 - FontStyleUnderlineTag
```
public static final HtmlConvertOption FontStyleUnderlineTag
```
 - FontStyleStrikethroughTag
```
public static final HtmlConvertOption FontStyleStrikethroughTag
```
- Method Detail
 - values
```
public static HtmlConvertOption[] 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 (HtmlConvertOption c : HtmlConvertOption.values())
  System.out.println(c);
```
 Returns:
 
 an array containing the constants of this enum type, in the order they are declared
 - valueOf
```
public static HtmlConvertOption 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
 - allSpecs
```
public static Set<HtmlConvertOption> allSpecs()
```
 Returns all "spec" options, e.g. FontColorSpec
 
 Returns:
 
 spec options
 - allTags
```
public static Set<HtmlConvertOption> allTags()
```
 Returns all "tag" options, e.g. FontStyleBoldTag
 
 Returns:
 
 tag options
 - toStringArray
```
public static String[] toStringArray(Collection<HtmlConvertOption> options)
```
 - toOption
```
public String toOption(String value)
```
 Converts this enumerated option to a string value suitable for passing to an HTML converter.
 
 Parameters:
 
 value - the value of the option. This is usually "1".
 
 Returns:
 
 a string version of this option with the provided value
 
 Since:
 
 1.0.3

Enum HtmlConvertOption

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ForceSectionExpand

RowAtATimeTableAlt

ForceOutlineExpand

DisablePassThruHTML

TextExactSpacing

ListFidelity

MultiEmbeddedHTMLView

TextConvertTabsToSpaces

ACFOnItem

AutoClass

AutoClassField

FieldName

Themes

FieldChoiceLabel

TableCaptionFromTitle

SectionAlt

AttachmentLink

TableStyle

OfferNotesURLInLink

MIMEAttachmentLink

LinkArg

ForceRedirectURL

LinkHandling

LinkHTMLAlt

MIMEItemFrame

RenderHighlight

ParagraphIndent

FieldKeywordTrim

XMLCompatibleHTML

FontConversion

FontSizeBase

FontColorSpec

FontFaceSerifSpec

FontFaceSansserifSpec

FontFaceMonospaceSpec

FontFaceSpecificSpec

FontSizeSpec

FontStyleBoldSpec

FontStyleItalicSpec

FontStyleUnderlineSpec

FontStyleStrikethroughSpec

FontFaceMonospaceTag

FontStyleBoldTag

FontStyleItalicTag

FontStyleUnderlineTag

FontStyleStrikethroughTag

Method Detail

values

valueOf

allSpecs

allTags

toStringArray

toOption