java.lang.Object
- com.atlassian.adf.model.node.AbstractNode<C>
- - com.atlassian.adf.model.node.AbstractContentNode<Panel,PanelContent>
  - - com.atlassian.adf.model.node.Panel

All Implemented Interfaces:

Element, Node, ContentNode<Panel,PanelContent>, DocContent, LayoutColumnContent, NonNestableBlockContent, TableCellContent
```
public class Panel
extends AbstractContentNode<Panel,PanelContent>
implements DocContent, LayoutColumnContent, NonNestableBlockContent, TableCellContent
```
A container that highlights content as additional information, a warning, or the result of an action.
Example

Java
```
 Panel.info(
         p("Hello world")
 )
 
```
ADF
```
   {
     "type": "panel",
     "attrs": {
       "panelType": "info"
     },
     "content": [
       {
         "type": "paragraph",
         "content": [
           {
             "type": "text",
             "text": "Hello world"
           }
         ]
       }
     ]
   }
 
```
Result

ℹ️ Hello world

Note: This example output is not using AtlasKit to render the panel, so while it gives a vague impression of what a "panel" is, it does not faithfully reproduce the actual presentation in Atlassian products.
See Also:

Node - panel

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Panel.PanelType

static interface Panel.Partial
Types that represent a partially constructed panel.
- 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.AbstractContentNode
  content

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`appendContentNodeFields(AbstractNode.ToStringHelper buf)`	Allows content nodes that have their own fields to augment the `toString()` implementation with their own field values.
`void`	`appendPlainText(StringBuilder sb)`	Renders this node as plain-text suitable for viewing by end users.
`Panel`	`content(String content)`
`Panel`	`content(String... content)`
`Class<PanelContent>`	`contentClass()`	Returns `Class<N>`, the class representing the type of items held by this node.
`protected boolean`	`contentNodeEquals(Panel other)`	Allows content nodes that have their own fields to augment the `equals` implementation with tests for their own field values.
`protected int`	`contentNodeHashCode()`	Allows content nodes that have their own fields to augment the `hashCode` implementation with a hash of their own field values.
`protected void`	`contentNodeValidate()`
`Panel`	`copy()`	Returns a deep copy of this element, including copies of any nodes or marks that it contains.
`Panel`	`custom()`
`static Panel`	`custom(PanelContent content)`
`static Panel`	`custom(PanelContent... content)`
`static Panel`	`custom(Iterable<? extends PanelContent> content)`
`static Panel`	`custom(String content)`
`static Panel`	`custom(String... content)`
`static Panel`	`custom(Stream<? extends PanelContent> content)`
`String`	`elementType()`	The `type` value that identifies this element, such as `"paragraph"` or `"strong"`.
`Panel`	`error()`
`static Panel`	`error(PanelContent content)`
`static Panel`	`error(PanelContent... content)`
`static Panel`	`error(Iterable<? extends PanelContent> content)`
`static Panel`	`error(String content)`
`static Panel`	`error(String... content)`
`static Panel`	`error(Stream<? extends PanelContent> content)`
`Panel`	`info()`
`static Panel`	`info(PanelContent content)`
`static Panel`	`info(PanelContent... content)`
`static Panel`	`info(Iterable<? extends PanelContent> content)`
`static Panel`	`info(String content)`
`static Panel`	`info(String... content)`
`static Panel`	`info(Stream<? extends PanelContent> content)`
`Panel`	`note()`
`static Panel`	`note(PanelContent content)`
`static Panel`	`note(PanelContent... content)`
`static Panel`	`note(Iterable<? extends PanelContent> content)`
`static Panel`	`note(String content)`
`static Panel`	`note(String... content)`
`static Panel`	`note(Stream<? extends PanelContent> content)`
`static Panel.Partial.NeedsPanelType`	`panel()`
`static Panel`	`panel(Panel.PanelType panelType)`
`static Panel`	`panel(Panel.PanelType panelType, PanelContent content)`
`static Panel`	`panel(Panel.PanelType panelType, PanelContent... content)`
`static Panel`	`panel(Panel.PanelType panelType, Iterable<? extends PanelContent> content)`
`static Panel`	`panel(Panel.PanelType panelType, Stream<? extends PanelContent> content)`
`static Panel`	`panel(String panelType)`
`static Panel`	`panel(String panelType, PanelContent content)`
`static Panel`	`panel(String panelType, PanelContent... content)`
`static Panel`	`panel(String panelType, Iterable<? extends PanelContent> content)`
`static Panel`	`panel(String panelType, Stream<? extends PanelContent> content)`
`String`	`panelColor()`
`Panel`	`panelColor(String panelColor)`
`String`	`panelIcon()`
`Panel`	`panelIcon(String panelIcon)`
`String`	`panelIconId()`
`Panel`	`panelIconId(String panelIconId)`
`String`	`panelIconText()`
`Panel`	`panelIconText(String panelIconText)`
`Panel.PanelType`	`panelType()`	Return the panel's type.
`Panel`	`panelType(Panel.PanelType panelType)`
`Panel`	`panelType(String panelType)`
`Panel`	`success()`
`static Panel`	`success(PanelContent content)`
`static Panel`	`success(PanelContent... content)`
`static Panel`	`success(Iterable<? extends PanelContent> content)`
`static Panel`	`success(String content)`
`static Panel`	`success(String... content)`
`static Panel`	`success(Stream<? extends PanelContent> content)`
`Panel`	`tip()`
`static Panel`	`tip(PanelContent content)`
`static Panel`	`tip(PanelContent... content)`
`static Panel`	`tip(Iterable<? extends PanelContent> content)`
`static Panel`	`tip(String content)`
`static Panel`	`tip(String... content)`
`static Panel`	`tip(Stream<? extends PanelContent> content)`
`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(PanelContent node)`	Called on each content node before it is added to validate that the node can be accepted.
`Panel`	`warning()`
`static Panel`	`warning(PanelContent content)`
`static Panel`	`warning(PanelContent... content)`
`static Panel`	`warning(Iterable<? extends PanelContent> content)`
`static Panel`	`warning(String content)`
`static Panel`	`warning(String... content)`
`static Panel`	`warning(Stream<? extends PanelContent> content)`

