com.vaadin.annotations.DesignRoot Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import com.vaadin.ui.declarative.Design;
/**
* Marks the component as the root of a design (html) file.
*
* Used together with {@link Design#read(com.vaadin.ui.Component)} to be able
* the load the design without further configuration. By default, the design is
* loaded from the same package as the annotated class and the design filename
* is derived from the class name. You can override the default behavior by
* using the {@link #value()} parameter in order to load the design from a
* different package or with a non-default filename.
*
* @since 7.4
* @author Vaadin Ltd
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface DesignRoot {
String value() default "";
}