Content modeling annotations

import com.psddev.cms.db.Content;
import com.psddev.cms.ui.form.ClearOnPlaceholderChange;
import com.psddev.cms.ui.form.EditablePlaceholder;
import com.psddev.cms.ui.form.Placeholder;

public class Article extends Content {

    @Placeholder("Today's headline: ")
    @ClearOnPlaceholderChange(false) 
    @EditablePlaceholder(true)
    private String headline;

}

• When an editor starts typing in the field Headline, ensures the placeholder text is not cleared.

import com.psddev.cms.db.Content;

@Content.Searchable(false) 
public class Article extends Content {

}

• Excludes all matching instances of Article from search results.

import com.psddev.cms.db.Content;
import content.article

@Content.Searchable 
public class Recipe extends Article { 

}

• Sets @Content.Searchable to true, reversing the effect of the inherited annotation. As a result, recipes are included in the search results.
• Specifies that Recipe extends from Article, which implies that Recipe objects are also excluded from search results as indicated in the previous snippet.

@Indexed
@ToolUi.Filterable
@ToolUi.CssClass("is-minimal")
@DateTimeRangeGroups({DateTimeRange.FUTURE_RANGE})
private Date dueDate;

• Lists date ranges in the future.

import brightspot.core.person.AuthorableData;
import com.psddev.cms.db.ToolUi;
import com.psddev.cms.ui.form.DynamicField;
import com.psddev.dari.db.ObjectField;
import com.psddev.dari.db.Recordable;

public class ArticleBodyDynamicField implements DynamicField {

    @Override
    public void update(Recordable record, ObjectField field) { 
        field.as(ToolUi.class).setReadOnly(record.as(Article.class).getAuthors().isEmpty()); 
    }
}

• Callback that runs when the content edit form is loaded, with every save, and with every work-in-process save.
• Checks if the passed record has any authors. If not, the field annotated with this class is rendered as read-only. This line uses the method getAuthors declared in the snippet that follows this one.

import brightspot.core.person.Author;
import com.psddev.cms.db.Content;
import com.psddev.cms.ui.form.DynamicFieldClass;

public class Article extends Content {

    private String headline;

    @DynamicFieldClass(ArticleBodyDynamicField.class) 
    private Body body;

    private List<Author> authors;

    public List<Author> getAuthors() { 
        return authors;
    }
}

• Applies the annotation from the snippet before this one.
• Provides a list of authors.

import com.psddev.cms.ui.form.DynamicNote;
import com.psddev.dari.db.ObjectField;
import com.psddev.dari.db.Recordable;

public class ArticleDynamicNote implements DynamicNote {

    @Override
    public Object get(Recordable record, ObjectField field) { 
        Integer numStories = methodReturningNumberStoriesByTag("asteroids");
        return "We already have " + numStories.toString() + " articles about asteroids. Please focus on a different topic.";

    }
}

• Callback that runs when the content edit form is loaded.

import com.psddev.cms.ui.form.DynamicNote;
import com.psddev.dari.db.ObjectField;
import com.psddev.dari.db.Recordable;

public class ArticleHeadlineDynamicNote implements DynamicNote {
    @Override
    public Object get(Recordable record, ObjectField field) { 
        Date today = new Date();
        SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("MMMM dd, yyyy");
        String date = DATE_FORMAT.format(today);
        return ("Ensure your facts are correct as of " + date.toString() + ".");
    }
}

• Callback that runs when the content edit form is loaded.

import com.psddev.cms.db.Content;
import com.psddev.cms.ui.form.DynamicNoteClass;

@DynamicNoteClass(ArticleDynamicNote.class) 
public class Article extends Content {

    @DynamicNoteClass(ArticleHeadlineDynamicNote.class) 
    private String headline;

}

import com.psddev.cms.db.Content;
import com.psddev.cms.ui.form.DynamicNoteMethod;

@DynamicNoteMethod("classNote") 
public class Article extends Content {

    @DynamicNoteMethod("headlineNote") 
    private String headline;

    private String classNote() { 
         Integer numStories = methodReturningNumberStoriesByTag("asteroids");
        return "We already have " + numStories.toString() + " articles about asteroids. Please focus on a different topic.";
    }

