1 /* 2 * $Source$ 3 * $Revision$ 4 * 5 * Copyright (C) 2000 William Chesters 6 * 7 * Part of Melati (http://melati.org), a framework for the rapid 8 * development of clean, maintainable web applications. 9 * 10 * Melati is free software; Permission is granted to copy, distribute 11 * and/or modify this software under the terms either: 12 * 13 * a) the GNU General Public License as published by the Free Software 14 * Foundation; either version 2 of the License, or (at your option) 15 * any later version, 16 * 17 * or 18 * 19 * b) any version of the Melati Software License, as published 20 * at http://melati.org 21 * 22 * You should have received a copy of the GNU General Public License and 23 * the Melati Software License along with this program; 24 * if not, write to the Free Software Foundation, Inc., 25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the 26 * GNU General Public License and visit http://melati.org to obtain the 27 * Melati Software License. 28 * 29 * Feel free to contact the Developers of Melati (http://melati.org), 30 * if you would like to work out a different arrangement than the options 31 * outlined here. It is our intention to allow Melati to be used by as 32 * wide an audience as possible. 33 * 34 * This program is distributed in the hope that it will be useful, 35 * but WITHOUT ANY WARRANTY; without even the implied warranty of 36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 37 * GNU General Public License for more details. 38 * 39 * Contact details for copyright holder: 40 * 41 * William Chesters <williamc At paneris.org> 42 * http://paneris.org/~williamc 43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands 44 */ 45 46 package org.melati.poem; 47 48 /** 49 * An interface which defines attributes of all {@link Field}s. 50 * 51 * @author WilliamC At paneris.org 52 */ 53 public interface FieldAttributes<T> { 54 /** 55 * @return the machine name of the field 56 */ 57 String getName(); 58 /** 59 * @return the human readable name of the field 60 */ 61 String getDisplayName(); 62 /** 63 * @return the longer description of the field 64 */ 65 String getDescription(); 66 /** 67 * @return the PoemType of the field 68 */ 69 PoemType<T> getType(); 70 /** 71 * @return whether the field is indexed 72 */ 73 boolean getIndexed(); 74 /** 75 * @return whether a user may change the field value 76 */ 77 boolean getUserEditable(); 78 /** 79 * @return whether a user may create a field 80 */ 81 boolean getUserCreateable(); 82 /** 83 * @return the width of widget required to display this field 84 */ 85 int getWidth(); 86 /** 87 * @return the height of widget to display this field 88 */ 89 int getHeight(); 90 /** 91 * @return the name of a special widget templet to display this field 92 */ 93 String getRenderInfo(); 94 }