Index (Remark 2023-07.07 API)

A B C D E F G H I L M N O P R S T U V W
All Classes All Packages

A

Abbr - Class in com.overzealous.remark.convert: Handles abbr and acronym tags
Abbr() - Constructor for class com.overzealous.remark.convert.Abbr
abbreviations - Variable in class com.overzealous.remark.Options: If true, enable remarking abbreviations.
AbstractNodeHandler - Class in com.overzealous.remark.convert: Contains basic implementations for handling text nodes and ignored HTML elements.
AbstractNodeHandler() - Constructor for class com.overzealous.remark.convert.AbstractNodeHandler
ADD_SPACES - com.overzealous.remark.Options.InWordEmphasis: Adds spaces around the in-word emphasis characters.
addAttribute(String) - Method in class com.overzealous.remark.IgnoredHtmlElement: Adds a single to the list of allowed attributes.
addAttributes(String...) - Method in class com.overzealous.remark.IgnoredHtmlElement: Adds one or more attributes to the list of allowed attributes.
addBlockNode(NodeHandler, String) - Method in class com.overzealous.remark.convert.DocumentConverter: Customize the processing for a node.
addBodyRow() - Method in class com.overzealous.remark.util.MarkdownTable: Creates a new body row, and returns it so it can have cells added to it.
addHeaderRow() - Method in class com.overzealous.remark.util.MarkdownTable: Creates a new header row, and returns it so it can have cells added to it.
addInlineNode(NodeHandler, String) - Method in class com.overzealous.remark.convert.DocumentConverter: Customize the processing for a node.
addLink(String, String, boolean) - Method in class com.overzealous.remark.convert.DocumentConverter: Adds a link to the link set, and returns the actual ID for the link.
align(PrintWriter, String, int, char, int) - Static method in class com.overzealous.remark.util.StringUtils: Pads out a left-, right-, or center-aligned string using the specified character up to the specified width.
align(PrintWriter, String, int, int) - Static method in class com.overzealous.remark.util.StringUtils: Pads out a left-, right-, or center-aligned string using spaces up to the specified width.
align(String, int, char, int) - Static method in class com.overzealous.remark.util.StringUtils: Pads out a left-, right-, or center-aligned string using the specified character up to the specified width.
align(String, int, int) - Static method in class com.overzealous.remark.util.StringUtils: Pads out a left-, right-, or center-aligned string using spaces up to the specified width.
ALIGN_CENTER - Static variable in class com.overzealous.remark.util.StringUtils: Represents centered alignment.
ALIGN_LEFT - Static variable in class com.overzealous.remark.util.StringUtils: Represents left alignment.
ALIGN_RIGHT - Static variable in class com.overzealous.remark.util.StringUtils: Represents right alignment.
Anchor - Class in com.overzealous.remark.convert: Handles anchor (a) tags, both links and named anchors.
Anchor() - Constructor for class com.overzealous.remark.convert.Anchor
autoLinks - Variable in class com.overzealous.remark.Options: If true, enable autoLinks.

B

BlockQuote - Class in com.overzealous.remark.convert: Handles blockquote tags
BlockQuote() - Constructor for class com.overzealous.remark.convert.BlockQuote
BlockWriter - Class in com.overzealous.remark.util: This is a customized subclass of BufferedWriter that handles working with Markdown block-level elements.
BlockWriter(OutputStream) - Constructor for class com.overzealous.remark.util.BlockWriter
BlockWriter(OutputStream, boolean) - Constructor for class com.overzealous.remark.util.BlockWriter
BlockWriter(Writer) - Constructor for class com.overzealous.remark.util.BlockWriter
BlockWriter(Writer, boolean) - Constructor for class com.overzealous.remark.util.BlockWriter
Break - Class in com.overzealous.remark.convert: Handles manual breaks (br)
Break() - Constructor for class com.overzealous.remark.convert.Break

C

