Package com.atlassian.adf.model.node

Class Expand

java.lang.Object

com.atlassian.adf.model.node.AbstractNode<C>

com.atlassian.adf.model.node.AbstractContentNode<C,N>

com.atlassian.adf.model.node.AbstractMarkedContentNode<Expand,NonNestableBlockContent,ExpandMark>

com.atlassian.adf.model.node.Expand

All Implemented Interfaces:

Element, Node, ContentNode<Expand,NonNestableBlockContent>, DocContent, LayoutColumnContent, Marked<Expand,ExpandMark>

@Documentation(state=UNDOCUMENTED,
               date="2023-07-26")
public class Expand
extends AbstractMarkedContentNode<Expand,NonNestableBlockContent,ExpandMark>
implements DocContent, LayoutColumnContent

The expand node is a container that enables content to be hidden or shown, similar to an accordion or disclosure widget.

Note: To add an expand to a table (tableCell or tableHeader) use nestedExpand instead.

Example

Java

 expand(
     p("Hello world")
 );
 

ADF

  {
    "type": "expand",
    "attrs": {
      "title": "Hello world"
    },
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Hello world"
          }
        ]
      }
    ]
  }
 

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.adf.model.node.AbstractNode

AbstractNode.ToStringHelper

Nested classes/interfaces inherited from interface com.atlassian.adf.model.node.Node

Node.Attr, Node.Key, Node.Type

Field Summary

Fields inherited from class com.atlassian.adf.model.node.AbstractMarkedContentNode

marks

Fields inherited from class com.atlassian.adf.model.node.AbstractContentNode

content

Method Summary

Modifier and Type	Method	Description
protected void	appendMarkedContentNodeFields(AbstractNode.ToStringHelper buf)
Optional<Breakout>	breakout()
Expand	breakout(Breakout breakout)
Class<NonNestableBlockContent>	contentClass()	Returns Class<N>, the class representing the type of items held by this node.
Expand	copy()	Returns a deep copy of this element, including copies of any nodes or marks that it contains.
Expand	defaultWidth()
String	elementType()	The type value that identifies this element, such as "paragraph" or "strong".
static Expand	expand()
static Expand	expand(NonNestableBlockContent content)
static Expand	expand(NonNestableBlockContent... content)
static Expand	expand(Iterable<? extends NonNestableBlockContent> content)
static Expand	expand(Stream<? extends NonNestableBlockContent> content)
Expand	fullWidth()
Class<ExpandMark>	markClass()	Returns the type of marks that may be applied to this node.
protected boolean	markedContentNodeEquals(Expand other)
protected int	markedContentNodeHashCode()
protected void	markedContentNodeValidate()
Optional<String>	title()
Expand	title(String title)
Map<String,?>	toMap()	Transforms this element to a map of String values to various basic object types suitable for direct rendering as JSON content.
protected void	validateContentNodeForAppend(NonNestableBlockContent node)	Called on each content node before it is added to validate that the node can be accepted.
Expand	wide()

Methods inherited from class com.atlassian.adf.model.node.AbstractMarkedContentNode

appendContentNodeFields, contentNodeEquals, contentNodeHashCode, contentNodeValidate, createMarkHolder, mark, mark, marks, marks, markTypes, parseMarks, unsupportedMarkFactory

Methods inherited from class com.atlassian.adf.model.node.AbstractContentNode

addContent, addContentIfPresent, allNodes, appendNodeFields, appendPlainText, appendPlainTextContentJoinedWith, appendPlainTextInlineContent, clear, content, content, content, content, content, contentFieldMaps, isEmpty, nodeEquals, nodeHashCode, parseContentItem, parseContentItems, parseOptionalContent, parseRequiredContent, parseRequiredContentAllowEmpty, removeIf, replaceContent, requireNotEmpty, transformContent, transformDescendants, trim, validate, validateContentItems

Methods inherited from class com.atlassian.adf.model.node.AbstractNode

doubleEq, doubleHash, equals, hashCode, isSupported, mapWithType, numberEq, numberHash, self, toPlainText, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.adf.model.node.type.ContentNode

allNodes, allNodesOfType, allNodesOfTypeAsList, clear, content, content, content, content, content, isEmpty, removeIf, replaceContent, transformContent, transformDescendants

