001: /*
002: * Copyright (c) 2001 - 2005 ivata limited.
003: * All rights reserved.
004: * -----------------------------------------------------------------------------
005: * ivata masks may be redistributed under the GNU General Public
006: * License as published by the Free Software Foundation;
007: * version 2 of the License.
008: *
009: * These programs are free software; you can redistribute them and/or
010: * modify them under the terms of the GNU General Public License
011: * as published by the Free Software Foundation; version 2 of the License.
012: *
013: * These programs are distributed in the hope that they will be useful,
014: * but WITHOUT ANY WARRANTY; without even the implied warranty of
015: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
016: *
017: * See the GNU General Public License in the file LICENSE.txt for more
018: * details.
019: *
020: * If you would like a copy of the GNU General Public License write to
021: *
022: * Free Software Foundation, Inc.
023: * 59 Temple Place - Suite 330
024: * Boston, MA 02111-1307, USA.
025: *
026: *
027: * To arrange commercial support and licensing, contact ivata at
028: * http://www.ivata.com/contact.jsp
029: * -----------------------------------------------------------------------------
030: * $Log: FieldWriterFactory.java,v $
031: * Revision 1.9 2005/10/11 18:54:06 colinmacleod
032: * Fixed some checkstyle and javadoc issues.
033: *
034: * Revision 1.8 2005/10/02 14:06:32 colinmacleod
035: * Added/improved log4j logging.
036: *
037: * Revision 1.7 2005/09/29 12:15:43 colinmacleod
038: * Added session parameter to getFieldWriter.
039: *
040: * Revision 1.6 2005/04/09 18:04:17 colinmacleod
041: * Changed copyright text to GPL v2 explicitly.
042: *
043: * Revision 1.5 2005/01/19 12:51:03 colinmacleod
044: * Changed Id --> Name.
045: *
046: * Revision 1.4 2005/01/07 08:08:24 colinmacleod
047: * Moved up a version number.
048: * Changed copyright notices to 2005.
049: * Updated the documentation:
050: * - started working on multiproject:site docu.
051: * - changed the logo.
052: * Added checkstyle and fixed LOADS of style issues.
053: * Added separate thirdparty subproject.
054: * Added struts (in web), util and webgui (in webtheme) from ivata op.
055: *
056: * Revision 1.3 2004/11/12 15:10:41 colinmacleod
057: * Moved persistence classes from ivata op as a replacement for
058: * ValueObjectLocator.
059: *
060: * Revision 1.2 2004/11/11 13:44:04 colinmacleod
061: * Added HTMLFormatter.
062: *
063: * Revision 1.1.1.1 2004/05/16 20:40:32 colinmacleod
064: * Ready for 0.1 release
065: * -----------------------------------------------------------------------------
066: */
067: package com.ivata.mask.web.field;
068:
069: import javax.servlet.http.HttpSession;
070:
071: import com.ivata.mask.field.Field;
072: import com.ivata.mask.util.SystemException;
073: import com.ivata.mask.valueobject.ValueObject;
074:
075: /**
076: * <p>
077: * Use implementations of this interface to generate an appropriate field
078: * writer for a given mask and field.
079: * </p>
080: *
081: * @since ivata masks 0.1 (2004-05-14)
082: * @author Colin MacLeod
083: * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
084: * @version $Revision: 1.9 $
085: */
086: public interface FieldWriterFactory {
087: /**
088: * <p>
089: * Name of the attribute to set in the application scope. You must store an
090: * appropriate instance of this class in this attribute, so that the field
091: * tag can locate the field writer factory.
092: * </p>
093: */
094: String APPLICATION_ATTRIBUTE = "FieldWriterFactory";
095:
096: /**
097: * Get a field writer appropriate to the given field.
098: *
099: * @param session current HTTP Session we are processing.
100: * @param valueObject
101: * Value object on which to operate.
102: * @param field
103: * Field for which to return an appropriate field writer.
104: * @param subField
105: * If this field writer is for a sublist, defines the field
106: * within a field which is actually being displayed.
107: * @param hidden
108: * If <code>true</code>, overrides the field definition, and gets a writer
109: * for a hidden field.
110: * @return valid field writer for the field provided.
111: * @throws SystemException
112: * if the writer cannot be retrieved for any reason.
113: */
114: FieldWriter getFieldWriter(HttpSession session,
115: ValueObject valueObject, Field field, Field subField,
116: boolean hidden) throws SystemException;
117: }
|