CENTER - com.overzealous.remark.util.MarkdownTable.Alignment
clean(Object) - Method in class com.overzealous.remark.convert.TextCleaner: Clean the given input text based on the original configuration Options.
cleanCode(Object) - Method in class com.overzealous.remark.convert.TextCleaner: Clean the given input text based on the original configuration Options.
cleanInlineCode(Object) - Method in class com.overzealous.remark.convert.TextCleaner: Method to clean inline code, and, if necessary, add spaces to make sure that internal, leading, or trailing '`' characters don't break the inline code.
cleanUrl(String) - Method in class com.overzealous.remark.convert.TextCleaner: Handles escaping special characters in URLs to avoid issues when they are rendered out (ie: spaces, parentheses)
Codeblock - Class in com.overzealous.remark.convert: Handles preformatted sections (pre), renders them as code blocks.
Codeblock() - Constructor for class com.overzealous.remark.convert.Codeblock
com.overzealous.remark - package com.overzealous.remark: The root package for the OverZealous Creations, LLC, Remark library.
com.overzealous.remark.convert - package com.overzealous.remark.convert: This package contains the classes that walk the Jsoup document and processConvert it into Markdown code.
com.overzealous.remark.util - package com.overzealous.remark.util: This package contains utility classes that assist the main parser in rendering Markdown output.
convert(File) - Method in class com.overzealous.remark.Remark: Converts an HTML file to Markdown.
convert(File, String) - Method in class com.overzealous.remark.Remark: Converts an HTML file to Markdown.
convert(File, String, String) - Method in class com.overzealous.remark.Remark: Converts an HTML file to Markdown.
convert(String) - Method in class com.overzealous.remark.Remark: Converts HTML in memory to Markdown.
convert(String, String) - Method in class com.overzealous.remark.Remark: Converts HTML in memory to Markdown.
convert(URL, int) - Method in class com.overzealous.remark.Remark: Converts an HTML document retrieved from a URL to Markdown.
convert(Document) - Method in class com.overzealous.remark.convert.DocumentConverter: Convert a document and return a string.
convert(Document) - Method in class com.overzealous.remark.Remark: Converts an already-loaded JSoup Document to Markdown.
convert(Document, OutputStream) - Method in class com.overzealous.remark.convert.DocumentConverter: Convert a document to the given output stream.
convert(Document, Writer) - Method in class com.overzealous.remark.convert.DocumentConverter: Convert a document to the given writer.
CONVERT_TO_CODE_BLOCK - com.overzealous.remark.Options.Tables: Convert tables to clean code block (compatible with the original Markdown)
convertFragment(String) - Method in class com.overzealous.remark.Remark: Converts an HTML body fragment to Markdown.
convertFragment(String, String) - Method in class com.overzealous.remark.Remark: Converts an HTML body fragment to Markdown.
create() - Static method in class com.overzealous.remark.util.BlockWriter: Creates a new, empty BlockWriter with a StringWriter as the buffer.
create(int) - Static method in class com.overzealous.remark.util.BlockWriter: Creates a new, empty BlockWriter with a StringWriter as the buffer.
create(String, String...) - Static method in class com.overzealous.remark.IgnoredHtmlElement: Utility method to quickly create a new element.

D

DefaultNodeHandler - Class in com.overzealous.remark.convert: Default handler for unknown top-level nodes.
DefaultNodeHandler() - Constructor for class com.overzealous.remark.convert.DefaultNodeHandler
definitionLists - Variable in class com.overzealous.remark.Options: If true, enable remarking definitions lists.
Definitions - Class in com.overzealous.remark.convert: Handles dl, dt, and dd elements
Definitions() - Constructor for class com.overzealous.remark.convert.Definitions
DISABLED - com.overzealous.remark.Options.FencedCodeBlocks: Completely disables fenced code blocks.
DocumentConverter - Class in com.overzealous.remark.convert: The class that does the heavy lifting for converting a JSoup Document into valid Markdown
DocumentConverter(Options) - Constructor for class com.overzealous.remark.convert.DocumentConverter: Creates a DocumentConverted with the given options.

E

