TextArea.java :  » JPA » open-tides » org » hightides » annotations » Java Open Source

/*
   Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.    
 */

package org.hightides.annotations;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Generates an input text area.
 * <b>Sample Usage:</b><br />
 * &emsp;&emsp;&emsp;<code>@TextArea (label = "textAreaLabel", requiredField = "true")</code><br />
 * @author allanctan
 */
@Target(FIELD)
@Retention(RUNTIME)
@Documented
public @interface TextArea {

  /**
   * Refers to the name identifier of the field; default value is <code><b>null</b></code>.
   * 
   */
  String label() default "";

  /**
   * Refers to the parameters to be added; default value is <code><b>null</b></code>.
   * 
   */  
  String[] springParams() default "";
  
  /**
   * Determines if the field is included as a search criteria; default value is <code><b>false</b></code>.
   * 
   */
  boolean searchable() default false;
  
  /**
   * Determines if the field is included in audit logs; default value is <code><b>false</b></code>.
   */
  boolean auditable() default false;

  /**
   * Determines if the field is the unique identifier or primary key; default value is <code><b>false</b></code>.
   * 
   */
  boolean titleField() default false;

  /**
   * Determines if the field is required and cannot be null; default value is <code><b>false</b></code>. This is used as reference when deleting an entry.
   * 
   */
  boolean requiredField() default false;
  
  /**
   * Determines if the field is included in the table view; default value is <code><b>false</b></code>.
   * 
   */
  boolean listed() default false;
}