Package com.atlassian.adf.model.node

Class MediaSingle

java.lang.Object

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

com.atlassian.adf.model.node.AbstractMarkedNode<MediaSingle,MediaSingleMark>

com.atlassian.adf.model.node.MediaSingle

All Implemented Interfaces:

Element, Node, DocContent, LayoutColumnContent, ListItemContent, Marked<MediaSingle,MediaSingleMark>, NestedExpandContent, NonNestableBlockContent, TableCellContent

public class MediaSingle
extends AbstractMarkedNode<MediaSingle,MediaSingleMark>
implements DocContent, LayoutColumnContent, ListItemContent, NestedExpandContent, NonNestableBlockContent, TableCellContent

A container for exactly one media item, optionally followed by a caption. This node enables the display of the content in full, in contrast to a mediaGroup that is intended for a list of attachments. A common use case is to display an image, but it can also be used for videos, or other types of content usually renderable by an @atlaskit/media card component.

Example

Java

 mediaSingle()
     .center()
     .width(50.0)
     .media(
         Media.Media.fileMedia() () fileMedia}()
                 .id("ABC-123")
                 .collection("some-collection-id")
                 .occurrenceKey("some-occurrence-key")
                 .size(640, 480)
     );
 

ADF

   {
     "type": "mediaSingle",
     "content": [
       {
         "type": "media",
         "attrs": {
           "width": 640,
           "height": 480,
           "id": "ABC-123",
           "type": "file",
           "collection": "some-collection-id",
           "occurrenceKey": "some-occurrence-key"
         }
       }
     ],
     "attrs": {
       "layout": "center",
       "width": 50.0
     }
   }
 

Implementation Note

Although `mediaSingle` uses the `content` section to wrap other nodes, its behaviour is very different from most other content nodes in that it can only contain exactly one or two nodes, the first node must be a media node, and (when present) the second node must be a caption. This makes it really hard to do anything useful with the type system, so rather than do something really awkward, this class just doesn't bother to implement ContentNode at all.

See Also:

Node - mediaSingle

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MediaSingle.Partial	Types that represent a partially constructed mediaSingle.
static class	MediaSingle.WidthType	Determines whether the width attribute should be interpreted as a percentage or pixel count.

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.AbstractMarkedNode

marks

Method Summary

Modifier and Type	Method	Description
MediaSingle	alignEnd()
MediaSingle	alignStart()
Stream<Node>	allNodes()	This mimics the behavior of ContentNode.allNodes(), for convenience.
<T extends Node> Stream<T>	allNodesOfType(Class<T> nodeClass)	This mimics the behavior of ContentNode.allNodesOfType(Class).
<T extends Node> List<T>	allNodesOfTypeAsList(Class<T> nodeClass)	This mimics the behavior of ContentNode.allNodesOfTypeAsList(Class).
protected void	appendMarkedNodeFields(AbstractNode.ToStringHelper buf)
void	appendPlainText(StringBuilder sb)	Renders this node as plain-text suitable for viewing by end users.
Optional<Caption>	caption()	Returns the caption for the media item, if set.
MediaSingle	caption(Caption caption)
MediaSingle	caption(CaptionContent captionContent)
MediaSingle	caption(CaptionContent... captionContent)
MediaSingle	caption(Iterable<? extends CaptionContent> captionContent)
MediaSingle	caption(String captionContent)
MediaSingle	caption(String... captionContent)
MediaSingle	caption(Stream<? extends CaptionContent> captionContent)
MediaSingle	center()
MediaSingle	copy()	Returns a deep copy of this element, including copies of any nodes or marks that it contains.
String	elementType()	The type value that identifies this element, such as "paragraph" or "strong".
MediaSingle	fullWidth()
RichMedia.Layout	layout()	Returns the RichMedia.Layout setting for this single media item.
MediaSingle	layout(RichMedia.Layout layout)
MediaSingle	layout(String layout)
Optional<Link>	link()
MediaSingle	link(Link link)
MediaSingle	link(String href)
MediaSingle	mark(MediaSingleMark mark)	Adds the given mark to this marked node.
Class<MediaSingleMark>	markClass()	Returns the type of marks that may be applied to this node.
protected boolean	markedNodeEquals(MediaSingle other)
protected int	markedNodeHashCode()
Media	media()
MediaSingle	media(Media media)
static MediaSingle.Partial.NeedsMedia	mediaSingle()
static MediaSingle	mediaSingle(Media media)
static MediaSingle.Partial.NeedsMedia	mediaSingle(RichMedia.Layout layout)	Creates a new partially constructed mediaSingle node with the given layout.
static MediaSingle	mediaSingle(RichMedia.Layout layout, Media media)	Creates a new mediaSingle node with the given layout and media item.
static MediaSingle	mediaSingle(String layout, Media media)	Creates a new mediaSingle node with the given layout and media item.
Map<String,?>	toMap()	Transforms this element to a map of String values to various basic object types suitable for direct rendering as JSON content.
MediaSingle	wide()
Optional<Number>	width()	Returns the display width for this single media item, if set.
MediaSingle	width(Number width)	Sets the width of the single media node's display.
MediaSingle	widthAsPercentage(Number width)	Sets the width of the single media node's display, as a percentage.
MediaSingle	widthInPixels(Number width)	Sets the width of the single media node's display, as a pixel count.
Optional<MediaSingle.WidthType>	widthType()	Returns the width type, which controls how the width is interpreted.
MediaSingle	wrapLeft()
MediaSingle	wrapRight()

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

appendNodeFields, createMarkHolder, mark, markedNodeValidate, marks, marks, markTypes, nodeEquals, nodeHashCode, parseMarks, unsupportedMarkFactory, validate

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.Element

isSupported, validate

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

toPlainText