Methods inherited from class com.atlassian.adf.model.node.AbstractContentNode
addContent, addContentIfPresent, allNodes, appendNodeFields, 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
allNodesOfType, allNodesOfTypeAsList

Methods inherited from interface com.atlassian.adf.model.Element
isSupported, validate

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

- Method Detail
  - validateContentNodeForAppend
```
protected void validateContentNodeForAppend(PanelContent 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<Panel,PanelContent>
    
    Parameters:
    
    node - the node that is about to be added
  - panel
```
public static Panel.Partial.NeedsPanelType panel()
```
  - info
```
public static Panel info(String content)
```
  - info
```
public static Panel info(String... content)
```
  - info
```
public static Panel info(PanelContent content)
```
  - info
```
public static Panel info(PanelContent... content)
```
  - info
```
public static Panel info(Iterable<? extends PanelContent> content)
```
  - info
```
public static Panel info(Stream<? extends PanelContent> content)
```
  - tip
```
public static Panel tip(String content)
```
  - tip
```
public static Panel tip(String... content)
```
  - tip
```
public static Panel tip(PanelContent content)
```
  - tip
```
public static Panel tip(PanelContent... content)
```
  - tip
```
public static Panel tip(Iterable<? extends PanelContent> content)
```
  - tip
```
public static Panel tip(Stream<? extends PanelContent> content)
```
  - note
```
public static Panel note(String content)
```
  - note
```
public static Panel note(String... content)
```
  - note
```
public static Panel note(PanelContent content)
```
  - note
```
public static Panel note(PanelContent... content)
```
  - note
```
public static Panel note(Iterable<? extends PanelContent> content)
```
  - note
```
public static Panel note(Stream<? extends PanelContent> content)
```
  - warning
```
public static Panel warning(String content)
```
  - warning
```
public static Panel warning(String... content)
```
  - warning
```
public static Panel warning(PanelContent content)
```
  - warning
```
public static Panel warning(PanelContent... content)
```
  - warning
```
public static Panel warning(Iterable<? extends PanelContent> content)
```
  - warning
```
public static Panel warning(Stream<? extends PanelContent> content)
```
  - success
```
public static Panel success(String content)
```
  - success
```
public static Panel success(String... content)
```
  - success
```
public static Panel success(PanelContent content)
```
  - success
```
public static Panel success(PanelContent... content)
```
  - success
```
public static Panel success(Iterable<? extends PanelContent> content)
```
  - success
```
public static Panel success(Stream<? extends PanelContent> content)
```
  - error
```
public static Panel error(String content)
```
  - error
```
public static Panel error(String... content)
```
  - error
```
public static Panel error(PanelContent content)
```
  - error
```
public static Panel error(PanelContent... content)
```
  - error
```
public static Panel error(Iterable<? extends PanelContent> content)
```
  - error
```
public static Panel error(Stream<? extends PanelContent> content)
```
  - custom
```
public static Panel custom(String content)
```
  - custom
```
public static Panel custom(String... content)
```
  - custom
```
public static Panel custom(PanelContent content)
```
  - custom
```
public static Panel custom(PanelContent... content)
```
  - custom
```
public static Panel custom(Iterable<? extends PanelContent> content)
```
  - custom
```
public static Panel custom(Stream<? extends PanelContent> content)
```
  - panel
```
public static Panel panel(String panelType)
```
    Returns:
    
    a new, empty panel of the given type. At least one content item must be added to make it valid.
  - panel
```
public static Panel panel(Panel.PanelType panelType)
```
    Returns:
    
    a new, empty panel of the given type. At least one content item must be added to make it valid.
  - panel
```
public static Panel panel(String panelType,
                          PanelContent content)