    private String headlineNote() { 
        Date today = new Date();
        SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("MMMM dd, yyyy");
        String date = DATE_FORMAT.format(today);
        return ("Ensure your facts are correct as of " + date.toString() + ".");

    }
}

• Annotation specifying the classNote method for displaying a note at the top of the content edit form.
• Annotation specifying the headlineNote method for displaying a note for the Headline field.
• Method that returns a dynamic string.
• Method that returns a dynamic string.

import com.psddev.cms.ui.form.DynamicPlaceholder;
import com.psddev.dari.db.ObjectField;
import com.psddev.dari.db.Recordable;

public class ArticleHeadlineDynamicPlaceholder implements DynamicPlaceholder {

    @Override
    public String get(Recordable record, ObjectField field) { 
        DateFormat dateFormat = new SimpleDateFormat("yyyy/MM/dd");
        Date date = new Date();
        return "Hockey scores as of " + dateFormat.format(date);
    }
}

• Callback that runs when the content edit form is loaded. This method returns a string.

import com.psddev.cms.db.Content;
import com.psddev.cms.ui.form.DynamicPlaceholderClass;

public class Article extends Content {

    @DynamicPlaceholderClass(ArticleHeadlineDynamicPlaceholder.class) 
    private String headline;

}

• Applies the annotation from the snippet above.

import com.psddev.cms.db.Content;
import com.psddev.cms.ui.form.DynamicPlaceholderMethod;

public class Article extends Content {

    @DynamicPlaceholderMethod("currentDate") 
    private String headline;

    private String currentDate() { 
        DateFormat dateFormat = new SimpleDateFormat("yyyy/MM/dd");
        Date date = new Date();
        return "Hockey scores as of " + dateFormat.format(date);
    }
}

• Annotation specifying the currentDate method for populating the placeholder text.
• Method that returns a dynamic string.

import com.psddev.cms.db.TabDisplayMode;
import com.psddev.cms.db.ToolUi;
import com.psddev.cms.ui.form.DynamicType;
import com.psddev.dari.db.ObjectType;
import com.psddev.dari.db.Recordable;

public class ArticleDynamicType implements DynamicType {

    @Override
    public void update(ObjectType type, Recordable record) { 
        if (record.as(Article.class).getAuthors().isEmpty()) { 
            type.as(ToolUi.class).setTabDisplayMode(TabDisplayMode.TABS);
        } else {
            type.as(ToolUi.class).setTabDisplayMode(TabDisplayMode.MENU);
        }
    }
}

• Callback that runs when the content edit form is loaded and with every save.
• Checks if the passed record has any authors. If there are no authors, the content edit form has a hotdog menu with a list of tabs. If there are any authors, the content edit form explicitly displays the tabs. This line uses the method getAuthors declared in the snippet below (Applying a dynamic class annotation).

import brightspot.core.person.Author;
import com.psddev.cms.db.Content;
import com.psddev.cms.ui.form.DynamicTypeClass;

@DynamicTypeClass(ArticleDynamicType.class) 
public class Article extends Content {

    private List<Author> authors;

    public List<Author> getAuthors() { 
        return authors;
    }
}

• Applies the annotation from the snippet above.
• Provides a list of authors.

import com.psddev.cms.db.Content;
import com.psddev.cms.ui.form.EditablePlaceholder;
import com.psddev.cms.ui.form.Placeholder;

public class Article extends Content {

    @Placeholder("Today's headline: ")
    @EditablePlaceholder 
    private String headline;

}

• When an editor applies focus to the field Headline, the cursor is positioned after the placeholder text.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;
import com.psddev.cms.ui.form.HtmlNote;
import com.psddev.dari.util.StorageItem;

@HtmlNote("<span>Contact <a href=\"mailto:abraun@brightspot.com\">abraun@brightspot.com</a> for technical support.</span>") 
public class Article extends Content {

    @HtmlNote("<span style=\"font-weight: bold\">Hint</span> Drag files here.") 
    @ToolUi.BulkUpload
    private StorageItem image;

}

• Displays a note at the top of the content edit form.
• Displays a note adjacent to the Image field.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;
import com.psddev.cms.ui.form.Note;
import com.psddev.dari.util.StorageItem;

@Note("Please, no more articles about asteroid impacts...") 
public class Article extends Content {

    @Note("Drag files here") 
    @ToolUi.BulkUpload
    private StorageItem image;

}

• Displays a note at the top of the content edit form.
• Displays a note adjacent to the Image field.

import com.psddev.cms.db.Content;
import com.psddev.cms.ui.form.Placeholder;

public class TestArticle extends Content {

    @Placeholder("Write your headline here.") 
    private String headline;

}

• Displays placeholder text in the Headline field.

<div class="h1">
    Massive Rogue Asteroid
    <div class="h2"> 
        on Course to Destroy
    </div>
    All Life in Van Nuys, CA
</div>

• Child element <div class="h2">on Course to Destroy</div>is nested within a parent element <div class="h1">Massive Rogue Asteroid All Life in Van Nuys, CA</div>

import com.psddev.cms.db.RichTextElement;
import com.psddev.dari.db.Recordable;

@RichTextElement.Exclusive 
public interface ElementsWithoutNesting extends Recordable { 
}

• Applies the annotation @RichTextElement.Exclusive to the interface.
• Declares a marker interface.

import com.psddev.cms.db.RichTextElement;
import com.psddev.dari.db.Recordable;

@Recordable.DisplayName("Heading 1")
@RichTextElement.Tag(
        value = "h1",
        preview = true,
        block = false)
public class HeadingOneRichTextElement extends RichTextElement implements ElementsWithoutNesting { 

    @Required
    private String heading1;

    public String getHeading1() {
        return heading1;
    }

    public void setHeading1(String heading1) {
        this.heading1 = heading1;
    }
}

• Specifies the marker interface you created in Step 1. When editors concatenate an implementing rich-text element after another implementing rich-text element, Brightspot closes the original element and opens the new element. See the following snippet.

<div class="h1">
    Massive Rogue Asteroid on Course
</div>
<div class="h2">
    to Destroy All Life in Van Nuys, CA
</div>

import com.psddev.cms.db.RichTextElement;
import com.psddev.dari.db.Recordable;

@Recordable.DisplayName("Pull Quote") 
@RichTextElement.Tag(value = "quote", 
    block = true, 
    initialBody = "Meaningful quote here", 
    menu = "Tools", 
    preview = true,
    readOnly = true,
    root = true,
    keymaps = {"Ctrl-I"}, 
    tooltip = "Add pull quote (Ctrl-I)" 
)
public class PullQuoteRichTextElement extends RichTextElement {

}

• Specifies the label of the rich-text element’s menu item.
• Generates tags around the rich-text element at run time.
• Sets the rich-text element in its own line.
• Specifies the initial text in the rich-text element’s widget.
• Places menu item under the top-level Tools menu.
• Maps the keyboard shortcut Ctrl-I to opening the rich-text element’s widget.
• Displays a tool tip.

import brightspot.core.tool.SmallRichTextToolbar;
import com.psddev.cms.db.Content;
import com.psddev.cms.db.RichTextElement;
import com.psddev.cms.db.ToolUi;

public class Article extends Content {

    @ToolUi.RichText(inline = false, toolbar = SmallRichTextToolbar.class) 
    @RichTextElement.Tags({KlingonRichTextElement.class}) 
    public String body;

}

• Renders the text field as a rich-text editor with a standard toolbar. The element inline = false is mandatory.
• Adds a custom rich-text element to the toolbar.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.Seo;

@Seo.DescriptionFields({"headline"}) 
public class Article extends Content implements Seo {

    private String headline;

}

• Specifies using the value of the model’s headline field as the value for the SEO tab’s Description field.

String seoDescription = 
model.as(Seo.ObjectModification.class).findDescription();

<meta property="description" content="Squashed by Earth's Gravity, Aliens Demand Submission">

import com.psddev.cms.db.Content;
import com.psddev.cms.db.Seo;

@Seo.KeywordsFields({"headline"}) 
public class Article extends Content {

    private String headline;

}

• Includes the value of the model’s headline field as a source for keywords.

Set<String> seoKeywords = 
model.as(Seo.ObjectModification.class).findKeywords();

<meta name="keywords" content="olive onion garlic pineapple pepperoni anchovy mushroom" />

import com.psddev.cms.db.Content;
import com.psddev.cms.db.Seo;

@Seo.OpenGraphType("title") 
public class Article extends Content {

    private String headline;

}

• Specifies the Open Graph type is title.

String seoOpenGraphType = model.getState().getType().as(Seo.TypeModification.class).getOpenGraphType();

<meta property="og:title" content="Squashed by Earth's Gravity, Aliens Demand Submission" />

import com.psddev.cms.db.Content;
import com.psddev.cms.db.Seo;

@Seo.TitleFields({"headline"}) 
public class Article extends Content {

    private String headline;

}

• Specifies using the value of the model’s <headline> field as the value for the SEO tab’s Title field.

String titleString = model.as(Seo.ObjectModification.class).findTitle();

<meta property="title" content="Squashed by Earth's Gravity, Aliens Demand Submission"</meta>

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.AddToTop 
    private List<Article> relatedArticles; 

}

• Opens entries in the selection field on top of the existing entries.
• Renders a selection field for selecting items of type Article.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;
import com.psddev.dari.db.Recordable;
import com.psddev.dari.util.StorageItem;

@Recordable.PreviewField("image") 
public class Image extends Content  { 

    private String caption;

    @ToolUi.BulkUpload 
    private StorageItem image;

}

• Indicates which of the model’s fields is the preview field. This annotation is required for bulk uploading.
• Indicates users can drag and drop files from their desktops onto the field Image in the content edit form.

import com.psddev.cms.db.Content;
import java.util.List;

public class Gallery extends Content  {

    private String headline;

    private List<Image> image; 

}

• Establishes the field image as a list of Images—the same field annotated with @ToolUi.BulkUpload above.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.Cluster("Summary text") 
    private String headline;

    @ToolUi.Cluster("Summary text")
    private String headlineShort;

    @ToolUi.Cluster("Summary text")
    private String leadIn;

    private Author author; 
}

• Specifies a cluster heading Summary text as an accordion for the fields headline, headlineShort, and leadIn.
• Because the field author has no cluster heading, it appears first in the content edit form.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.ClusterDisplayOrder(tab="Main",alphabetize=true) 
public class Article extends Content {

    private String headline; 
    private String body;
    private String author;

    @ToolUi.Cluster("Markets") 
    private String state;

    @ToolUi.Cluster("Markets")
    private String county;

    @ToolUi.Cluster("Markets")
    private String city;

    @ToolUi.Cluster("Demographics") 
    private String gender;

    @ToolUi.Cluster("Demographics")
    private String age;

    @ToolUi.Cluster("Demographics")
    private String occupation;

}

• Specifies that the clusters are sorted alphabetically such that Demographics appears first, overriding the default that Markets be the topmost cluster.
• Defines three fields without a @ToolUi.Cluster annotation; these fields appear first in the content edit form.
• Defines three fields appearing under the cluster Markets. By default, Markets is the topmost cluster because it is appears first in the model.
• Defines three fields appearing under the cluster Demographics.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.ClusterDisplayOrder(tab="Main",alphabetize=true)
@ToolUi.ClusterDisplayOrder(tab="Marketing",alphabetize=true)
@ToolUi.ClusterDisplayOrder(tab="Sales History",start="First Contact Info", end="Latest Contact Info") 
public class Article extends Content {

    /* Fields with annotations @ToolUi.Tab and @ToolUi.Cluster. */

}

• Applies the annotation @ToolUi.ClusterDisplayOrder multiple times to the same model.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.CodeType("text/xml") 
    private String xmlText;

}

• Applies XML syntax highlighting to text in the field xmlText.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class HeadlineProgress extends Content {

    private String headline;

    @ToolUi.CollectionItemProgress 
    private double progressBar;

    public void setProgressBar(double progressBar) {
        this.progressBar = progressBar;
    }

    @Override 
    protected void beforeSave() {
        setProgressBar(0.5d);
    }

}

• Displays a progress bar in the content edit form for the current object.
• Updates the value of the progress bar at the beforeSaveevent. In a typical scenario, you write a function that provides a descriptive state of the object as a percentage, such as number of views as a percent of a goal.

import com.psddev.cms.db.Content;

public class ArticleWithHeadlineProgress extends Content {

    private String category;

    @Embedded 
    private List<HeadlineProgress> headlines; 

}

• Embeds the child model. This annotation is required to display progress bars.
• Declares a List of the child model.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;
import com.psddev.dari.util.StorageItem;

public class VideoWithToggles extends Content {

    private String title;

    private StorageItem video;

    @ToolUi.CollectionItemWeight(calculated = false) 
    private double weight;

    @ToolUi.CollectionItemToggle(value = false) 
    private boolean onff;

}

• Displays a weight in the item bar for the current object.
• Displays a toggle for the current object. You can use these toggles to preview the impact on percentage weights when deleting an item.

import com.psddev.cms.db.Content;

public class PlayListWithItemToggle extends Content {

    private String title;

    @Embedded 
    private List<VideoWithToggles> videos; 

}

• Embeds the child model. This annotation is required to display toggles.
• Declares the field videos as a List of the child model.

import com.psddev.cms.db.ToolUi;
import com.psddev.dari.db.Record;

public class Headline extends Record {

    private String headline;

    @ToolUi.CollectionItemWeight(calculated = false) 
    private double weight;

}

• Displays an item bar with handles.

import com.psddev.cms.db.Content;

public class ArticleWithHeadlineWeights extends Content {

    private String title;

    @Embedded 
    private List<Headline> headlines; 

}

• Embeds the child model. This annotation is required to display weights.
• Declares the field headlines as a List of the child model.

import com.psddev.cms.db.ToolUi;
import com.psddev.dari.db.Record;

public class Headline extends Record  {

    @ToolUi.CollectionItemWeight(calculated = true)
    private double weight;

    @ToolUi.CollectionItemWeightColor 
    private String weightColor = "#007D7D";

}

• Sets the color for all weights to #007D7D (close to teal).

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;
import com.psddev.dari.util.StorageItem;

public class VideoWithMarkers extends Content {

    private String title;

    private StorageItem video;

    @ToolUi.CollectionItemWeightMarker 
    private List<Double> markers;

    @ToolUi.CollectionItemWeight(calculated = true) 
    private double weight;

    public List<Double> getMarkers() { 
        if (markers == null) {
            markers = new ArrayList<>();
        }
        return markers;
    }

    @Override 
    protected void beforeSave() {
        getMarkers().addAll(Arrays.asList(0.25d, 0.50d, 0.75d));
    }
}

• Indicates the List of markers appears as dots inside the item bar. Each element inside the List represents a decimal percentage from 0.0 to 1.0.
• Displays the weight for the current item in the item bar.
• Provides a non-null getter for the list of markers.
• Adds markers at 25%, 50%, and 75% of the width of the item’s weight at the beforeSave event.

import com.psddev.cms.db.Content;

public class PlayListWithWeights extends Content {

    private String title;

    @Embedded 
    private List<VideoWithMarkers> videos; 

}

• Embeds the child model. This annotation is required to display markers.
• Declares the field videos as a List of the child model declared in Item weight markers—child model.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.ColorPicker 
    private String hexColor;

}

• Renders the field hexColor as a color picker.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.CompatibleTypes({LongArticle.class,ReallyLongArticle.class}) 
public class Article extends Content  {

}

• Indicates that Article models can be transformed to LongArticle and ReallyLongArticle models.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.CssClass("text-green") 
    private String headline;

    private String subHeadline; 

}

• Renders the field headline in the content edit form using the CSS class text-green.
• Renders the field subHeadline in the content edit form using the default styling.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.DefaultSearchResult 
    private Author author;

}

• Ensures that when an editor filters search results by Article, the results include a column for author.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.DefaultSortField("author") 
public class Article extends Content  {

    @Indexed 
    private String author;

}

• Indicates that when users filter on Articles in the search panel, the initial sort is by the author field.
• Indexes the author field. This annotation is required to sort the field.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    private String headline;
    private String body;

    @ToolUi.DisplayAfter({"lastName","body"})
    private String firstName;

    private String lastName;
    private String middleName;

}

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;
import com.psddev.dari.util.StorageItem;

