ThemeVariant.java

package play.modules.origo.core.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Adds a variant for a theme, the method it annotates returns a String path to a template.
 * Only valid in a class annotated by \@Theme.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface ThemeVariant {

    /**
     * A unique id for referencing this variant. Used as the key when caching this theme
     * variant.
     * Best practice is to include the theme's id in the id, for example:
     * themeId=Basic would give variantId=Basic-Green and variantId=Basic-Red
     *
     * @return A unique id for this variant.
     */
    String id();

    /**
     * The content areas this theme variant offers.
     *
     * @return an array of content area names
     */
    String[] regions();

    /**
     * Each theme can define several different outputs with the same design/look. Types can
     * be XML, HTML, TEXT, PDF, etc.
     *
     * @return the type of output this theme variant produces
     */
    String output() default "HTML";
}