ENABLED_BACKTICK - com.overzealous.remark.Options.FencedCodeBlocks: Enables fenced code blocks, using multiple '`' as the separator characters.
ENABLED_TILDE - com.overzealous.remark.Options.FencedCodeBlocks: Enables fenced code blocks, using multiple '~' as the separator characters.
endBlock() - Method in class com.overzealous.remark.util.BlockWriter: Ends a block.
equals(Object) - Method in class com.overzealous.remark.IgnoredHtmlElement
equals(Object) - Method in class com.overzealous.remark.util.MarkdownTableCell

F

fencedCodeBlocks - Variable in class com.overzealous.remark.Options: Configures how to handle code blocks.
fencedCodeBlocksWidth - Variable in class com.overzealous.remark.Options: Number of times to repeat the fencedCodeBlock character.
find(int) - Static method in enum com.overzealous.remark.util.MarkdownTable.Alignment
fixPegdownStrongEmphasisInLinks - Variable in class com.overzealous.remark.Options: This is a very specific fix for a very specific bug.

G

getAlignment() - Method in class com.overzealous.remark.util.MarkdownTableCell: Gets the text-alignment of this cell
getAttributes() - Method in class com.overzealous.remark.IgnoredHtmlElement: Gets all the attributes that should be left on this tag.
getBlockDepth() - Method in class com.overzealous.remark.util.BlockWriter: Returns how deep the number of blocks is.
getBlockNodes() - Method in class com.overzealous.remark.convert.DocumentConverter
getBuffer() - Method in class com.overzealous.remark.util.BlockWriter: If this object has been created using BlockWriter.create(), returns the StringWriter output buffer.
getCleaner() - Method in class com.overzealous.remark.convert.DocumentConverter
getColspan() - Method in class com.overzealous.remark.util.MarkdownTableCell
getContents() - Method in class com.overzealous.remark.util.MarkdownTableCell
getConverter() - Method in class com.overzealous.remark.Remark: Provides access to the DocumentConverter for customization.
getCopy() - Method in class com.overzealous.remark.Options
getDir() - Method in enum com.overzealous.remark.util.MarkdownTable.Alignment
getFencedCodeBlocks() - Method in class com.overzealous.remark.Options: Always returns a non-null setting for FencedCodeBlocks
getIgnoredHtmlElements() - Method in class com.overzealous.remark.Options: Always returns a non-null setting for IgnoredHtmlElements
getInlineContent(NodeHandler, Element) - Method in class com.overzealous.remark.convert.DocumentConverter: Recursively processes child nodes and returns the potential output string.
getInlineContent(NodeHandler, Element, boolean) - Method in class com.overzealous.remark.convert.DocumentConverter: Recursively processes child nodes and returns the potential output string.
getInlineNodes() - Method in class com.overzealous.remark.convert.DocumentConverter
getInstance() - Static method in class com.overzealous.remark.convert.DefaultNodeHandler
getInstance() - Static method in class com.overzealous.remark.convert.NodeRemover
getInWordEmphasis() - Method in class com.overzealous.remark.Options: Always returns a non-null setting for InWordEmphasis
getNumberOfColumns() - Method in class com.overzealous.remark.util.MarkdownTable: Returns the total number of columns in this table.
getOptions() - Method in class com.overzealous.remark.convert.DocumentConverter
getOutput() - Method in class com.overzealous.remark.convert.DocumentConverter
getPrependNewlineString() - Method in class com.overzealous.remark.util.BlockWriter: Returns the string being prepended to new lines, if set.
getSeparatorCharacter() - Method in enum com.overzealous.remark.Options.FencedCodeBlocks: Returns the separator character to use.
getTables() - Method in class com.overzealous.remark.Options: Always returns a non-null setting for Tables
getTagName() - Method in class com.overzealous.remark.IgnoredHtmlElement: Returns the tagname for this object.
getWidth() - Method in class com.overzealous.remark.util.MarkdownTableCell: Returns the number of characters needed to show this column.
github() - Static method in class com.overzealous.remark.Options: Creates and returns a new Options set with the default options compatible with github-flavored Markdown.

H

