Marks are decorations for ADF nodes that provide additional information about them or alter their appearance in some way. For example, applying a textColor mark to a text node can alter which color is used to display that text.
Marks cannot be assigned arbitrarily. In particular:
Each node type only accepts a specific set of mark types, with many not accepting any marks at all.
Multiple marks with the same mark type are never allowed.
Which marks are allowed may depend on the context. For example, a text node is not allowed to use any marks when it is inside a codeBlock.
Marks can belong to mark categories that restrict their compatibility with other marks. For example, alignment and indentation are both PositionMarks and cannot be used together.
A node is not allowed to have two marks with the same type. Marks cannot be used arbitrarily; they are affiliated with specific node types. There are also cases where marks are restricted by what other marks are present or where the node is located in the document.
Where the marked node has a specialized list of permitted marks, this library uses a marker interface named after the node with a “Mark” suffix. For example, the paragraph node can accept any ParagraphMark.
Some content nodes restrict which marks are allowed on the nodes that they contain. For example, the codeBlock node does not permit the text nodes within it to have any marks at all.
Additional marker interfaces are used to indicate mark categories that may be allowed or disallowed based on the presence of other marks that are present. These categories are: