senselogic.sitevision.api.webresource.webcontent

Interface TextModuleCreator

public interface TextModuleCreator

Builder for creating new text modules (text portlets).

Required configuration:

• Parent - the page, layout or portlet where the text module will be created
• Content - the text content and its format

Optional configuration:

• Name - the display name/title of the text module

Usage example:

    import createContentFactory from '@sitevision/api/server/CreateContentFactory';
    // Script module and legacy apps would typically use the require function:
    // const createContentFactory = require('CreateContentFactory');

    const creator = createContentFactory.getTextModuleCreator();
    creator
       .setName('Welcome Message')
       .setParent(pageNode)
       .setMarkdownContent('# Welcome\n\nThis is a **welcome** message.');

    // Optionally check if configuration is valid before executing
    if (creator.isValid()) {
       const node = creator.execute();
    }
 

Permission requirements:

The current user must have permission to update the parent page. An exception will be thrown during execute() if the user lacks the necessary permissions.

An instance of the Sitevision class implementing this interface can be obtained via CreateContentFactory.getTextModuleCreator(). See CreateContentFactory for how to obtain an instance of the CreateContentFactory interface.

Since:

Sitevision 2026.01.1

Author:

Jens Kalshoven

Method Summary

Modifier and Type	Method and Description
Node	execute() Creates the text module with the configured settings.
boolean	isValid() Best-attempt validation of the current builder configuration.
TextModuleCreator	setContent(String aContent, ContentFormat aContentFormat) Sets the content of the text module with an explicit format.
TextModuleCreator	setMarkdownContent(String aMarkdownContent) Sets the content of the text module using Markdown format.
TextModuleCreator	setName(String aName) Sets the display name of the text module to be created.
TextModuleCreator	setParent(Node aParent) Sets the parent node where the text module will be created.

Method Detail

setName

TextModuleCreator setName(String aName)

Sets the display name of the text module to be created.

The name is displayed as the portlet title and should be descriptive.

Parameters:

aName - The name of the text module

Returns:

This builder instance for method chaining

setParent

TextModuleCreator setParent(Node aParent)

Sets the parent node where the text module will be created.

The parent can be either:

• Page (e.g. sv:page, sv:article) - the text module will be appended to the first layout on the page
• Layout (e.g. sv:layout) - the text module will be appended to the layout
• Module (sv:portlet) - the text module will be inserted after the module

This is a required configuration parameter.

Parameters:

aParent - The parent node. Must be a valid page or content node

Returns:

This builder instance for method chaining

setMarkdownContent

TextModuleCreator setMarkdownContent(String aMarkdownContent)

Sets the content of the text module using Markdown format.

This is a convenience method equivalent to calling setContent(aMarkdownContent, ContentFormat.MARKDOWN). The Markdown content will be parsed and converted to rich text elements.

See ContentFormat.MARKDOWN for details on supported syntax.

Parameters:

aMarkdownContent - The Markdown content. Must not be null or empty

Returns:

This builder instance for method chaining

setContent

TextModuleCreator setContent(String aContent,
                             ContentFormat aContentFormat)

Sets the content of the text module with an explicit format.

This method allows you to specify the content and its format explicitly. The content will be parsed according to the specified format and converted to rich text elements.

Parameters:

aContent - The text content. Must not be null or empty

aContentFormat - The format of the content. Must not be null

Returns:

This builder instance for method chaining

isValid

boolean isValid()

Best-attempt validation of the current builder configuration.

Checks if all required parameters are set and valid:

• Parent is not null and is a valid page, layout or portlet
• Content is not null and not empty
• Content format is not null
• The page is not trashed
• The user has permission to update the page

Returns:

true if the configuration is valid, false otherwise

execute

Node execute()
      throws IllegalStateException,
             ConstraintViolationException,
             RepositoryException

Creates the text module with the configured settings.

Important: This method modifies the VersionUtil.OFFLINE_VERSION of the page content and saves the changes. The operation is performed under a lock to ensure consistency.

Returns:

The newly created sv:portlet node

Throws:

IllegalStateException - If the configuration is invalid

ConstraintViolationException - If the parent is invalid, or the user lacks permission to update the page, or the page is trashed

RepositoryException - If something else goes wrong