Methods inherited from interface com.atlassian.adf.model.Element

isSupported, validate

Methods inherited from interface com.atlassian.adf.model.node.Node

appendPlainText, toPlainText

Method Detail

expand

public static Expand expand()

expand

public static Expand expand(NonNestableBlockContent content)

expand

public static Expand expand(NonNestableBlockContent... content)

expand

public static Expand expand(Iterable<? extends NonNestableBlockContent> content)

expand

public static Expand expand(Stream<? extends NonNestableBlockContent> content)

title

public Optional<String> title()

title

public Expand title(String title)

contentClass

public Class<NonNestableBlockContent> contentClass()

Description copied from interface: ContentNode

Returns Class<N>, the class representing the type of items held by this node.

Specified by:

contentClass in interface ContentNode<Expand,NonNestableBlockContent>

copy

public Expand copy()

Description copied from interface: Element

Returns a deep copy of this element, including copies of any nodes or marks that it contains. The copy will not necessarily be in exactly the same state as the original in some cases. For example, a text node that is used inside a codeBlock will have the ability to use marks on it disabled, but a copy made of the text node using this method will not similarly disallow marks unless it is also added to a content node with those same restrictions.

Implementations notes:

• Implementations should narrow the return type.
• Implementations should return this if the element is immutable. The @Immutable annotation should be used on the class to offer additional confirmation of this intent.
• Implementations should return parse(toMap()) if they have state.
• While there may be cases where it is worthwhile to do something more efficient than the conversion to a map and back, this is discouraged because it would add yet another fragile piece of code that breaks when new data is added to the node. The parse and toMap methods already have to be updated in these circumstances, so it makes sense to take advantage of that.

Specified by:

copy in interface ContentNode<Expand,NonNestableBlockContent>

Specified by:

copy in interface Element

Specified by:

copy in interface Marked<Expand,ExpandMark>

Specified by:

copy in interface Node

Returns:

a copy of this element, or this if the element is immutable anyway

elementType

public String elementType()

Description copied from interface: Element

The type value that identifies this element, such as "paragraph" or "strong".

Specified by:

elementType in interface Element

markClass

public Class<ExpandMark> markClass()

Description copied from interface: Marked

Returns the type of marks that may be applied to this node.

Specified by:

markClass in interface Marked<Expand,ExpandMark>

Specified by:

markClass in class AbstractMarkedContentNode<Expand,NonNestableBlockContent,ExpandMark>

Returns:

the type of marks that may be applied to this node, which is the concrete type for the generic type <M> on this interface.

markedContentNodeValidate

protected void markedContentNodeValidate()

Overrides:

markedContentNodeValidate in class AbstractMarkedContentNode<Expand,NonNestableBlockContent,ExpandMark>

validateContentNodeForAppend

protected void validateContentNodeForAppend(NonNestableBlockContent node)

Description copied from class: AbstractContentNode

Called on each content node before it is added to validate that the node can be accepted.

Overrides:

validateContentNodeForAppend in class AbstractContentNode<Expand,NonNestableBlockContent>

Parameters:

node - the node that is about to be added

breakout

public Optional<Breakout> breakout()

breakout

public Expand breakout(@Nullable
                       Breakout breakout)

wide

public Expand wide()

fullWidth

public Expand fullWidth()

defaultWidth

public Expand defaultWidth()

markedContentNodeEquals

protected boolean markedContentNodeEquals(Expand other)

Overrides:

markedContentNodeEquals in class AbstractMarkedContentNode<Expand,NonNestableBlockContent,ExpandMark>

markedContentNodeHashCode

protected int markedContentNodeHashCode()

Overrides:

markedContentNodeHashCode in class AbstractMarkedContentNode<Expand,NonNestableBlockContent,ExpandMark>

appendMarkedContentNodeFields

protected void appendMarkedContentNodeFields(AbstractNode.ToStringHelper buf)

Overrides:

appendMarkedContentNodeFields in class AbstractMarkedContentNode<Expand,NonNestableBlockContent,ExpandMark>

toMap

public Map<String,?> toMap()

Description copied from interface: Element

Transforms this element to a map of String values to various basic object types suitable for direct rendering as JSON content.

Specified by:

toMap in interface Element

Returns:

the map representation of this ADF element