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: FormatConstants.java,v $
031: * Revision 1.4 2005/10/02 14:06:33 colinmacleod
032: * Added/improved log4j logging.
033: *
034: * Revision 1.3 2005/04/09 18:04:18 colinmacleod
035: * Changed copyright text to GPL v2 explicitly.
036: *
037: * Revision 1.2 2005/01/19 12:51:54 colinmacleod
038: * Fixed bundle and resource paths.
039: *
040: * Revision 1.1 2005/01/06 22:41:01 colinmacleod
041: * Moved up a version number.
042: * Changed copyright notices to 2005.
043: * Updated the documentation:
044: * - started working on multiproject:site docu.
045: * - changed the logo.
046: * Added checkstyle and fixed LOADS of style issues.
047: * Added separate thirdparty subproject.
048: * Added struts (in web), util and webgui (in webtheme) from ivata op.
049: *
050: * Revision 1.4 2004/07/13 19:48:11 colinmacleod
051: * Moved project to POJOs from EJBs.
052: * Applied PicoContainer to services layer (replacing session EJBs).
053: * Applied Hibernate to persistence layer (replacing entity EJBs).
054: *
055: * Revision 1.3 2004/03/21 21:16:37 colinmacleod
056: * Shortened name to ivata op.
057: *
058: * Revision 1.2 2004/02/01 22:07:32 colinmacleod
059: * Added full names to author tags
060: *
061: * Revision 1.1.1.1 2004/01/27 20:59:47 colinmacleod
062: * Moved ivata op to SourceForge.
063: *
064: * Revision 1.2 2003/10/15 14:13:39 colin
065: * Fixes for XDoclet.
066: *
067: * Revision 1.1 2003/02/24 19:33:32 colin
068: * Moved to new subproject.
069: *
070: * Revision 1.4 2003/02/04 17:43:46 colin
071: * copyright notice
072: *
073: * Revision 1.3 2002/11/13 09:20:39 colin
074: * changed the resource bundle used to
075: * com.ivata.mask.business.ApplicationResources
076: *
077: * Revision 1.2 2002/11/12 09:01:46 colin
078: * added getLabelValues for use with Struts
079: *
080: * Revision 1.1 2002/08/10 21:20:34 colin
081: * HTML/Text format constants as used in the library
082: * -----------------------------------------------------------------------------
083: */
084: package com.ivata.mask.web.format;
085:
086: import org.apache.log4j.Logger;
087:
088: import java.util.Collection;
089: import java.util.ResourceBundle;
090: import java.util.Vector;
091: import org.apache.struts.util.LabelValueBean;
092:
093: /**
094: * <p>
095: * Constants used to identify different text and HTML formats.
096: * </p>
097: *
098: * @since ivata masks 0.4 (2002-07-11)
099: * @author Colin MacLeod <a
100: * href="mailto:colin.macleod@ivata.com">colin.macleod@ivata.com </a>
101: * @version $Revision: 1.4 $
102: */
103: public final class FormatConstants {
104: /**
105: * Logger for this class.
106: */
107: private static final Logger logger = Logger
108: .getLogger(FormatConstants.class);
109:
110: /**
111: * <p>
112: * Identifies text with HTML tags in input text-areas. This will sent to the
113: * page as it is.
114: * </p>
115: */
116: public static final int FORMAT_HTML = 1;
117: /**
118: * <p>
119: * Identifies clear text in input text-areas. This will be parsed using
120: * HTMLFormatter with line break conversion.
121: * </p>
122: */
123: public static final int FORMAT_TEXT = 0;
124:
125: /**
126: * <p>
127: * Get all of the format constants and their labels. This is useful for
128: * populating <code>option</code> tags in <strong>Struts </strong>.
129: * </p>
130: *
131: * @return <code>Collection</code> of {@link
132: * com.ivata.mask.util.LabelValueBean LabelValueBean} instances.
133: */
134: public static Collection getLabelValues() {
135: if (logger.isDebugEnabled()) {
136: logger.debug("getLabelValues() - start");
137: }
138:
139: Vector collection = new Vector();
140: ResourceBundle formatResources = ResourceBundle
141: .getBundle("com.ivata.mask.web.ApplicationResources");
142: collection.add(new LabelValueBean(formatResources
143: .getString("web.format.constant.text"), new Integer(
144: FORMAT_TEXT).toString()));
145: collection.add(new LabelValueBean(formatResources
146: .getString("web.format.constant.html"), new Integer(
147: FORMAT_HTML).toString()));
148:
149: if (logger.isDebugEnabled()) {
150: logger.debug("getLabelValues() - end - return value = "
151: + collection);
152: }
153: return collection;
154: }
155:
156: /**
157: * Private default constructor enforces utility class behavior.
158: */
159: private FormatConstants() {
160: }
161: }
|