public class Article extends Content  {

    private String headline;
    private String body;

    @ToolUi.DisplayBefore({"body","lastName"})
    private String firstName;

    private String lastName;
    private String middleName;

    private StorageItem image;

}

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    private String headline;

    private String body;

    @ToolUi.DisplayFirst
    private String author;

}

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.DisplayGlobalFilters 
public class Author extends Content  {

}

• Specifies that when an editor filters on Authors, a control appears for filtering on any other model with the @ToolUi.GlobalFilter annotation.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.GlobalFilter 
public class Article extends Content  {

}

• Specifies that a control for filtering on Articles appears when editors filter on Authors (or on All Content Types).

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.DisplayGrid 
    private List<StorageItem> slides;

}

• Specifies that the files in a slides field are laid out as a grid in the content edit form.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.DisplayLast
    private String author;

    private String headline;

    private String body;

}

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.DropDown(value=true,sortField="lastName") 
    private Author author;

}

• Renders the Author field as a traditional drop-down list.

import brightspot.core.lead.Lead;
import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;
import com.psddev.theme.StyleEmbeddedContentCreator;

public class AnotherArticle extends Content {

    @ToolUi.EmbeddedContentCreatorClass(StyleEmbeddedContentCreator.class) 
    private Lead lead;

}

• Renders a style picker for the field lead.

import com.psddev.cms.db.ToolUi;

@Content.Searchable 
@ToolUi.ExcludeFromGlobalSearch 
public class Article extends Content {

}

• Ensures Solr indexes instances of Article.
• Excludes instances of Article from the results in the search panel.

import com.psddev.cms.db.ToolUi;
import content.article

@Content.ExcludeFromGlobalSearch(false) 
public class Recipe extends Article { 

}

• Sets @ToolUi.ExcludeFromGlobalSearch to false, reversing the effect of the inherited annotation and including instances of Recipe in the search results.
• Specifies that Recipe extends from Article (the class declared in the snippet Class excluded from search panel). Therefore, Solr indexes instances of Recipe objects but excludes them from results in the search panel.

package content.article;

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Author extends Content { 

    private String lastName;

    private String firstName;

}

• Declares a child model Author with two fields: lastName and firstName.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  { 

    @Embedded 
    @ToolUi.Expanded 
    private List<Author> authors; 

}

• Declares a parent model Article that contains the child model Author.
• Embeds the child model.
• Ensures the form for entering an author is always expanded.
• Declares a field subclassed from Collection<record>.

import com.psddev.cms.tool.ExternalItemSort;
import com.psddev.dari.db.Query;
import com.psddev.dari.util.StringUtils;

public enum ProviderSort implements ExternalItemSort {

    BEST_MATCH, 
    MOST_POPULAR,
    NEWEST,
    RANDOM;

    @Override 
    public String getOperator() {
        return name();
    }

    @Override 
    public String toString() {
        return StringUtils.toLabel(name());
    }

    @Override 
    public void sort(Query<?> query) {
        /* Optional custom sort function. */
    }

}

• Declares sort options.
• Implements the method getOperator. Brightspot places the result of this method in the data-value attribute of an element.
• Overrides the Object.toString method. Brightspot places the result of this method as the value of a tag. This example uses Dari’s StringUtils#toLabel method; see StringUtils for other available string manipulation methods.
• Optionally overrides the sorting of the sort options. The default sorting is by the results of the method getOperator.

package article;

import com.psddev.cms.db.ExternalItem;
import com.psddev.cms.db.ToolUi;
import com.psddev.dari.db.Recordable;
import com.psddev.id.SomeDatabaseProvider;

@Recordable.SourceDatabaseProviderClass(SomeDatabaseProvider.class) 
@ToolUi.ExternalItemSortClass(ProviderSort.class) 
public class SomeImageProvider extends ExternalItem {

}

• Specifies the class providing the connection to the external provider.
• Applies the sorted labels using the enum defined in the snippet "Enum for sorting external items."

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.FieldDisplayOrder({"author", "headline", "body"}) 
public class Article extends Content  {

    private String headline;

    private String body;

    private String author;

}

• Specifies that the first three fields in the content edit form are author, headline, and body (in that order).

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.FieldDisplayPreview({"headline"})
public class Article extends Content {