```
    Returns:
    
    a new panel with the given type and content
  - panel
```
public static Panel panel(String panelType,
                          PanelContent... content)
```
    Returns:
    
    a new panel with the given type and content
  - panel
```
public static Panel panel(String panelType,
                          Iterable<? extends PanelContent> content)
```
    Returns:
    
    a new panel with the given type and content
  - panel
```
public static Panel panel(String panelType,
                          Stream<? extends PanelContent> content)
```
    Returns:
    
    a new panel with the given type and content
  - panel
```
public static Panel panel(Panel.PanelType panelType,
                          PanelContent content)
```
    Returns:
    
    a new panel with the given type and content
  - panel
```
public static Panel panel(Panel.PanelType panelType,
                          PanelContent... content)
```
    Returns:
    
    a new panel with the given type and content
  - panel
```
public static Panel panel(Panel.PanelType panelType,
                          Iterable<? extends PanelContent> content)
```
    Returns:
    
    a new panel with the given type and content
  - panel
```
public static Panel panel(Panel.PanelType panelType,
                          Stream<? extends PanelContent> content)
```
    Returns:
    
    a new panel with the given type and content
  - content
```
public Panel content(String content)
```
  - content
```
public Panel content(String... content)
```
  - panelType
```
public Panel.PanelType panelType()
```
    Return the panel's type.
    
    Returns:
    
    the panel's type.
  - panelIconId
```
public String panelIconId()
```
  - panelIcon
```
public String panelIcon()
```
  - panelColor
```
public String panelColor()
```
  - panelIconText
```
public String panelIconText()
```
  - panelType
```
public Panel panelType(String panelType)
```
  - panelType
```
public Panel panelType(Panel.PanelType panelType)
```
  - panelIconId
```
public Panel panelIconId(String panelIconId)
```
  - panelIcon
```
public Panel panelIcon(String panelIcon)
```
  - panelColor
```
public Panel panelColor(String panelColor)
```
  - panelIconText
```
public Panel panelIconText(String panelIconText)
```
  - info
```
public Panel info()
```
  - note
```
public Panel note()
```
  - tip
```
public Panel tip()
```
  - warning
```
public Panel warning()
```
  - error
```
public Panel error()
```
  - success
```
public Panel success()
```
  - custom
```
public Panel custom()
```
  - contentClass
```
public Class<PanelContent> 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<Panel,PanelContent>
  - copy