handleIgnoredHTMLElement(Element, DocumentConverter) - Method in class com.overzealous.remark.convert.AbstractNodeHandler: Handle an ignored HTMLElement.
handleIgnoredHTMLElement(Element, DocumentConverter) - Method in interface com.overzealous.remark.convert.NodeHandler: Handle an ignored HTMLElement.
handleIgnoredHTMLElement(Element, DocumentConverter) - Method in class com.overzealous.remark.convert.NodeRemover
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.Abbr: Handles abbreviations.
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.Anchor: Creates a link reference, and renders the correct output.
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.BlockQuote: Processes a quoted section.
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.Break: Renders out forced linebreaks.
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.Codeblock: Converts a pre-formatted block of code.
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.DefaultNodeHandler: For the default state element, the nodes are simply ignored, recursing as necessary.
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.Definitions
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.Header: Renders a header node (h1..h6).
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.HorizontalRule
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.Image: Creates a link reference to an image, and renders the correct output.
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.InlineCode: Renders inline-styled code.
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.InlineStyle: Renders inline styling (bold, italics) for the given tag.
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.List
handleNode(NodeHandler, Element, DocumentConverter) - Method in interface com.overzealous.remark.convert.NodeHandler: Handles an HTML Element node.
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.NodeRemover
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.Paragraph: Creates a standard text block, then walks down over inline nodes.
handleNode(NodeHandler, Element, DocumentConverter) - Method in class com.overzealous.remark.convert.Table
handleTextNode(TextNode, DocumentConverter) - Method in class com.overzealous.remark.convert.AbstractNodeHandler: Handle a child text node.
handleTextNode(TextNode, DocumentConverter) - Method in class com.overzealous.remark.convert.InlineStyle
handleTextNode(TextNode, DocumentConverter) - Method in interface com.overzealous.remark.convert.NodeHandler: Handle a child text node.
handleTextNode(TextNode, DocumentConverter) - Method in class com.overzealous.remark.convert.NodeRemover
hardwraps - Variable in class com.overzealous.remark.Options: If true, <br/>s are replaced with a simple linebreak.
hashCode() - Method in class com.overzealous.remark.IgnoredHtmlElement
hashCode() - Method in class com.overzealous.remark.util.MarkdownTableCell
Header - Class in com.overzealous.remark.convert: Handles header nodes (h1 through h6)
Header() - Constructor for class com.overzealous.remark.convert.Header
headerIds - Variable in class com.overzealous.remark.Options: If true, enable remarking header IDs.
HorizontalRule - Class in com.overzealous.remark.convert: Handles a simple hr tag
HorizontalRule() - Constructor for class com.overzealous.remark.convert.HorizontalRule

I

IgnoredHtmlElement - Class in com.overzealous.remark: Provides a standard class to note which HTML elements should be left in the final output.
IgnoredHtmlElement(String) - Constructor for class com.overzealous.remark.IgnoredHtmlElement: Create a new IgnoredHtmlElement.
ignoredHtmlElements - Variable in class com.overzealous.remark.Options: Allows the addition of extra HTML tags that can be left in the output.
Image - Class in com.overzealous.remark.convert: Handles img tags.
Image() - Constructor for class com.overzealous.remark.convert.Image
InlineCode - Class in com.overzealous.remark.convert: Handles inline fixed-width code (code, tt) tags.
InlineCode() - Constructor for class com.overzealous.remark.convert.InlineCode
inlineLinks - Variable in class com.overzealous.remark.Options: If true, place the URLs for links inline.
InlineStyle - Class in com.overzealous.remark.convert: Handles various inline styling (italics and bold), such as em, i, strong, b, span, and font tags.
InlineStyle() - Constructor for class com.overzealous.remark.convert.InlineStyle
inWordEmphasis - Variable in class com.overzealous.remark.Options: Configures how in-word emphasis is handled.
isAdditionalSpacingNeeded() - Method in enum com.overzealous.remark.Options.InWordEmphasis: Returns true when Remark should add spaces around the emphasis characters.
isCleanedHtmlEchoed() - Method in class com.overzealous.remark.Remark: Returns true if the cleaned HTML document is echoed to System.out.
isColspanEnabled() - Method in enum com.overzealous.remark.Options.Tables: True if the table is rendered as a MultiMarkdown table with column spanning.
isConvertedToText() - Method in enum com.overzealous.remark.Options.Tables: True if the table is to be converted to plain text.
isEmphasisPreserved() - Method in enum com.overzealous.remark.Options.InWordEmphasis: Returns whether or not to preserve emphasis at all.
isEmpty() - Method in class com.overzealous.remark.util.BlockWriter: Returns true if nothing has been written to the stream yet.
isEnabled() - Method in enum com.overzealous.remark.Options.FencedCodeBlocks: True if fenced code blocks are enabled
isLeftAsHtml() - Method in enum com.overzealous.remark.Options.Tables: True if the table is to be left as raw HTML.
isRemoved() - Method in enum com.overzealous.remark.Options.Tables: True if the table is to be fully removed.
isRenderedAsCode() - Method in enum com.overzealous.remark.Options.Tables: True if the table should be rendered as a code block

L

LEAVE_AS_HTML - com.overzealous.remark.Options.Tables: Leave all tables and their contents as raw HTML (the default, as this is the recommended syntax from Markdown)
LEFT - com.overzealous.remark.util.MarkdownTable.Alignment
List - Class in com.overzealous.remark.convert: Handles ol and ul lists.
List() - Constructor for class com.overzealous.remark.convert.List

M

main(String[]) - Static method in class com.overzealous.remark.Main
Main - Class in com.overzealous.remark: This is the starting point to begin remarking HTML to Markdown from the command line.
Main() - Constructor for class com.overzealous.remark.Main
markdown() - Static method in class com.overzealous.remark.Options: Creates and returns a new Options set with the default options compatible with the original Markdown.
MARKDOWN_EXTRA - com.overzealous.remark.Options.Tables: Convert tables to the syntax used by PHP Markdown Extra.
markdownExtra() - Static method in class com.overzealous.remark.Options: Creates and returns a new Options set with the default options compatible with PHP Markdown Extra features.
MarkdownTable - Class in com.overzealous.remark.util: Provides a class to contain the structure of an HTML table so it can be cleanly formatted as a plain text structure (either as Markdown or within a Markdown code block).
MarkdownTable() - Constructor for class com.overzealous.remark.util.MarkdownTable: Creates a new, empty MarkdownTable
MarkdownTable.Alignment - Enum in com.overzealous.remark.util: Simple enum to manage the alignment of a column.
MarkdownTableCell - Class in com.overzealous.remark.util: This class contains the contents of a table cell.
MarkdownTableCell() - Constructor for class com.overzealous.remark.util.MarkdownTableCell: Creates a new, empty MarkdownTableCell
MarkdownTableCell(String) - Constructor for class com.overzealous.remark.util.MarkdownTableCell: Creates a new MarkdownTableCell with only contents
MarkdownTableCell(String, int) - Constructor for class com.overzealous.remark.util.MarkdownTableCell: Creates a new MarkdownTableCell with contents and a colspan
MarkdownTableCell(String, MarkdownTable.Alignment) - Constructor for class com.overzealous.remark.util.MarkdownTableCell: Creates a new MarkdownTableCell with contents and alignment
MarkdownTableCell(String, MarkdownTable.Alignment, int) - Constructor for class com.overzealous.remark.util.MarkdownTableCell: Creates a new MarkdownTableCell with contents and a colspan
MULTI_MARKDOWN - com.overzealous.remark.Options.Tables: Convert tables to the syntax used by MultiMarkdown.
multiMarkdown() - Static method in class com.overzealous.remark.Options: Creates and returns a new Options set with the default options compatible with MultiMarkdown features.
multiply(char, int) - Static method in class com.overzealous.remark.util.StringUtils: Duplicates the given character count times.
multiply(PrintWriter, char, int) - Static method in class com.overzealous.remark.util.StringUtils: Duplicates the given character count times to the Writer.
multiply(PrintWriter, String, int) - Static method in class com.overzealous.remark.util.StringUtils: Duplicates the given string count times to the Writer.
multiply(String, int) - Static method in class com.overzealous.remark.util.StringUtils: Duplicates the given string count times.

