io.overcoded.grid.annotation.GridColumn 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 field.
 * In the generated view/dialog only these columns will appear in the grid.
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface GridColumn {
    /**
     * sets the order of menu entries
     *
     * @return int
     */
    int order() default Integer.MAX_VALUE;

    /**
     * decides if the field should be used as filter on the view/dialog
     *
     * @return boolean
     */
    boolean filter() default false;

    /**
     * defines what kind of control element should be displayed
     *
     * @return FieldProviderType
     */
    FieldProviderType fieldProviderType() default FieldProviderType.DEFAULT;

    /**
     * defines if the field should not be represented on the view/dialog
     * mostly used in case when field provider type should be defined
     *
     * @return boolean
     */
    boolean hidden() default false;

    /**
     * placeholder text of the input field, where we can put extra
     * information for content editors
     *
     * @return String
     */
    String placeholder() default "";
}