Support and Documentation

Identifies the view model as a producer of Handlebars output, and specifies the Handlebars template's location. This annotation is included in the Brightspot Handlebars plugin.

This annotation requires the @ViewInterface annotation.

import com.psddev.cms.view.PageEntryView;
import com.psddev.cms.view.ViewInterface;
import com.psddev.cms.view.ViewModel;
import com.psddev.handlebars.HandlebarsTemplate;

@HandlebarsTemplate("Article")
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> implements PageEntryView {

    public String getBody() {
        return model.getBody();
    }

    public String getHeadline() {
        return model.getHeadline();
    }
}

The above example specifies that for the class ArticleViewModel, the associated Handlebars file is <webroot>/Article.hbs.

For detailed information about Handlebars, see Handlebars.

Declares the view model as a producer of JSON output.

This annotation requires the @ViewInterface annotation.

import com.psddev.cms.view.JsonView;
import com.psddev.cms.view.PageEntryView;
import com.psddev.cms.view.ViewInterface;
import com.psddev.cms.view.ViewModel;

@JsonView
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> implements PageEntryView {

    public String getBody() {
        return model.getBody();
    }

    public String getHeadline() {
        return model.getHeadline();
    }
}

The JSON output is an object with keys corresponding to the model's fields and associated values, as in the following example.

{
  "body" : "A platoon of aliens who traveled four light years in suspended animation landed in Times Square Wednesday evening...",
  "headline" : "Crippled by Earth's Gravity, Aliens Demand Submission"
}

Invokes a process to transform a Model's data into the form specified by another annotation, usually @HandlebarsTemplate (for Handlebars output), @JsonView (for JSON output), or @ViewRendererClass (for customized output). See those annotations for examples of how to use @ViewInterface.

Specifies a class implementing ViewRenderer to render the model's data.

This annotation requires the @ViewInterface annotation.

The following example comes from Brightspot's implementation for RawView:

package com.psddev.cms.view;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

@ViewInterface
@ViewRendererClass(RawViewRenderer.class)
public interface RawView {

    List<?> getItems();

    /* static methods... */

}

Retrieves the current Site object based on the Request URL. This annotation is available only if your Brightspot project is configured as a multi-site instance.

package content.article;

import com.psddev.cms.view.servlet.CurrentSite;

/* Other imports... */

@HandlebarsTemplate("Article")
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> {

   @CurrentSite
   private Site currentSite;

   public Site getCurrentsite() {
      return currentSite;
   }
}

In the previous snippet—

Retrieves the value for a specified cookie. If the specified cookie does not exist in the request, the annotation returns a null value.

package content.article;

import com.psddev.cms.view.servlet.HttpCookie;

/* Other imports... */

@HandlebarsTemplate("Article")
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> {

   @HttpCookie("username")
   private String userName;

   public String getUsername() {
      return userName;
   }
}

In the previous snippet—

Retrieves the value for a specified field in the HTTP request header. If the specified field does not exist in the request header, the annotation returns a null value.

package content.article;

import com.psddev.cms.view.servlet.HttpHeader;

/* Other imports... */

@HandlebarsTemplate("Article")
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> {

   @HttpHeader("User-Agent")
   private String userAgent;

   public String getUseragent() {
      return userAgent;
   }
}

In the previous snippet—

Retrieves the HTTP request method. Typical values for the request method are GET and POST. For a listing of possible HTTP request methods, see HTTP request methods.

package content.article;

import com.psddev.cms.view.servlet.HttpMethod;

/* Other imports... */

@HandlebarsTemplate("Article")
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> {

   @HttpMethod
   private String httpMethod;

   public String getHttpmethod() {
      return httpMethod;
   }
}

In the previous snippet—

Retrieves the value of a requested parameter passed in a URL's query string or in a posted form. For example, if the URL is http://www.example.com/index.html?userid=5, you can use this annotation to retrieve the value for userid. If the parameter does not exist in the query string or form, this annotation returns a null value.

package content.article;

import com.psddev.cms.view.servlet.HttpParameter;

/* Other imports... */

@HandlebarsTemplate("Article")
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> {

   @HttpParameter("userid")
   private String userID;

   public String getUserid() {
      return userID;
   }
}

In the previous snippet—

Retrieves the object or string representing a requested servlet attribute. If the attribute does not exist, this annotation returns a null value.

package content.article;

import com.psddev.cms.view.servlet.HttpRequestAttribute;

/* Other imports... */

@HandlebarsTemplate("Article")
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> {

   @HttpRequestAttribute("currentdate")
   private String currentDate;

   public String getCurrdate() {
      return currentDate;
   }
}

In the previous snippet—

Returns the servlet path, typically the path appearing after the domain in a URL. For example, in the URL http://www.example.com/solar-system-implodes, the servlet path is /solar-system-implodes.

package content.article;

import com.psddev.cms.view.servlet.HttpServletPath;

/* Other imports... */

@HandlebarsTemplate("Article")
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> {

   @HttpServletPath
   private String servletPath;

   public String getServletpath() {
      return servletPath;
   }
}

In the previous snippet—

Retrieves the value for a specified signed cookie. If the specified cookie does not exist in the request, the annotation returns a null value.

package content.article;

import com.psddev.cms.view.servlet.HttpSignedCookie;

/* Other imports... */

@HandlebarsTemplate("Article")
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> {

   @HttpSignedCookie("username")
   private String userName;

   public String getUsername() {
      return userName;
   }
}

In the previous snippet—

Transforms a submitted file into a StorageItem, and associates the value for name with the StorageItem. The files can be uploaded files or JSON representations of files.

For example, the following HTML snippet submits two images to the server, one as a file and another in JSON format.

<html>
   <input type="file" name="image" />
   <input type="hidden" value="{JSON structure here}" name="imageJson" />
</html>

The following view model snippet transforms the uploaded files into StorageItems.

package content.article;

import com.psddev.cms.view.servlet.HttpStorageItemParameter;

/* Other imports... */

@HandlebarsTemplate("Article")
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> {

   @HttpStorageItemParameter("image")
   private StorageItem profileImage;

   @HttpStorageItemParameter("imageJson")
   private StorageItem profileImageJson;

}

In the previous snippet—

Retrieves the object associated with a published permalink. For example, if the permalink associated with an article is http://localhost/gravity-canceled-today, this annotation returns the object associated with /gravity-canceled-today.

package content.article;

import com.psddev.cms.view.servlet.MainObject;

/* Other imports... */

@HandlebarsTemplate("Article")
@ViewInterface
public class ArticleViewModel extends ViewModel<Article> {

   @MainObject
   private String mainObject;

   public String getMainobjectname() {
      return mainObject.getClass().getName();
   }
}

In the previous snippet—