N

NodeHandler - Interface in com.overzealous.remark.convert: Interface for classes that handle processing HTML Elements.
NodeRemover - Class in com.overzealous.remark.convert
NORMAL - com.overzealous.remark.Options.InWordEmphasis: Uses the default mode, which allows in-word emphasis.

O

Options - Class in com.overzealous.remark: This class is used to configure the Remark engine.
Options() - Constructor for class com.overzealous.remark.Options: Configures a default set of options.
Options.FencedCodeBlocks - Enum in com.overzealous.remark: Provides settings to configure if fenced code blocks are used.
Options.InWordEmphasis - Enum in com.overzealous.remark: Provides options for how to handle in-word emphasis.
Options.Tables - Enum in com.overzealous.remark: Provides settings to control how Tables are converted.

P

Paragraph - Class in com.overzealous.remark.convert: Handles paragraph (p) tags.
Paragraph() - Constructor for class com.overzealous.remark.convert.Paragraph
pegdownAllExtensions() - Static method in class com.overzealous.remark.Options: Creates and returns a new Options set with the default options compatible with pegdown configured with all extensions.
pegdownBase() - Static method in class com.overzealous.remark.Options: Creates and returns a new Options set with the default options compatible with the base pegdown configuration.
prependAndRecurse(String, Element, DocumentConverter, Map<String, NodeHandler>) - Method in class com.overzealous.remark.convert.AbstractNodeHandler: Recursively processes child nodes, and prepends the given string to the output.
prependEachLine(PrintWriter, String, String) - Static method in class com.overzealous.remark.util.StringUtils: Prepends a specific string to the front of each line of an input string.
prependEachLine(String, String) - Static method in class com.overzealous.remark.util.StringUtils: Prepends a specific string to the front of each line of an input string.
preserveRelativeLinks - Variable in class com.overzealous.remark.Options: If true, relative links are preserved.
printBlock(Object) - Method in class com.overzealous.remark.util.BlockWriter: Alias for BlockWriter.writeBlock(Object).
println() - Method in class com.overzealous.remark.util.BlockWriter

R

