@ConsumerType public interface DAMContentFragment extends ComponentExporter
content fragment component
and the content fragment list component
. The model provides information about the
referenced content fragment and access to representations of its elements.Modifier and Type | Interface and Description |
---|---|
static interface |
DAMContentFragment.DAMContentElement
Represents a content element of a content fragment.
|
Modifier and Type | Field and Description |
---|---|
static String |
JSON_PN_ELEMENTS
Name of the property (in JSON export) that provides an object containing the elements of the
content fragment; the keys of the object properties refer to the element names
|
static String |
JSON_PN_ELEMENTS_ORDER
Name of the property (in JSON export) that provides an array containing the names of the
elements of the content fragment in the correct order
|
static String |
JSON_PN_MODEL
Name of the property (in JSON export) that provides the path to the model of the content fragment
|
Modifier and Type | Method and Description |
---|---|
default @Nullable List<Resource> |
getAssociatedContent()
Returns a list of resources representing the collections that are associated to this content fragment.
|
default @Nullable String |
getDescription()
Returns the description of the content fragment.
|
default @NotNull String |
getEditorJSON()
Returns a JSON format string containing information about this fragment.
|
default @Nullable List<DAMContentFragment.DAMContentElement> |
getElements()
Returns a list of content fragment elements.
|
default @NotNull Map<String,DAMContentFragment.DAMContentElement> |
getExportedElements()
Returns a map of elements that are used for creating the JSON export.
|
default @NotNull String[] |
getExportedElementsOrder()
Returns the names of the elements in the correct order.
|
default @NotNull String |
getExportedType()
Returns the type of the resource for which the export is performed.
|
default @NotNull String |
getName()
Returns the technical name of the content fragment.
|
default @Nullable String |
getTitle()
Returns the title of the content fragment.
|
default @Nullable String |
getType()
Returns the type of the content fragment.
|
static final String JSON_PN_MODEL
static final String JSON_PN_ELEMENTS
static final String JSON_PN_ELEMENTS_ORDER
@Nullable default @Nullable String getTitle()
ContentFragment.getTitle()
@NotNull default @NotNull String getName()
ContentFragment.getName()
@Nullable default @Nullable String getDescription()
ContentFragment.getDescription()
@Nullable default @Nullable String getType()
@Nullable default @Nullable List<DAMContentFragment.DAMContentElement> getElements()
ContentFragment.PN_ELEMENT_NAMES
(in that order, and skipping non-existing
elements). If ContentFragment.PN_ELEMENT_NAMES
is not set, then all elements are returned,
in the order in which they occur in the content fragment.ContentFragment.getElements()
@NotNull default @NotNull Map<String,DAMContentFragment.DAMContentElement> getExportedElements()
ContentFragment.PN_ELEMENT_NAMES
or all elements if the property is not set.@NotNull default @NotNull String[] getExportedElementsOrder()
getExportedElements()
.@Nullable default @Nullable List<Resource> getAssociatedContent()
getAssociatedContent()
@NotNull default @NotNull String getExportedType()
getExportedType
in interface ComponentExporter
@NotNull default @NotNull String getEditorJSON()
Copyright © 2010 - 2020 Adobe. All Rights Reserved