Support and Documentation

The following steps outline how to design rich-text elements and attach them to the rich-text editor's toolbar. Although the steps are specific to pull quotes, you can apply them to any custom rich-text element.

Step 1: Extend a rich-text element

All custom rich-text elements extend from RichTextElement.

package content.article;

import com.psddev.cms.db.RichTextElement;
import com.psddev.dari.db.Recordable;
import com.psddev.dari.util.StringUtils;
import java.util.Map;

@Recordable.DisplayName("Pull Quote")
@RichTextElement.Tag(
    value = "quote",
    preview = true,
    block = false,
    root = true,
    menu = "Enhancement")
public class PullQuoteRichTextElement extends RichTextElement {

    @Required
    private String quote;

    public String getQuote() {
        return quote;
    }

    public void setQuote(String quote) {
        this.quote = quote;
    }

    @Override
    public Map<String, String> toAttributes() {
        return null;
    }

    @Override
    public void fromAttributes(Map<String, String> attributes) {
    }

    @Override
    public void fromBody(String body) {
        setQuote(StringUtils.unescapeHtml(body));
    }

    @Override
    public String toBody() {
        return getQuote();
    }

}

In the previous snippet—

Step 2: Attach rich-text element to toolbar

package content.article;

import java.util.Arrays;
import java.util.List;

import com.psddev.cms.rte.RichTextToolbar;
import com.psddev.cms.rte.RichTextToolbarItem;
import com.psddev.cms.rte.RichTextToolbarStyle;

public class CustomRichTextToolbar implements RichTextToolbar {

    @Override
    public List<RichTextToolbarItem> getItems() {
        return Arrays.asList(
            RichTextToolbarStyle.BOLD,
            RichTextToolbarStyle.ITALIC,
            RichTextToolbarStyle.UNDERLINE
            RichTextToolbarStyle.ELEMENTS);
    }

}

In the previous snippet, line 18 attaches all custom rich-text elements to the toolbar. See the illustration Quote element under enhancement toolbar menu.

Step 3: Create Styleguide files

Under your project's styleguide/ directory, create Styleguide files for each field appearing in the rich-text element. For example, if a field body is typed as a rich-text field, then the Styleguide files must provide the template, data file, and styling for the field body. As a best practice, ensure each file's path and base name correspond to the rich-text element's class. The following example provides an illustration for Styleguide files corresponding to the class PullQuoteRichTextElement developed in Step 1.

└── <root>
    ├── src
    |   └── main
    |       └── java
    |           └── brightspot
    |               └── content
    |                   └── article
    |                       └── PullQuoteRichTextElement.java
    └── styleguide
        └── content
            └── article
                ├── PullQuoteRichTextElement.hbs
                ├── PullQuoteRichTextElement.json
                └── PullQuoteRichTextElement.less

For information about creating Styleguide files, see Introduction to Styleguide.

Subclasses of RichTextElement can implement the callbacks required for editing rich-text elements.

The following snippet describes the interaction between the rich-text element and the editing widget.

package brightspot.core.link;

import com.psddev.cms.db.RichTextElement;
import com.psddev.dari.util.CompactMap;
import com.psddev.dari.util.StringUtils;

import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

public class AnotherLinkRichTextElement extends RichTextElement {

    @Required
    private Link link;

    private String linkText;

    public String getLinkText() {
        return linkText;
    }

    public void setLinkText(String linkText) {
        this.linkText = linkText;
    }

    @Override
    public void fromBody(String body) {
        setLinkText(StringUtils.unescapeHtml(body));
    }

    @Override
    public String toBody() {
        return getLinkText();
    }

    @Override
    public void fromAttributes(Map<String, String> attributes) {
        List<Attribute> createdAttributes = attributes.keySet()
                .stream()
                .map(key -> {
                    Attribute attribute = new Attribute();
                    attribute.setName(key);
                    attribute.setValue(attributes.get(key));

                    return attribute;

                })
                .collect(Collectors.toList());

        link.setAttributes(createdAttributes);
    }

    @Override
    public Map<String, String> toAttributes() {
        Map<String, String> htmlAttributes = new CompactMap<>();
        link.getAttributes()
                .forEach(attribute -> htmlAttributes.put(attribute.getName(), attribute.getValue()));
        return htmlAttributes;
    }
}

In the previous snippet—

Brightspot stores rich-text elements in XML format, similar to the following:

{
  "caption": "Here is a link <a href=\"http://www.brightspot.com/\" target=\"_blank\" cursor=\"wait\" type=\"text/html\" >Brightspot</a>."
}

The element and attribute names you can use in a custom rich-text element are arbitrary, so you can design rich-text elements to fit your publishing needs. You then implement runtime parsers in view models that extract the elements and attributes from the database and populate the view.