eZ.RichTextResolveEmbed Class
The Richtext resolve embed processor
Constructor
eZ.RichTextResolveEmbed
()
Item Index
Methods
- _appendContentNode
- _appendLoadingNode
- _buildEmbedMapNodes
- _getEmbedContent
- _getEmbedContentId
- _getEmbedList
- _loadEmbeds
- _renderEmbed
- _renderEmbedContentNode
- _renderLoadingEmbed
- _renderLoadingEmbedElements
- _renderLoadingEmbeds deprecated
- _renderNotLoadedEmbed
- _renderSelectedContent
- _setLoading
- _setNotLoaded
- _unsetLoading
- process
Properties
Methods
_appendContentNode
-
embedNode
Appends the content node to the embed node.
Parameters:
-
embedNode
Node
Returns:
the content node
_appendLoadingNode
-
embedNode
Appends the embed content element when in loading mode.
Parameters:
-
embedNode
Node
_buildEmbedMapNodes
-
embeds
Builds a map between the content id and the embed nodes embedding it.
Parameters:
-
embeds
NodeList
Returns:
_getEmbedContent
-
embedNode
Returns the node representing the embed content.
Parameters:
-
embedNode
Node
Returns:
_getEmbedContentId
-
embedNode
Returns the content id of an embed node
Parameters:
-
embedNode
Node
Returns:
_getEmbedList
-
view
Returns a node list of nodes representing an embed that are not yet been rendered.
Parameters:
-
view
eZ.FieldView | eZ.FieldEditView
Returns:
_loadEmbeds
-
mapNode
-
view
Search for the content that are embed
Parameters:
-
mapNode
Object -
view
eZ.FieldView | eZ.FieldEditView
_renderEmbed
-
mapNode
-
error
-
results
Renders the embed with the search results
Parameters:
-
mapNode
Object -
error
Error | False -
results
Array
_renderEmbedContentNode
-
content
-
embedNode
Renders the content into the embedNode as an embed.
Parameters:
-
content
eZ.Content -
embedNode
Node
_renderLoadingEmbed
-
node
Renders the given embed node as loading
Parameters:
-
node
Node
_renderLoadingEmbedElements
-
mapNode
Renders the embeds in the mapNode
as loading
Parameters:
-
mapNode
Object
_renderLoadingEmbeds
-
embeds
Renders the embed as in loading mode.
Parameters:
-
embeds
NodeList
_renderNotLoadedEmbed
-
mapNode
Renders the embed node referenced in mapNode as not loaded.
Parameters:
-
mapNode
Object
_renderSelectedContent
-
view
-
embedStruct
-
mapNodes
Renders the embed from the embedStruct provided in the event parameters that triggered the process.
Parameters:
-
view
eZ.FieldView | eZ.FieldEditView -
embedStruct
Object -
mapNodes
Object
_setLoading
-
embedNode
Adds the loading class on the embed node
Parameters:
-
embedNode
Node
Returns:
the embedNode
_setNotLoaded
-
embedNode
Sets the embed node in the not loaded state
Parameters:
-
embedNode
Node
_unsetLoading
-
embedNode
Unsets the loading mode by remove the loading class.
Parameters:
-
embedNode
Node
Returns:
embedNode
process
-
view
-
[event]
Resolves the embed by search for the corresponding content by content id.
Parameters:
-
view
eZ.FieldView | eZ.FieldEditView -
[event]
EventFacade optionalthe event parameters (if any) that triggered the process
Properties
_notLoadedMessage
String
protected
Contains the message to display when the embed Content item could not be loaded.