Method Detail

mediaSingle

public static MediaSingle.Partial.NeedsMedia mediaSingle()

mediaSingle

public static MediaSingle mediaSingle(Media media)

mediaSingle

public static MediaSingle.Partial.NeedsMedia mediaSingle(RichMedia.Layout layout)

Creates a new partially constructed mediaSingle node with the given layout.

Parameters:

layout - see RichMedia.Layout for explanations of these values

Returns:

a partially constructed mediaSingle node

mediaSingle

public static MediaSingle mediaSingle(String layout,
                                      Media media)

Creates a new mediaSingle node with the given layout and media item.

Parameters:

layout - see RichMedia.Layout for explanations of these values

media - the media node that it should contain

Returns:

the new mediaSingle container, with the given media item as content

mediaSingle

public static MediaSingle mediaSingle(RichMedia.Layout layout,
                                      Media media)

Creates a new mediaSingle node with the given layout and media item.

Parameters:

layout - see RichMedia.Layout for explanations of these values

media - the media node that it should contain

Returns:

the new mediaSingle container, with the given media item as content

width

public Optional<Number> width()

Returns the display width for this single media item, if set.

Returns:

the display width for this single media item, or empty() if not set.

widthType

public Optional<MediaSingle.WidthType> widthType()

Returns the width type, which controls how the width is interpreted. This is always empty when the width is. If the width is set and this still returns empty, then the width is interpreted as a percentage.

width

public MediaSingle width(@Nullable
                         Number width)

Sets the width of the single media node's display. This clears the widthType property, which causes the value to be interpreted as a percentage for backward compatibility.

Parameters:

width - a value from 0.0 to 100.0 (inclusive)

Returns:

this

widthAsPercentage

public MediaSingle widthAsPercentage(@Nullable
                                     Number width)

Sets the width of the single media node's display, as a percentage.

Parameters:

width - a value from 0.0 to 100.0 (inclusive)

Returns:

this

widthInPixels

public MediaSingle widthInPixels(@Nullable
                                 Number width)

Sets the width of the single media node's display, as a pixel count.

Parameters:

width - a non-negative integer

Returns:

this

media

public Media media()

media

public MediaSingle media(Media media)

caption

public Optional<Caption> caption()

Returns the caption for the media item, if set.

Returns:

the caption for the media item, or empty() if not set.

caption

public MediaSingle caption(@Nullable
                           Caption caption)

caption

public MediaSingle caption(String captionContent)

caption

public MediaSingle caption(String... captionContent)

caption

public MediaSingle caption(CaptionContent captionContent)

caption

public MediaSingle caption(CaptionContent... captionContent)

caption

public MediaSingle caption(Iterable<? extends CaptionContent> captionContent)

caption

public MediaSingle caption(Stream<? extends CaptionContent> captionContent)

layout

public RichMedia.Layout layout()

Returns the RichMedia.Layout setting for this single media item.

Returns:

the RichMedia.Layout setting for this single media item.

layout

public MediaSingle layout(String layout)

layout

public MediaSingle layout(RichMedia.Layout layout)

wrapLeft

public MediaSingle wrapLeft()

center

public MediaSingle center()

wrapRight

public MediaSingle wrapRight()

wide

public MediaSingle wide()

fullWidth

public MediaSingle fullWidth()

alignStart

public MediaSingle alignStart()

alignEnd

public MediaSingle alignEnd()

copy

public MediaSingle 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 Element

Specified by:

copy in interface Marked<MediaSingle,MediaSingleMark>

Specified by:

copy in interface Node

Specified by:

copy in class AbstractMarkedNode<MediaSingle,MediaSingleMark>

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

markedNodeEquals

protected boolean markedNodeEquals(MediaSingle other)

Overrides:

markedNodeEquals in class AbstractMarkedNode<MediaSingle,MediaSingleMark>

markedNodeHashCode

protected int markedNodeHashCode()

Overrides:

markedNodeHashCode in class AbstractMarkedNode<MediaSingle,MediaSingleMark>

appendMarkedNodeFields

protected void appendMarkedNodeFields(AbstractNode.ToStringHelper buf)

Overrides:

appendMarkedNodeFields in class AbstractMarkedNode<MediaSingle,MediaSingleMark>

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 AbstractNode<MediaSingle>

Parameters:

sb - where to write the result

markClass

public Class<MediaSingleMark> markClass()

Description copied from interface: Marked

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

Specified by:

markClass in interface Marked<MediaSingle,MediaSingleMark>

Specified by:

markClass in class AbstractMarkedNode<MediaSingle,MediaSingleMark>

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.

mark

public MediaSingle mark(MediaSingleMark mark)

Description copied from interface: Marked

Adds the given mark to this marked node.

Specified by:

mark in interface Marked<MediaSingle,MediaSingleMark>

Overrides:

mark in class AbstractMarkedNode<MediaSingle,MediaSingleMark>

Parameters:

mark - the mark to be added

Returns:

this

link

public MediaSingle link(@Nullable
                        Link link)

link

public MediaSingle link(@Nullable
                        String href)

link

public Optional<Link> link()

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

allNodes

public Stream<Node> allNodes()

This mimics the behavior of ContentNode.allNodes(), for convenience.

Returns:

a stream of this node and the deep expansion of its contents

See Also:

Implementation Note

allNodesOfType

public <T extends Node> Stream<T> allNodesOfType(Class<T> nodeClass)

This mimics the behavior of ContentNode.allNodesOfType(Class).

See Also:

Implementation Note

allNodesOfTypeAsList

public <T extends Node> List<T> allNodesOfTypeAsList(Class<T> nodeClass)

This mimics the behavior of ContentNode.allNodesOfTypeAsList(Class).

See Also:

Implementation Note