Remark - Class in com.overzealous.remark: The class that manages converting HTML to Markdown.
Remark() - Constructor for class com.overzealous.remark.Remark: Creates a default, pure Markdown-compatible Remark instance.
Remark(Options) - Constructor for class com.overzealous.remark.Remark: Creates a Remark instance with the specified options.
REMOVE - com.overzealous.remark.Options.Tables: Remove all tables and their contents
REMOVE_EMPHASIS - com.overzealous.remark.Options.InWordEmphasis: Removes in-word emphasis altogether.
renderTable(PrintWriter, boolean, boolean) - Method in class com.overzealous.remark.util.MarkdownTable: Renders out the final table.
reverseHtmlSmartPunctuation - Variable in class com.overzealous.remark.Options: If true, replace all smart punctuation HTML entities (e.g: &emdash;) with simplified characters (e.g: ---).
reverseHtmlSmartQuotes - Variable in class com.overzealous.remark.Options: If true, replace all smart quote HTML entities (e.g: “ with simplified characters (e.g: ").
reverseUnicodeSmartPunctuation - Variable in class com.overzealous.remark.Options: If true, replace all smart punctuation unicode characters (e.g: —) with simplified characters (e.g: ---).
reverseUnicodeSmartQuotes - Variable in class com.overzealous.remark.Options: If true, replace all smart quote unicode characters (e.g: “) with simplified characters (e.g: ").
RIGHT - com.overzealous.remark.util.MarkdownTable.Alignment

S

setAlignment(MarkdownTable.Alignment) - Method in class com.overzealous.remark.util.MarkdownTableCell: Sets the text-alignment.
setCleanedHtmlEchoed(boolean) - Method in class com.overzealous.remark.Remark: To see the cleaned and processed HTML document, set this to true.
setColspan(int) - Method in class com.overzealous.remark.util.MarkdownTableCell: Sets the number of columns this cell spans.
setContents(String) - Method in class com.overzealous.remark.util.MarkdownTableCell: Sets the contents of this cell.
setOutput(BlockWriter) - Method in class com.overzealous.remark.convert.DocumentConverter
setPrependNewlineString(String) - Method in class com.overzealous.remark.util.BlockWriter: Sets the string to prepend to new lines.
setPrependNewlineString(String, boolean) - Method in class com.overzealous.remark.util.BlockWriter: Sets the string to prepend to new lines.
setReverseAllSmarts(boolean) - Method in class com.overzealous.remark.Options: Utility method to set reversing of both unicode and html smart quotes and punctuation.
setReverseSmartPunctuation(boolean) - Method in class com.overzealous.remark.Options: Utility method to set reversing of both unicode and html smart punctuation.
setReverseSmartQuotes(boolean) - Method in class com.overzealous.remark.Options: Utility method to set reversing of both unicode and html smart quotes.
simpleLinkIds - Variable in class com.overzealous.remark.Options: If true, link IDs are simply incremented as they are found.
startBlock() - Method in class com.overzealous.remark.util.BlockWriter: Starts a new block.
StringUtils - Class in com.overzealous.remark.util: A small collection of utilities for manipulating strings.
StringUtils() - Constructor for class com.overzealous.remark.util.StringUtils

T

Table - Class in com.overzealous.remark.convert
Table() - Constructor for class com.overzealous.remark.convert.Table
tables - Variable in class com.overzealous.remark.Options: Configures how tables are handled.
TextCleaner - Class in com.overzealous.remark.convert: This class is used to clean up plain text fields based on the selected set of options.
TextCleaner(Options) - Constructor for class com.overzealous.remark.convert.TextCleaner: Create a new TextCleaner based on the configured options.
toString() - Method in class com.overzealous.remark.util.BlockWriter: If this object has been created using BlockWriter.create(), this will return the contents of the StringWriter buffer.
toString() - Method in class com.overzealous.remark.util.MarkdownTableCell

U

unescapeLeadingCharacters(String) - Method in class com.overzealous.remark.convert.TextCleaner: Removes the escaping on leading characters, for example, when they are going to be rendered inside another node, such as a table.

V

valueOf(String) - Static method in enum com.overzealous.remark.Options.FencedCodeBlocks: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.overzealous.remark.Options.InWordEmphasis: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.overzealous.remark.Options.Tables: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.overzealous.remark.util.MarkdownTable.Alignment: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.overzealous.remark.Options.FencedCodeBlocks: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.overzealous.remark.Options.InWordEmphasis: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.overzealous.remark.Options.Tables: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.overzealous.remark.util.MarkdownTable.Alignment: Returns an array containing the constants of this enum type, in the order they are declared.

W

walkNodes(NodeHandler, Element) - Method in class com.overzealous.remark.convert.DocumentConverter: Loops over the children of an HTML Element, handling TextNode and child Elements.
walkNodes(NodeHandler, Element, Map<String, NodeHandler>) - Method in class com.overzealous.remark.convert.DocumentConverter: Loops over the children of an HTML Element, handling TextNode and child Elements.
withOutputStream(OutputStream) - Method in class com.overzealous.remark.Remark: Use this method in a chain to handle streaming the output to an OutputStream.
withWriter(Writer) - Method in class com.overzealous.remark.Remark: Use this method in a chain to handle streaming the output to a Writer.
write(char[], int, int) - Method in class com.overzealous.remark.util.BlockWriter
write(int) - Method in class com.overzealous.remark.util.BlockWriter
write(String, int, int) - Method in class com.overzealous.remark.util.BlockWriter
writeBlock(Object) - Method in class com.overzealous.remark.util.BlockWriter: Writes an entire block in one go.

A B C D E F G H I L M N O P R S T U V W
All Classes All Packages