```
public Panel 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<Panel,PanelContent>
    
    Specified by:
    
    copy in interface Element
    
    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
  - contentNodeHashCode
```
protected int contentNodeHashCode()
```
    Description copied from class: AbstractContentNode
    
    Allows content nodes that have their own fields to augment the hashCode implementation with a hash of their own field values.
    Implementations need not include the node's class; that is already covered by AbstractNode.hashCode(). Implementations need not include the content, either; that is already covered by AbstractNode.nodeHashCode(), which is expected to be this method's only consumer.
    Just as with the relationship between hashCode, equals, and toString for ordinary Java classes, subclasses of AbstractContentNode should maintain consistent implementations of contentNodeHashCode, contentNodeEquals, and appendContentNodeFields.
    
    Overrides:
    
    contentNodeHashCode in class AbstractContentNode<Panel,PanelContent>
    
    Returns:
    
    the hash code of any additional field values that belong to a particular type of content node.
    
    See Also:
    
    AbstractContentNode.contentNodeEquals(AbstractContentNode), AbstractContentNode.appendContentNodeFields(ToStringHelper)
  - contentNodeEquals
```
protected boolean contentNodeEquals(Panel other)
```
    Description copied from class: AbstractContentNode
    
    Allows content nodes that have their own fields to augment the equals implementation with tests for their own field values.
    Implementations need not check for identity, null, or a different node class; those are already covered by AbstractNode.equals(Object). Implementations need not check the AbstractContentNode.content(), either; that is already covered by AbstractContentNode.nodeEquals(AbstractContentNode), which is expected to be this method's only consumer.
    Just as with the relationship between hashCode, equals, and toString for ordinary Java classes, subclasses of AbstractContentNode should maintain consistent implementations of contentNodeHashCode, contentNodeEquals, and appendContentNodeFields.
    
    Overrides:
    
    contentNodeEquals in class AbstractContentNode<Panel,PanelContent>
    
    Returns:
    
    true if all additional field values that belong to a particular type of content node test as equal; false if differences are found
    
    See Also:
    
    AbstractContentNode.contentNodeHashCode(), AbstractContentNode.appendContentNodeFields(ToStringHelper)
  - appendContentNodeFields
```
protected void appendContentNodeFields(AbstractNode.ToStringHelper buf)
```
    Description copied from class: AbstractContentNode
    
    Allows content nodes that have their own fields to augment the toString() implementation with their own field values.
    Each field's value should be provided by calling AbstractNode.ToStringHelper.appendField(String, Object). The value may be null, in which case the field is omitted, for brevity. It will handle array values gracefully, including arrays of primitive types.
    Just as with the relationship between hashCode, equals, and toString for ordinary Java classes, subclasses of AbstractContentNode should maintain consistent implementations of contentNodeHashCode, contentNodeEquals, and appendContentNodeFields.
    
    Overrides:
    
    appendContentNodeFields in class AbstractContentNode<Panel,PanelContent>
    
    Parameters:
    
    buf - where the field values should be written
    
    See Also:
    
    AbstractContentNode.contentNodeHashCode(), AbstractContentNode.contentNodeEquals(AbstractContentNode)
  - contentNodeValidate
```
protected void contentNodeValidate()
```
    Overrides:
    
    contentNodeValidate in class AbstractContentNode<Panel,PanelContent>
  - 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
  - appendPlainText
```
public void appendPlainText(StringBuilder sb)
```
    Description copied from interface: Node
    
    Renders this node as plain-text suitable for viewing by end users. This is equivalent to calling Node.toPlainText() and appending the result to the given buffer, except that it may be slightly more efficient, since it will write directly to the existing buffer instead of using a temporary buffer and having to make a copy of the result.
    
    Specified by:
    
    appendPlainText in interface Node
    
    Overrides:
    
    appendPlainText in class AbstractContentNode<Panel,PanelContent>
    
    Parameters:
    
    sb - where to write the result

Modifier and Type	Class	Description
`static class`	`Panel.PanelType`
`static interface`	`Panel.Partial`	Types that represent a partially constructed `panel`.

Class Panel

Example

Java

ADF

Result

Nested Class Summary

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

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

Field Summary

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

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

Method Detail

validateContentNodeForAppend

panel

info

info

info

info

info

info

tip

tip

tip

tip

tip

tip

note

note

note

note

note

note

warning

warning

warning

warning

warning

warning

success

success

success

success

success

success

error

error

error

error

error

error

custom

custom

custom

custom

custom

custom

panel

panel

panel

panel

panel

panel

panel

panel

panel

panel

content

content

panelType

panelIconId

panelIcon

panelColor

panelIconText

panelType