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: PasswordFieldWriter.java,v $
031: * Revision 1.4 2005/10/11 18:54:06 colinmacleod
032: * Fixed some checkstyle and javadoc issues.
033: *
034: * Revision 1.3 2005/10/03 10:17:25 colinmacleod
035: * Fixed some style and javadoc issues.
036: *
037: * Revision 1.2 2005/10/02 14:06:33 colinmacleod
038: * Added/improved log4j logging.
039: *
040: * Revision 1.1 2005/09/29 12:12:30 colinmacleod
041: * Added password field type.
042: *
043: * Revision 1.2 2005/04/09 18:04:17 colinmacleod
044: * Changed copyright text to GPL v2 explicitly.
045: *
046: * Revision 1.1 2005/01/19 12:47:27 colinmacleod
047: * First version of hidden field writer.
048: *
049: * -----------------------------------------------------------------------------
050: */
051: package com.ivata.mask.web.field.text;
052:
053: import org.apache.log4j.Logger;
054:
055: import com.ivata.mask.field.Field;
056: import com.ivata.mask.field.FieldValueConvertor;
057: import com.ivata.mask.valueobject.ValueObject;
058: import com.ivata.mask.web.format.HTMLFormatter;
059:
060: /**
061: * <p>
062: * This writer is used to display fields as
063: * <code><input type="hidden"...></code>, when they are
064: * hidden from display.
065: * </p>
066: *
067: * @since ivata masks 0.5 (20005-01-14)
068: * @author Colin MacLeod
069: * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
070: * @version $Revision: 1.4 $
071: */
072: public class PasswordFieldWriter extends TextFieldWriter {
073: /**
074: * Logger for this class.
075: */
076: private static final Logger logger = Logger
077: .getLogger(PasswordFieldWriter.class);
078:
079: /**
080: * <p>
081: * Construct a hidden field writer.
082: * </p>
083: *
084: * @param fieldParam
085: * defines the field to be displayed.
086: * @param convertorParam
087: * converts objects into strings for display.
088: * @param formatterParam
089: * <copyDoc>Refer to {@link #getFormatter}.</copyDoc>
090: */
091: public PasswordFieldWriter(final Field fieldParam,
092: final FieldValueConvertor convertorParam,
093: final HTMLFormatter formatterParam) {
094: super (fieldParam, convertorParam, formatterParam);
095: getAttributesWriter().setAttribute("type", "password");
096: }
097:
098: /**
099: * Overriden to clear the value attribute - we don't want to send the
100: * password value.
101: *
102: * @param valueObject The value object whose value should be written.
103: * @return Always returns an empty string.
104: */
105: protected String setValue(final ValueObject valueObject) {
106: if (logger.isDebugEnabled()) {
107: logger.debug("setValue(ValueObject valueObject = "
108: + valueObject + ") - start");
109: }
110:
111: removeAttribute("value");
112:
113: if (logger.isDebugEnabled()) {
114: logger
115: .debug("setValue(ValueObject) - end - return value = ");
116: }
117: return "";
118: }
119:
120: }
|