Top Description Fields Constructors Methods
com.vladsch.flexmark.ext.footnotes

public Class FootnoteBlock

extends Block
implements ReferenceNode<FootnoteRepository, FootnoteBlock, Footnote>, ParagraphItemContainer
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.ast.ParagraphItemContainer, com.vladsch.flexmark.util.ast.ReferenceNode, java.lang.Comparable
Imports
com.vladsch.flexmark.ast.Paragraph, .ParagraphItemContainer, com.vladsch.flexmark.ext.footnotes.internal.FootnoteRepository, com.vladsch.flexmark.parser.ListOptions, com.vladsch.flexmark.util.ast.Block, .Node, .ReferenceNode, com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.sequence.BasedSequence, .SequenceUtils, org.jetbrains.annotations.NotNull, .Nullable
A Footnote definition node containing text and other inline nodes nodes as children.

Field Summary

Modifier and TypeField and Description
protected BasedSequence
closingMarker

private int
firstReferenceOffset

protected BasedSequence
footnote

private int
footnoteOrdinal

private int
footnoteReferences

protected BasedSequence
openingMarker

protected BasedSequence
text

Constructor Summary

AccessConstructor and Description
public
FootnoteBlock()

public
FootnoteBlock(BasedSequence chars)

Method Summary

Modifier and TypeMethod and Description
public void
addFirstReferenceOffset(int firstReferenceOffset)

public int
compareTo(FootnoteBlock
the object to be compared.
other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public void
getAstExtra(@NotNull StringBuilder out)

public BasedSequence
getClosingMarker()

public int
getFirstReferenceOffset()

public BasedSequence
getFootnote()

public int
getFootnoteOrdinal()

public int
getFootnoteReferences()

public BasedSequence
getOpeningMarker()

public @Nullable Footnote
getReferencingNode(@NotNull Node node)

public @NotNull BasedSequence[]
getSegments()

Implements abstract com.vladsch.flexmark.util.ast.Node.getSegments.

public BasedSequence
getText()

public boolean
isItemParagraph(Paragraph node)

Implements com.vladsch.flexmark.ast.ParagraphItemContainer.isItemParagraph.

public boolean
isParagraphInTightListItem(Paragraph node)

Implements com.vladsch.flexmark.ast.ParagraphItemContainer.isParagraphInTightListItem.

public boolean
isParagraphWrappingDisabled(Paragraph node, ListOptions listOptions, DataHolder options)

Implements com.vladsch.flexmark.ast.ParagraphItemContainer.isParagraphWrappingDisabled.

public boolean
isReferenced()

public void
setClosingMarker(BasedSequence closingMarker)

public void
setFirstReferenceOffset(int firstReferenceOffset)

public void
setFootnote(BasedSequence footnote)

public void
setFootnoteOrdinal(int footnoteOrdinal)

public void
setFootnoteReferences(int footnoteReferences)

public void
setOpeningMarker(BasedSequence openingMarker)

public void
setText(BasedSequence text)

Inherited from com.vladsch.flexmark.util.ast.Block:
getParentsetParent

Field Detail

closingMarkerback to summary
protected BasedSequence closingMarker
firstReferenceOffsetback to summary
private int firstReferenceOffset
footnoteback to summary
protected BasedSequence footnote
footnoteOrdinalback to summary
private int footnoteOrdinal
footnoteReferencesback to summary
private int footnoteReferences
openingMarkerback to summary
protected BasedSequence openingMarker
textback to summary
protected BasedSequence text

Constructor Detail

FootnoteBlockback to summary
public FootnoteBlock()
FootnoteBlockback to summary
public FootnoteBlock(BasedSequence chars)

Method Detail

addFirstReferenceOffsetback to summary
public void addFirstReferenceOffset(int firstReferenceOffset)
compareToback to summary
public int compareTo(FootnoteBlock other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:FootnoteBlock

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
getAstExtraback to summary
public void getAstExtra(@NotNull StringBuilder out)
Annotations
@Override
getClosingMarkerback to summary
public BasedSequence getClosingMarker()
getFirstReferenceOffsetback to summary
public int getFirstReferenceOffset()
getFootnoteback to summary
public BasedSequence getFootnote()
getFootnoteOrdinalback to summary
public int getFootnoteOrdinal()
getFootnoteReferencesback to summary
public int getFootnoteReferences()
getOpeningMarkerback to summary
public BasedSequence getOpeningMarker()
getReferencingNodeback to summary
public @Nullable Footnote getReferencingNode(@NotNull Node node)
Annotations
@Nullable
@Override
getSegmentsback to summary
public @NotNull BasedSequence[] getSegments()

Implements abstract com.vladsch.flexmark.util.ast.Node.getSegments.

Annotations
@NotNull
@Override
getTextback to summary
public BasedSequence getText()
isItemParagraphback to summary
public boolean isItemParagraph(Paragraph node)

Implements com.vladsch.flexmark.ast.ParagraphItemContainer.isItemParagraph.

Annotations
@Override
isParagraphInTightListItemback to summary
public boolean isParagraphInTightListItem(Paragraph node)

Implements com.vladsch.flexmark.ast.ParagraphItemContainer.isParagraphInTightListItem.

Annotations
@Override
isParagraphWrappingDisabledback to summary
public boolean isParagraphWrappingDisabled(Paragraph node, ListOptions listOptions, DataHolder options)

Implements com.vladsch.flexmark.ast.ParagraphItemContainer.isParagraphWrappingDisabled.

Annotations
@Override
isReferencedback to summary
public boolean isReferenced()
setClosingMarkerback to summary
public void setClosingMarker(BasedSequence closingMarker)
setFirstReferenceOffsetback to summary
public void setFirstReferenceOffset(int firstReferenceOffset)
setFootnoteback to summary
public void setFootnote(BasedSequence footnote)
setFootnoteOrdinalback to summary
public void setFootnoteOrdinal(int footnoteOrdinal)
setFootnoteReferencesback to summary
public void setFootnoteReferences(int footnoteReferences)
setOpeningMarkerback to summary
public void setOpeningMarker(BasedSequence openingMarker)
setTextback to summary
public void setText(BasedSequence text)