    private String headline;

    private String subHeadline;
}

• Specifies that the field headline appears in the Quick View widget for objects of type Article.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Author extends Content  {

    @ToolUi.FieldDisplayType("password") 
    private String yourPassword;

}

• Renders the String field as a password changer.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.FieldSorted 
    private Set<Author> authors;

}

• Specifies that when displaying an Article in the content edit form, the order of listed authors does not change.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Author extends Content  {

    @ToolUi.Filterable
    @Indexed
    private String headline;

    @Indexed
    private String body;

    @Indexed
    private Author author;

    @ToolUi.Filterable(false)
    @Indexed
    private Image image;

}

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.GlobalFilter 
public class Article extends Content  {

}

• Displays a control for filtering by Articles when an editor is filtering search results by All Content Types.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    private String headline;

    @ToolUi.Hidden 
    private String author;

    private String body;

}

• Suppresses display of the author field in the content edit form.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.IconName(value="face") 
public class Author extends Content  {

}

• Displays Material Design’s face icon for the content type Author in the Quick Start widget.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Video extends Content {

    @ToolUi.InputProcessorPath("/path/duration.jsp") 
    @ToolUi.ReadOnly
    private Long duration;

}

• Specifies the path to the widget used to compute a video’s duration. Inside the Brightspot express project, the file’s path is brightspot/express/frontend/src/main/webapp/path/duration.jsp.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content {

    @ToolUi.InputSearcherPath("/path/searchWidget.jsp") 
    private Author author;

}

• Specifies the path to the widget for retrieving matching authors.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.LanguageTag("en-US") 
    private String body;

}

• Sets the lang attribute of the div containing the body’s textarea element in the content edit form to en-US.

<div lang="en-US">
    <div>
        <!-- Definition of field label -->
    </div>
    <div>
        <textarea></textarea>
    </div>
</div>

import com.psddev.cms.db.Content;
import com.psddev.cms.db.Directory;

public class Author extends Content implements Directory.Item { 

}

• Indicates that Author appears in the MAIN CONTENT TYPES group of the Create drop-down list, because this model implements Directory.Item.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.Main 
public class Article extends Content  {

}

• Indicates that Article appears in the MAIN CONTENT TYPES group of the Create drop-down list, even though this model does not implement Directory.Item.

import com.psddev.cms.db.Content;
public class Gallery extends Content {

}

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.OnlyPathed 
    private Author author;

}

• Displays in the search panel only those published authors with permalinks.

import com.psddev.cms.db.ToolUi;
import com.psddev.dari.db.Record;

@ToolUi.Permissionable 
public class RichTextHat extends Record { 
    /* Class definition */
}

• Renders the annotated class in the Permissions accordion of the Tool Role or Tool User widget.
• Declares a class RichTextHat that extends from Record. Brightspot renders such classes as Other Type in a permissions form. Brightspot renders a class extending from Content as Content Type in a permissions form.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.Publishable(false) 
public class Article extends Content  {

}

• Indicates that no articles are publishable. The text inside the editorial toolbar changes to Save.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.PublishButtonText("Print it!") 
public class Article extends Content  {

}

• Specifies that Print It! appears on the publish button for articles.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    private String headline;

    @ToolUi.ReadOnly 
    private String author;

}

• Specifies that Author is read-only on the content edit form.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;
import brightspot.core.tool.SmallRichTextToolbar;

public class Article extends Content  {

    @ToolUi.RichText(toolbar = SmallRichTextToolbar.class) 
    private String body;

}

• Renders the field body as a rich-text editor using the small version of the default toolbar.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.Secret 
    private String password;

}

• Hides the password field’s value.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.Sortable 
    private String headline;

}

• Indicates users can sort search results by headline when filtering on Articles.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.StoragePreviewProcessorPath("/WEB-INF/_plugins/myCustomFilePreview.jsp") 
    private StorageItem leadImage;

}

• Specifies the path to the JSP servlet that generates the leadImage’s preview in the content edit form.

<!-- Storage Item Settings  -->
<Environment name="dari/defaultStorage" type="java.lang.String" value="primary" /> 

