001: /*
002: * Copyright (c) 2001 - 2005 ivata limited.
003: * All rights reserved.
004: * -----------------------------------------------------------------------------
005: * ivata groupware 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: FramesListForm.java,v $
031: * Revision 1.3 2005/10/03 10:21:14 colinmacleod
032: * Fixed some style and javadoc issues.
033: *
034: * Revision 1.2 2005/10/02 14:08:57 colinmacleod
035: * Added/improved log4j logging.
036: *
037: * Revision 1.1 2005/09/29 14:04:05 colinmacleod
038: * Generalized frames model of ivata masks - initially for use in ivata cms.
039: *
040: */
041: package com.ivata.groupware.mask.struts;
042:
043: import org.apache.log4j.Logger;
044:
045: import java.util.List;
046:
047: import com.ivata.mask.Mask;
048: import com.ivata.mask.web.struts.ListForm;
049:
050: ;
051:
052: /**
053: * @since ivata groupware 1.0 (16-Sep-2005)
054: * @author Colin MacLeod <colin.macleod@ivata.com>
055: * @version $Revision: 1.3 $
056: */
057: public class FramesListForm extends ListForm {
058: /**
059: * Logger for this class.
060: */
061: private static final Logger logger = Logger
062: .getLogger(FramesListForm.class);
063:
064: /**
065: * Serialization version (for <code>Serializable</code> interface).
066: */
067: private static final long serialVersionUID = 1L;
068: private String contentFrameName;
069: private String inputMask;
070: private String menuFrameName;
071: private String menuFrameURI;
072: private String selectedId;
073:
074: public FramesListForm(List valueObjectsParam, Mask maskParam,
075: Class baseClassParam) {
076: super (valueObjectsParam, maskParam, baseClassParam);
077: }
078:
079: /**
080: * @return Returns the contentFrameName.
081: */
082: public String getContentFrameName() {
083: if (logger.isDebugEnabled()) {
084: logger.debug("getContentFrameName() - start");
085: }
086:
087: if (logger.isDebugEnabled()) {
088: logger
089: .debug("getContentFrameName() - end - return value = "
090: + contentFrameName);
091: }
092: return contentFrameName;
093: }
094:
095: /**
096: * @return Returns the inputMask.
097: */
098: public String getInputMask() {
099: if (logger.isDebugEnabled()) {
100: logger.debug("getInputMask() - start");
101: }
102:
103: if (logger.isDebugEnabled()) {
104: logger.debug("getInputMask() - end - return value = "
105: + inputMask);
106: }
107: return inputMask;
108: }
109:
110: /**
111: * @return Returns the menuFrameName.
112: */
113: public String getMenuFrameName() {
114: if (logger.isDebugEnabled()) {
115: logger.debug("getMenuFrameName() - start");
116: }
117:
118: if (logger.isDebugEnabled()) {
119: logger.debug("getMenuFrameName() - end - return value = "
120: + menuFrameName);
121: }
122: return menuFrameName;
123: }
124:
125: /**
126: * @return Returns the menuFrameURI.
127: */
128: public String getMenuFrameURI() {
129: if (logger.isDebugEnabled()) {
130: logger.debug("getMenuFrameURI() - start");
131: }
132:
133: if (logger.isDebugEnabled()) {
134: logger.debug("getMenuFrameURI() - end - return value = "
135: + menuFrameURI);
136: }
137: return menuFrameURI;
138: }
139:
140: /**
141: * @return Returns the selectedId.
142: */
143: public String getSelectedId() {
144: if (logger.isDebugEnabled()) {
145: logger.debug("getSelectedId() - start");
146: }
147:
148: if (logger.isDebugEnabled()) {
149: logger.debug("getSelectedId() - end - return value = "
150: + selectedId);
151: }
152: return selectedId;
153: }
154:
155: /**
156: * <copyDoc>Refer to {@link #getcontentFrameName}.</copyDoc>
157: * @param contentFrameNameParam <copyDoc>Refer to {@link #getcontentFrameName}.</copyDoc>
158: */
159: public void setContentFrameName(String contentFrameNameParam) {
160: if (logger.isDebugEnabled()) {
161: logger
162: .debug("setContentFrameName(String contentFrameNameParam = "
163: + contentFrameNameParam + ") - start");
164: }
165:
166: contentFrameName = contentFrameNameParam;
167:
168: if (logger.isDebugEnabled()) {
169: logger.debug("setContentFrameName(String) - end");
170: }
171: }
172:
173: /**
174: * <copyDoc>Refer to {@link #getinputMask}.</copyDoc>
175: * @param inputMaskParam <copyDoc>Refer to {@link #getinputMask}.</copyDoc>
176: */
177: public void setInputMask(String inputMaskParam) {
178: if (logger.isDebugEnabled()) {
179: logger.debug("setInputMask(String inputMaskParam = "
180: + inputMaskParam + ") - start");
181: }
182:
183: inputMask = inputMaskParam;
184:
185: if (logger.isDebugEnabled()) {
186: logger.debug("setInputMask(String) - end");
187: }
188: }
189:
190: /**
191: * <copyDoc>Refer to {@link #getmenuFrameName}.</copyDoc>
192: * @param menuFrameNameParam <copyDoc>Refer to {@link #getmenuFrameName}.</copyDoc>
193: */
194: public void setMenuFrameName(String menuFrameNameParam) {
195: if (logger.isDebugEnabled()) {
196: logger
197: .debug("setMenuFrameName(String menuFrameNameParam = "
198: + menuFrameNameParam + ") - start");
199: }
200:
201: menuFrameName = menuFrameNameParam;
202:
203: if (logger.isDebugEnabled()) {
204: logger.debug("setMenuFrameName(String) - end");
205: }
206: }
207:
208: /**
209: * <copyDoc>Refer to {@link #getmenuFrameURI}.</copyDoc>
210: * @param menuFrameURIParam <copyDoc>Refer to {@link #getmenuFrameURI}.</copyDoc>
211: */
212: public void setMenuFrameURI(String menuFrameURIParam) {
213: if (logger.isDebugEnabled()) {
214: logger.debug("setMenuFrameURI(String menuFrameURIParam = "
215: + menuFrameURIParam + ") - start");
216: }
217:
218: menuFrameURI = menuFrameURIParam;
219:
220: if (logger.isDebugEnabled()) {
221: logger.debug("setMenuFrameURI(String) - end");
222: }
223: }
224:
225: /**
226: * <copyDoc>Refer to {@link #getselectedId}.</copyDoc>
227: * @param selectedIdParam <copyDoc>Refer to {@link #getselectedId}.</copyDoc>
228: */
229: public void setSelectedId(String selectedIdParam) {
230: if (logger.isDebugEnabled()) {
231: logger.debug("setSelectedId(String selectedIdParam = "
232: + selectedIdParam + ") - start");
233: }
234:
235: selectedId = selectedIdParam;
236:
237: if (logger.isDebugEnabled()) {
238: logger.debug("setSelectedId(String) - end");
239: }
240: }
241:
242: }
|