@FieldsAreNonnullByDefault @ParametersAreNonnullByDefault @PublicApi @ReturnValuesAreNonnullByDefault

Package com.atlassian.adf.model.node

Nodes are elements within the Atlassian Document Format that represent presentation data for the document. A node might represent something like a bullet list or a paragraph of text, for example.

See Also:

Doc

Interface Summary

Interface	Description
BlockCard.Partial	Types that represent a partially constructed blockCard or inlineCard.
Date.Partial	Types that represent a partially constructed Date.
DecisionItem.Partial	Types that represent a partially constructed decisionItem.
DecisionList.Partial	Types that represent a partially constructed decisionList.
EmbedCard.Partial	Types that represent a partially constructed embedCard.
Emoji.Partial	Types that represent a partially constructed emoji.
Emoji.Standard
ExtensionSettings.Partial	Types that represent a partially constructed extension node of some kind.
InlineCard.Partial	Types that represent a partially constructed inlineCard.
InlineCard.UrlOrData	A sum type providing access to the link data for this card.
LayoutSection.Partial	Types that represent a partially constructed layoutSection.
Media	Represents a single file or link stored in media services.
Media.Partial	Types that represent a partially constructed media.
MediaInline.Partial	Types that represent a partially constructed mediaInline.
MediaSingle.Partial	Types that represent a partially constructed mediaSingle.
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.
Panel.Partial	Types that represent a partially constructed panel.
Placeholder.Partial	Types that represent a partially constructed placeholder.
Status.Partial	Types that represent a partially constructed status.
TaskItem.Partial	Types that represent a partially constructed taskItem.

Class Summary

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.
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.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.
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.
CodeBlock	A container for lines of code.
Date	The date node displays a date in the user's locale.
Date.Partial.NeedsTimestamp	This partially constructed date still needs its timestamp attribute set.
DecisionItem	The decisionItem node is a decision in a decisionList.
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.
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.NeedsLocalId	This partially constructed decisionList still needs its localId attribute set.
Doc	The root container node of every Atlassian Document Format (ADF) document.
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.NeedsShortName	This partially constructed emoji still needs its shortName attribute set.
Expand	The expand node is a container that enables content to be hidden or shown, similar to an accordion or disclosure widget.
Extension	Extensions provide hook points for ecosystem add-ons to integrate with how ADF content is rendered.
ExtensionSettings	A helper class that provides consistent management of extension settings for the various node types that represent extensions.
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.
HardBreak	An inline node that inserts a forced line-break within a sequence of text strings.
Heading	Represents a topic heading, as for the <h1> through <h6> tags used in HTML.
InlineCard	An Atlassian link card with a type icon and content description derived from the link.
InlineCard.Partial.NeedsUrlOrData	This partially constructed inline card still needs either a url or data value set.
InlineExtension	Extensions provide hook points for ecosystem add-ons to integrate with how ADF content is rendered.
LayoutColumn	Declares one of the 2 to 3 columns in a layoutSection.
LayoutSection	In Confluence, the top-level doc node is allowed to include layoutSection nodes.
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.
ListItem	Represents an item in either a bulletList or an orderedList.
Media.AbstractMedia<N extends Media.AbstractMedia<N>>
Media.ExternalMedia
Media.FileMedia
Media.FileOrLinkMedia<T extends Media.FileOrLinkMedia<T>>
Media.LinkMedia
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.
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.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.
MediaSingle	A container for exactly one media item, optionally followed by a caption.
MediaSingle.Partial.NeedsMedia	This partially constructed mediaSingle still needs its media content set.
Mention	Represents a user mention.
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.
NodeParserSupport	Used by the various content nodes to process the other nodes that they contain.
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.Partial.NeedsPanelType	This partially constructed panel still needs its panelType attribute set.
Paragraph	A container for a block of formatted text delineated by a carriage return.
Placeholder	Provides placeholder text for something.
Placeholder.Partial.NeedsText	This partially constructed placeholder still needs its text attribute set.
RichMedia	Copies this abstraction from @atlaskit/adf-schema to avoid copy/paste of the related enums.
Rule	Representing a divider, this is equivalent to an HTML <hr/> tag.
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.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.
Table	A container for the nodes that define a table.
TableCell	A table cell within a table row.
TableHeader	A table cell within a table heading row.
TableRow	Defines rows within a table and is a container for table heading and table cell nodes.
TaskItem	Provides the content for one of the items in a taskList.
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.
TaskList	Task lists provide lists that look much like a bulletList, but there are differences in their visual representation.
Text	Holds document text.

Enum Summary

Enum	Description
DecisionItem.State
Doc.Version
ExtensionSettings.Layout
Media.MediaType
MediaInline.MediaType
MediaSingle.WidthType	Determines whether the width attribute should be interpreted as a percentage or pixel count.
Mention.AccessLevel	The well-known accessLevel enumerated values that were originally documented for mention nodes.
Mention.UserType
Panel.PanelType
RichMedia.Layout	Layout that determines how the media idea should be positioned in relation to the flow of other information on the page.
Status.Color	The color used for the status lozenge.
Table.Layout
TaskItem.State