<Environment name="dari/storage/primary/class" type="java.lang.String" value="com.psddev.dari.util.LocalStorageItem" /> 
<Environment name="dari/storage/primary/rootPath" type="java.lang.String" value="/servers/mysite/www/primary" />
<Environment name="dari/storage/primary/baseUrl" type="java.lang.String" value="/primary" />

<Environment name="dari/storage/secondary/class" type="java.lang.String" value="com.psddev.dari.util.LocalStorageItem" /> 
<Environment name="dari/storage/secondary/rootPath" type="java.lang.String" value="/servers/mysite/www/secondary" />
<Environment name="dari/storage/secondary/baseUrl" type="java.lang.String" value="/secondary" />

• Specifies primary as the default storage location.
• Defines the URL for storage location primary.
• Defines the URL for storage location secondary.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.StorageSetting("secondary") 
    private StorageItem image;

}

• Specifies that all objects associated with the image field are stored in the secondary location specified in the project’s context.xml file.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.SuggestedMaximum(30) 
    private String headline;

}

• Specifies a suggested maximal length of 30 characters in the headline. When a user types more than 30, Brightspot displays a warning message.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.SuggestedMinimum(10) 
    private String headline;

}

• Specifies a suggested minimal length of 10 characters for the headline. Brightspot displays a warning message in the field until the user types 10 characters.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.Suggestions 
    private Section section;

}

• Provides suggested selections when the user opens the Section field.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class Article extends Content  {

    @ToolUi.Tab("Markets") 
    private String state;

    @ToolUi.Tab("Markets")
    private String county;

    @ToolUi.Tab("Markets")
    private String city;

}

• Specifies that the fields state, county, and city appear under the Markets tab in the content edit form.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

@ToolUi.TabDisplayOrder(end = {"Markets"}) 
public class Article extends Content{

    private String headline; 
    private String body;
    private String author;

    @ToolUi.Tab("Markets") 
    private String state;

    @ToolUi.Tab("Markets")
    private String county;

    @ToolUi.Tab("Markets")
    private String city;

    @ToolUi.Tab("Demographics") 
    private String gender;

    @ToolUi.Tab("Demographics")
    private String age;

    @ToolUi.Tab("Demographics")
    private String occupation;
}

• Specifies that the rightmost custom tab is Markets, overriding the default that Demographics is the rightmost custom tab.
• Defines three fields without a @ToolUi.tab annotation; these fields appear under the tab Main.
• Defines three fields appearing under the custom tab Markets. By default, Markets is the leftmost tab because it is appears first in the model.
• Defines three fields appearing under the custom tab Demographics.

@Recordable.Embedded
public class ExampleChild extends Record {

    @ToolUi.Unlabeled
    private String myStringField;

}

public class ExampleParent extends Content {

    private ExampleChild myEmbeddedField;

}

• Declares an embedded class with a single text field.
• Suppresses the label My String Field in the content edit form.
• Declares a parent class with a field of type ExampleChild.

import com.psddev.cms.db.Site;
import com.psddev.cms.db.ValueGenerator;
import com.psddev.cms.tool.ToolPageContext;

public class SiteListValueGenerator implements ValueGenerator { 

    @Override
    public List<Value> generate(ToolPageContext page, Object object, String input) { 
        List<Site> otherAccessibleSites = page.findOtherAccessibleSites(); 
        return otherAccessibleSites.stream() 
                .map(e -> {
                    Value value = new ValueGenerator.Value();
                    value.setLabel(e.getLabel());
                    value.setValue(e.getId().toString());
                    return value;
                })
                .collect(Collectors.toList());
    }
}

• Declares a class that implements ValueGenerator.
• Method that returns a list of sites to which the current user has access excluding the current site.
• Retrieves the sites to which the user has access other than the current site.
• Constructs a list of those sites using the sites’ label and ID.

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;

public class ArticleWithDynamicList extends Content {

    private String headline;

    @ToolUi.ValueGeneratorClass(SiteListValueGenerator.class) 
    private Set<String> additionalSitesForPublication; 

}

• Populates the list with the results from the method SiteListValueGenerator#generate implemented in Step 1.
• Declares a drop-down list of sites from which an editor can select to publish an item.