Top Description Fields Constructors Methods
com.vladsch.flexmark.ext.enumerated.reference

public Class EnumeratedReferenceBlock

extends Block
implements ReferenceNode<EnumeratedReferenceRepository, EnumeratedReferenceBlock, EnumeratedReferenceText>, 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.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 EnumeratedReference block node

Field Summary

Modifier and TypeField and Description
protected BasedSequence
closingMarker

protected BasedSequence
enumeratedReference

protected BasedSequence
openingMarker

protected BasedSequence
text

Constructor Summary

AccessConstructor and Description
public
EnumeratedReferenceBlock()

public
EnumeratedReferenceBlock(BasedSequence chars)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(EnumeratedReferenceBlock
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 BasedSequence
getEnumeratedReference()

public BasedSequence
getOpeningMarker()

public @Nullable EnumeratedReferenceText
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 void
setClosingMarker(BasedSequence closingMarker)

public void
setEnumeratedReference(BasedSequence enumeratedReference)

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
enumeratedReferenceback to summary
protected BasedSequence enumeratedReference
openingMarkerback to summary
protected BasedSequence openingMarker
textback to summary
protected BasedSequence text

Constructor Detail

EnumeratedReferenceBlockback to summary
public EnumeratedReferenceBlock()
EnumeratedReferenceBlockback to summary
public EnumeratedReferenceBlock(BasedSequence chars)

Method Detail

compareToback to summary
public int compareTo(EnumeratedReferenceBlock 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:EnumeratedReferenceBlock

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()
getEnumeratedReferenceback to summary
public BasedSequence getEnumeratedReference()
getOpeningMarkerback to summary
public BasedSequence getOpeningMarker()
getReferencingNodeback to summary
public @Nullable EnumeratedReferenceText 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
setClosingMarkerback to summary
public void setClosingMarker(BasedSequence closingMarker)
setEnumeratedReferenceback to summary
public void setEnumeratedReference(BasedSequence enumeratedReference)
setOpeningMarkerback to summary
public void setOpeningMarker(BasedSequence openingMarker)
setTextback to summary
public void setText(BasedSequence text)