All Classes

Class	Description
AbstractContentNode<C extends AbstractContentNode<C,N>,N extends Node>	Nodes that use the "content" key to specify a list of child nodes extend this type to handle the common conventions across those node types.
AbstractListNode<L extends AbstractListNode<L>>	Common parent of the bulletList and orderedList node types.
AbstractMarkedContentNode<C extends AbstractMarkedContentNode<C,N,M>,N extends Node,M extends Mark>
AbstractMarkedNode<N extends AbstractMarkedNode<N,M>,M extends Mark>
AbstractNode<N extends AbstractNode<N>>
AbstractNode.ToStringHelper
AbstractTableCellNode<N extends AbstractTableCellNode<N>>	Either of the data-containing nodes that can be placed in a TableRow, meaning either a tableHeader or a tableCell.
AdfException	An exception reporting a problem with the structure of an ADF document.
AdfException.DuplicateProperty	Thrown to indicate the error of attempting to add the same key to the map representation of a node more than one time.
AdfException.EmptyProperty	Thrown to indicate that a required string value was specified as an empty string.
AdfException.InvalidURI	Used as a runtime replacement for URISyntaxException when a parameter value that must be a valid URI is checked.
AdfException.MissingProperty	Thrown to indicate that a required field or attribute was not provided.
AdfException.MissingType	Thrown for any node or mark that fails to specify a type value.
AdfException.PropertyException	Thrown to indicate that there is something wrong with a field (those values placed directly at the top level of a node or mark) or attribute (those placed within the attrs object).
AdfException.UnexpectedRuntimeException	Used to wrap other runtime exceptions as an AdfException, primarily so that the error path can potentially be provided for it.
AdfException.UnsupportedEnumValue	Thrown when a limited set of enumerated values are permitted, but a value was encountered that is not in the allowed set.
AdfException.ValueTypeMismatch	Thrown to indicate that a particular value could not be extracted from a field or attribute because it was not of the correct type.
AdfMarshaller<T>	Something that can produce an external form for an ADF document.
AdfParser<T>
AdfUnmarshaller<T>	Something that can restore an ADF document from an external form.
Alignment	The alignment mark sets right (end) or center alignment for a node.
Alignment.Align	Specifies how the content should be aligned relative to the overall page layout.
Annotation	The annotation mark shows the presence of an annotation or comment on a node.
Annotation.AnnotationType
BlockCard	The blockCard node is an Atlassian link card with a type icon and content description derived from the link.
BlockCard.CardAttributes	A sum type providing access to the link data for this card.
BlockCard.Datasource	A blockCard node with type=datasource is not really a normal block card.
BlockCard.Partial	Types that represent a partially constructed blockCard or inlineCard.
BlockCard.Partial.NeedsCardAttributes	This partially constructed card still needs either a url or data value set.
BlockCard.Partial.NeedsDatasourceId	A partially constructed datasource block card that needs the id set.
BlockCard.Partial.NeedsDatasourceParameters	A partially constructed datasource block card that needs the parameters set.
BlockCard.Partial.NeedsDatasourceViews	A partially constructed datasource block card that needs the views set, which will complete the datasource definition and the BlockCard as a whole.
BlockCard.Partial.OptionalDatasourceParameters<T extends BlockCard.Partial.OptionalDatasourceParameters<T>>
BlockCard.View
Blockquote	The Blockquote node is a container for quotes.
BodiedExtension	Extensions provide hook points for ecosystem add-ons to integrate with how ADF content is rendered.
BodiedExtensionMark	Any mark that is assignable to bodiedExtension nodes.
Border	The border mark sets border styling.
BorderException	Reports a problem with a border mark.
BorderException.InvalidColor	Reports that a border mark specified am invalid value for its color.
BorderException.InvalidSize	Reports that a border mark specified a size that is out of range.
Breakout	The breakout mark sets block nodes to extend wider than the normal content area.
Breakout.Mode	Specifies the desired width of content that breaks out of the usual content margins.
BulletList	A container for list items that produces a bulleted list.
Caption	Wraps the caption content that may optionally be assigned to a mediaSingle node.
CaptionContent	Marks the nodes that can be placed directly into a caption node.
CardException	Reports a problem with one of the various "card" node types: blockCard, embedCard, or inlineCard.
CardException.BlockCardAttributesMustBeSet	Reports an attempt to use a blockCard without first setting any of its url, data, or datasource values.
CardException.DataAndDatasourceCannotBothBeSet	Reports an attempt to set both the data and datasource values on a blockCard.
CardException.DatasourceRequiresAtLeastOneView	Reports an attempt to use a blockCard with datasource attributes that do not contain at least one entry in the views list.
CardException.InvalidWidth	Reports an attempt to use an invalid width value on an embedCard node.
CardException.UrlAndDataCannotBothBeSet	Reports an attempt to set both the url and data values on a blockCard or inlineCard.
CardException.UrlOrDataMustBeSet	Reports an attempt to use an inlineCard without first setting either its url or data value.
Cast	This is a way for us to declare explicitly that we know something that the compiler doesn't and pinky-swear that the value we have really is of the inferred return type.
Char	From editor-wikimarkup-transformer/src/char.ts originally, but there is a lot more in here, now.
Code	The code mark sets code styling.
CodeBlock	A container for lines of code.
CodeBlockMark	Any mark that is assignable to codeBlock nodes.
CodeTextMark	Text marks that are only usable in code sections and can only be used together with other marks that also implement this marker interface.
Colors	From adf-schema/src/utils/colors.ts.
Colors.Named	The standard color names, as taken from the W3C CSS/Properties/color/keywords specification.
ContentException	Reports a problem with the content section for a node.
ContentException.ContentRequired	Reports that the content fields was not provided or was left empty on a node that requires at least one content item to be valid.
ContentException.FieldRequired	Reports that the content field was not provided on a node that requires its presence.
ContentNode<C extends ContentNode<C,N>,N extends Node>	Describes the behaviour common to all nodes that act as holders of other content.
DataConsumer	Its purpose seems to be related to giving extension nodes a way to specify that an extension will want access to the data supplied by the given data sources on the page, presumably so that it can render them nicely for the end user.
DataConsumer.Partial	Types that represent a partially constructed dataConsumer.
DataConsumer.Partial.NeedsSource	This partially constructed dataConsumer still needs at least one source.
DataConsumerException	Reports a problem with a dataConsumer mark.
DataConsumerException.DuplicateSource	Reports that the same source was listed multiple times for the same dataConsumer.
DataConsumerException.NoSources	Reports that no sources were provided for the dataConsumer.
DataConsumerException.SourceException	Reports a problem with the sources attribute of a dataConsumer mark.
Date	The date node displays a date in the user's locale.
Date.Partial	Types that represent a partially constructed Date.
Date.Partial.NeedsTimestamp	This partially constructed date still needs its timestamp attribute set.
DateUtil	From packages/editor/editor-common/src/utils/date.ts in atlassian-frontend.
DecisionItem	The decisionItem node is a decision in a decisionList.
DecisionItem.Partial	Types that represent a partially constructed decisionItem.
DecisionItem.Partial.NeedsLocalId	This partially constructed decistionItem still needs its localId attribute set.
DecisionItem.Partial.NeedsState	This partially constructed decisionItem still needs its state attribute set.
DecisionItem.State
DecisionList	Decision lists provide lists that look much like a bulletList, but they cannot be nested and there are differences in their visual representation.
DecisionList.Partial	Types that represent a partially constructed decisionList.
DecisionList.Partial.NeedsLocalId	This partially constructed decisionList still needs its localId attribute set.
Doc	The root container node of every Atlassian Document Format (ADF) document.
Doc.Version
DocContent	Marks the nodes that can be placed directly into a doc node.
DocException	Reports a problem with the top-most node of an ADF document.
DocException.InvalidTopLevel	Indicates that a request to parse a document as ADF failed because the top-most node was not a doc.
DocException.UnsupportedVersion	Indicates that the doc node specified an unsupported value for its version.
Documentation	Expresses the library maintainer's opinion of the state of the public documentation for the Atlassian Document Format with regard to the annotated node or mark.
Documentation.State	Expresses that library's author on the state of the Jira ADF Documentation for this item (whether it is a mark, a node, or a property of either) at the time of its more recent review on Documentation.date().
Element	Any object within the Atlassian Document Format (ADF) structure.
Element.Attr	Constants used as names of attributes in both nodes and marks.
Element.Key	Constants used as property names in both nodes and marks.
Em	The em mark sets italic (emphasis) styling.
EmbedCard
EmbedCard.Partial	Types that represent a partially constructed embedCard.
EmbedCard.Partial.NeedsLayout	This partially constructed embedCard still needs its layout attribute set.
EmbedCard.Partial.NeedsUrl	This partially constructed embedCard still needs its url attribute set.
Emoji	An inline node that represents an emoji.
Emoji.Partial	Types that represent a partially constructed emoji.
Emoji.Partial.NeedsShortName	This partially constructed emoji still needs its shortName attribute set.
Emoji.Standard
EnumParser<E extends Enum<E>>	Extracts a lookup map from an enumerated type.
Expand	The expand node is a container that enables content to be hidden or shown, similar to an accordion or disclosure widget.
ExpandMark	Any mark that is assignable to expand nodes.
Extension	Extensions provide hook points for ecosystem add-ons to integrate with how ADF content is rendered.
ExtensionMark	Any mark that is assignable to extension nodes.
ExtensionNode<N extends ExtensionNode<N,M>,M extends Mark>	Describes features that are common to the various extension node types.
ExtensionSettings	A helper class that provides consistent management of extension settings for the various node types that represent extensions.
ExtensionSettings.Layout
ExtensionSettings.Partial	Types that represent a partially constructed extension node of some kind.
ExtensionSettings.Partial.NeedsExtensionKey<T>	This partially constructed extension still needs its extensionKey attribute set.
ExtensionSettings.Partial.NeedsExtensionType<T>	This partially constructed extension still needs its extensionType attribute set.
Factory<T extends Element>	Supporting class for the parser that resolves the type of an element to its corresponding node or mark class as well as a sub-parser that can reconstruct the element from its map value.
FieldMap	A mutable Map<String, Object> with a few helpful additions for constructing the representation of ADF nodes and marks.
Fold2<A,B>	Sum type of two other types.
Fold3<A,B,C>	Sum type of three other types.
FormattedTextMark	Text marks that are only usable in formatted-text sections and can only be used together with other marks that also implement this marker interface.
Fragment	Its purpose seems to be related to giving extension nodes a way to refer to page fragments that should be integrated into the rendering at this point.
Fragment.Partial	Types that represent a partially constructed fragment.
Fragment.Partial.NeedsLocalId	This partially constructed fragment still needs its localId attribute set.
Functions
HardBreak	An inline node that inserts a forced line-break within a sequence of text strings.
HardBreakException	Reports a problem with a hardBreak node.
HardBreakException.TextMustBeNewline	The rather useless text attribute on hardBreak nodes is usually omitted, and when specified is only permitted to use the value "\n" — that is, a single newline character.
Heading	Represents a topic heading, as for the <h1> through <h6> tags used in HTML.
HeadingException	Reports a problem with a heading node.
HeadingException.InvalidLevel	Reports that a heading node specified a level that is out of range.
HeadingMark	Any mark that is assignable to heading nodes.
Indentation	The indentation mark sets the level of indentation for a node, up to 6.
IndentationException	Reports a problem with an indentation mark.
IndentationException.InvalidLevel	Reports that an indentation mark specified a level that is out of range.
InlineCard	An Atlassian link card with a type icon and content description derived from the link.
InlineCard.Partial	Types that represent a partially constructed inlineCard.
InlineCard.Partial.NeedsUrlOrData	This partially constructed inline card still needs either a url or data value set.
InlineCard.UrlOrData	A sum type providing access to the link data for this card.
InlineContent	Marks the nodes that are text or can usually be freely intermixed with it.
InlineExtension	Extensions provide hook points for ecosystem add-ons to integrate with how ADF content is rendered.
InlineExtensionMark	Any mark that is assignable to inlineExtension nodes.
InternalMediaNode	A marker interface for media 'file' and 'link' nodes as well as mediaInline nodes.
JsonParser	Very simplified view of a JSON parser that only provides conversion to/from Map<String>.
LayoutColumn	Declares one of the 2 to 3 columns in a layoutSection.
LayoutColumnContent	Marks the nodes that can be placed directly into a layoutColumn node.
LayoutColumnException	Reports a problem with a layoutColumn node.
LayoutColumnException.InvalidWidth	Reports an attempt to use an invalid width value on a layoutColumn node.
LayoutSection	In Confluence, the top-level doc node is allowed to include layoutSection nodes.
LayoutSection.Partial	Types that represent a partially constructed layoutSection.
LayoutSection.Partial.NeedsFirstColumn	A partially constructed layout section that still needs the first column to be added to it.
LayoutSection.Partial.NeedsSecondColumn	A partially constructed layout section that still needs the second column to be added to it.
LayoutSectionException	Reports a problem with a layoutSection node.
LayoutSectionException.ColumnCountException	Reports a problem with the number of layoutColumn nodes contained within a layoutSection node.
LayoutSectionException.NotEnoughLayoutColumns	Indicates that a layoutSection node did not have enough layoutColumn nodes within it to be valid.
LayoutSectionException.TooManyLayoutColumns	Indicates that a layoutSection node had too many layoutColumn nodes within it to be valid.
LayoutSectionMark	Any mark that is assignable to layoutSection nodes.
Link	The link mark sets a hyperlink.
ListException	Reports a problem with a bulletList, orderedList, or listItem node.
ListException.CannotUseNestedListAsFirstContentItem	Reports an attempt to nest a bulletList or orderedList as the first piece of content in a listItem.
ListException.OrderMustNotBeNegative	Reports an attempt to create an orderedList with an order value that is negative.
ListItem	Represents an item in either a bulletList or an orderedList.
ListItemContent	Marks the nodes that can be placed directly into a listItem node.
ListNode<L extends ListNode<L>>	Describes features that are common to bulletList and taskList nodes.
Mark	Marks are special document elements that are used to decorate text nodes.
Mark.Attr	Constants used as the attribute names in marks.
Mark.Type	Constants used as the type names in marks.
Marked<N extends Node & Marked<N,M>,M extends Mark>	Indicates that this node can use a marks element to alter its presentation.
MarkException	Reports a problem with an ADF mark.
MarkException.ConstraintViolation	Indicates that a mark which could not be excluded by the type system is nevertheless invalid in the given circumstances due to other constraints related to ADF or how the marked node has been used.
MarkException.DuplicateMarkType	Indicates that the caller has attempted to add two marks with the same value for the type field to the same node.
MarkException.LimitReached	Indicates that the new mark cannot be added because there is a limit to how many marks the node is permitted to have and that limit has already been reached.
MarkException.MarkDisallowed	Indicates that the new mark cannot be added because its use has been restricted for some reason.
MarkException.RestrictedMarkAlreadyPresent	Indicates that a request to disable marks on a given node cannot proceed because the target node is already marked.
MarkException.TypeMismatch	Indicates that the given mark type does not satisfy the type system's contraints on what mark types are permitted here.
MarkException.TypeUnsupported	Indicates that the given mark type does not satisfy the type system's contraints on what mark types are permitted here.
MarkParserSupport	Used by marked nodes to process any marks that are present.
Media	Represents a single file or link stored in media services.
Media.AbstractMedia<N extends Media.AbstractMedia<N>>
Media.ExternalMedia
Media.FileMedia
Media.FileOrLinkMedia<T extends Media.FileOrLinkMedia<T>>
Media.LinkMedia
Media.MediaType
Media.Partial	Types that represent a partially constructed media.
Media.Partial.ExternalNeedsUrl	This partially constructed media node is external and still needs a url.
Media.Partial.FileNeedsId	This partially constructed media node is a file and still needs a media id.
Media.Partial.LinkNeedsCollection	Deprecated. Most of the support for link media no longer functions in the editor code base, so clients are unlikely to encounter it in the wild and should not use it in new ADF.
Media.Partial.LinkNeedsId	Deprecated. Most of the support for link media no longer functions in the editor code base, so clients are unlikely to encounter it in the wild and should not use it in new ADF.
Media.Partial.NeedsType	Partially constructed media node still needs the specific media type set.
MediaException	Reports a problem with a media node or one of the containers that can hold one: mediaGroup, mediaSingle, or mediaInline.
MediaException.HeightMustBePositive	Reports an attempt to use an invalid height value on a media node or one of its containers.
MediaException.MediaSizeException	Reports an attempt to use an invalid width or height value on a media node or one of its containers.
MediaException.TooManyContentItems	Reports that too many content items were provided for a mediaSingle node.
MediaException.WidthMustBePositive	Reports an attempt to use an invalid width value on a media node or one of its containers, except that mediaSingle uses MediaException.WidthMustBeValidPercentage instead.
MediaException.WidthMustBeValidPercentage	Reports an attempt to use an invalid width value on a node that expects a percentage width value.
MediaException.WidthMustBeValidPixelCount	Reports an attempt to use an invalid width value on a node that expects a pixel count.
MediaGroup	A container for several media items.
MediaInline	The mediaInline node type works just like file and link types of media nodes, except that instead of being placed inside the mediaGroup and mediaSingle block nodes, they are used in places that inline content is permitted, such as within a paragraph.
MediaInline.MediaType
MediaInline.Partial	Types that represent a partially constructed mediaInline.
MediaInline.Partial.CanSetMediaType<T extends MediaInline.Partial.CanSetMediaType<T>>	The media type of this partially constructed mediaInline can still be changed.
MediaInline.Partial.NeedsId	This partially constructed mediaInline still needs its media id attribute set.
MediaInlineMark	Any mark that is assignable to mediaInline nodes.
MediaMark	Any mark that is assignable to media nodes.
MediaSingle	A container for exactly one media item, optionally followed by a caption.
MediaSingle.Partial	Types that represent a partially constructed mediaSingle.
MediaSingle.Partial.NeedsMedia	This partially constructed mediaSingle still needs its media content set.
MediaSingle.WidthType	Determines whether the width attribute should be interpreted as a percentage or pixel count.
MediaSingleMark	Any mark that is assignable to mediaSingle nodes.
Mention	Represents a user mention.
Mention.AccessLevel	The well-known accessLevel enumerated values that were originally documented for mention nodes.
Mention.UserType
NestedExpand	A nestedExpand node serves the same purpose as expand, except that it is used inside of a tableCell or tableHeader instead of directly inside a doc.
NestedExpandContent	Marks the nodes that can be placed directly into a nestedExpand node.
Node	A node in the Atlassian Document Format describes an element to be rendered as rich content.
Node.Attr	Constants used as the attribute names in nodes.
Node.Key	Constants used as property names in nodes.
Node.Type	Constants used as the type names for the various ADF nodes.
NodeException	Reports a problem with an ADF node.
NodeException.TypeMismatch	Reports that the type of node used does not implement the class that is required in the given parentType node's content.
NodeParserSupport	Used by the various content nodes to process the other nodes that they contain.
NonNestableBlockContent	Marks the nodes that can be used within expand and bodiedExtension nodes.
OrderedList	A container for list items that produces a numbered list of them.
Panel	A container that highlights content as additional information, a warning, or the result of an action.
Panel.PanelType
Panel.Partial	Types that represent a partially constructed panel.
Panel.Partial.NeedsPanelType	This partially constructed panel still needs its panelType attribute set.
PanelContent	Marks the nodes that can be placed directly into a panel node.
Paragraph	A container for a block of formatted text delineated by a carriage return.
ParagraphMark	Any mark that is assignable to paragraph nodes.
ParserSupport	Utility/support methods common to parsing nodes or marks.
Placeholder	Provides placeholder text for something.
Placeholder.Partial	Types that represent a partially constructed placeholder.
Placeholder.Partial.NeedsText	This partially constructed placeholder still needs its text attribute set.
PositionMark	Marks related to layout of elements, such as indentation or alignment controls.
RichMedia	Copies this abstraction from @atlaskit/adf-schema to avoid copy/paste of the related enums.
RichMedia.Layout	Layout that determines how the media idea should be positioned in relation to the flow of other information on the page.
Rule	Representing a divider, this is equivalent to an HTML <hr/> tag.
Sanitizer	From src/lib/adf/adf-sanitizer.ts in pf-content-service.
Schema	Schema reader for the JSON schema included in the source.
Status	This node defines a status lozenge, such as is shown for the workflow status of a Jira issue or for the /status macro in Confluence.
Status.Color	The color used for the status lozenge.
Status.Partial	Types that represent a partially constructed status.
Status.Partial.NeedsColor	This partially constructed status still needs its color attribute set.
Status.Partial.NeedsText	This partially constructed status still needs its text attribute set.
Strike	The em mark sets strike-through styling.
Strong	The em mark sets strong styling.
SubSup	The subsup mark sets superscript or subscript styling.
SubSup.Type
Table	A container for the nodes that define a table.
Table.Layout
TableCell	A table cell within a table row.
TableCellContent	Marks the nodes that can be placed directly into either a tableHeader or tableCell node.
TableCellException	Reports an error with a tableCell or tableHeader node.
TableCellException.ColspanNotPositive	Reports that the colspan attribute for a tableCell or tableHeader node was not positive.
TableCellException.ColwidthCannotBeNegative	Reports that at least one negative value was provided in the colwidth attribute for a tableCell or tableHeader.
TableCellException.ColwidthDoesNotMatchColspan	Reports that the array of values colwidth attribute for a tableCell or tableHeader did not match the colspan attribute.
TableCellException.ColwidthException	Reports a problem with the colwidth attribute of a tableCell or tableHeader.
TableCellException.ColwidthMustHaveAtLeastOnePositiveValue	Reports that all of the values colwidth attribute for a tableCell or tableHeader were 0.
TableCellException.RowspanNegative	Reports that the rowspan attribute for a tableCell or tableHeader was negative.
TableCellNode<N extends TableCellNode<N>>	Describes features that are common to tableHeader and tableCell nodes.
TableHeader	A table cell within a table heading row.
TableMark	Any mark that is assignable to table nodes.
TableRow	Defines rows within a table and is a container for table heading and table cell nodes.
TableRowContent	Marks the nodes that can be placed directly into a tableRow node.
TaskItem	Provides the content for one of the items in a taskList.
TaskItem.Partial	Types that represent a partially constructed taskItem.
TaskItem.Partial.NeedsLocalId	This partially constructed taskItem still needs its localId attribute set.
TaskItem.Partial.NeedsLocalIdAndState	This partially constructed taskItem still needs its localId and state attributes set (and this builder permits them to be set in either order).
TaskItem.Partial.NeedsState	This partially constructed taskItem still needs its state attribute set.
TaskItem.State
TaskList	Task lists provide lists that look much like a bulletList, but there are differences in their visual representation.
TaskListContent	Marks the nodes that can be placed directly into a taskList node.
TaskListException	Reports a problem with a taskList node.
TaskListException.CannotUseNestedTaskListAsFirstContentItem	Reports an attempt to nest a taskList as the first piece of content in a taskITem.
Text	Holds document text.
TextColor	The textColor mark adds <span style="color: #ff0000;">...</span> color styling.
TextColorException	Reports a problem with a textColor mark.
TextColorException.InvalidColor	Indicates that the requested color attribute for a textColor mark is not supported.
TextMark	Any mark that is assignable to text nodes.
Underline	The underline mark sets underline styling.
UnsupportedElement	Represents an ADF element that isn't supported by this library and can only be preserved as-is, not directly manipulated, because we don't know what it is, what it does, or what constraints there might be around its use.
UnsupportedNode<N extends UnsupportedNode<N>>
UnsupportedNodeFactory
UnsupportedTextMark	Represents some unknown mark that was used on a text node.
UrlUtil	Utility class for working with URLs in a way that helps keep them from breaking either Java or JavaScript code.