io.overcoded.grid.annotation.GridSystem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grid-annotation Show documentation

An annotation library to help generate views, dialogs, and grids.

There is a newer version: 1.4.0

package io.overcoded.grid.annotation;

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

/**
 * You can put it on a package to define the main title and icon of the page
 * This will be the entry point of the system, so you should mark your base package in this.
 * 
 * Menu groups and other information should be looked in the subpackage of the
 * package marked with this annotation.
 */
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
public @interface GridSystem {
    /**
     * defines the icon of the system
     *
     * @return icon value
     */
    String icon() default "";

    /**
     * defines the title of the system
     * if not specified, the package name can be used
     *
     * @return title of the system
     */
    String title() default "Grid";

    /**
     * defines the prefix of the system
     * this means each url will start with this prefix
     *
     * @return path prefix of the system
     */
    String path() default "/grid";
}