Coverage Report

Coverage Report - org.kuali.rice.kns.web.struts.form.KualiForm

Classes in this File

Line Coverage

Branch Coverage

Complexity

KualiForm

0/143

0/54

1.755

 /*
  * Copyright 2006-2011 The Kuali Foundation
  *
  * Licensed under the Educational Community License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * http://www.opensource.org/licenses/ecl2.php
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.kuali.rice.kns.web.struts.form;
 
 import org.apache.commons.lang.StringUtils;
 import org.apache.struts.action.ActionMapping;
 import org.kuali.rice.core.framework.services.CoreFrameworkServiceLocator;
 import org.kuali.rice.core.web.format.Formatter;
 import org.kuali.rice.kns.datadictionary.HeaderNavigation;
 import org.kuali.rice.kns.util.ActionFormUtilMap;
 import org.kuali.rice.kns.util.KNSConstants;
 import org.kuali.rice.kns.util.ObjectUtils;
 import org.kuali.rice.kns.util.WebUtils;
 import org.kuali.rice.kns.web.struts.pojo.PojoFormBase;
 import org.kuali.rice.kns.web.ui.ExtraButton;
 import org.kuali.rice.kns.web.ui.HeaderField;
 import org.springframework.util.AutoPopulatingList;
 
 import javax.servlet.ServletRequest;
 import javax.servlet.http.HttpServletRequest;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
 /**
  * This class common properites for all action forms.
  */
 public class KualiForm extends PojoFormBase {
     private static final long serialVersionUID = 1L;
 
     private static final String literalPrefixAndDelimiter =
             KNSConstants.LOOKUP_PARAMETER_LITERAL_PREFIX+KNSConstants.LOOKUP_PARAMETER_LITERAL_DELIMITER;
 
     private String backLocation;
     private String methodToCall;
     private String refreshCaller;
     private String anchor;
     private Map<String, String> tabStates;
     private Map actionFormUtilMap;
     private Map displayedErrors = new HashMap();
     private Map<String, Object> displayedWarnings = new HashMap<String, Object>();
     private Map<String, Object> displayedInfo = new HashMap<String, Object>();
     private int currentTabIndex = 0;
     private int arbitrarilyHighIndex = 1000000;
 
     private String navigationCss;
     private HeaderNavigation[] headerNavigationTabs;
     protected List<ExtraButton> extraButtons = new AutoPopulatingList( ExtraButton.class ) ;
 
     private boolean fieldLevelHelpEnabled;
     
     private List<HeaderField> docInfo;
     private int numColumns = 2;
     
     private String fieldNameToFocusOnAfterSubmit;
     
     /**
      * @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#addRequiredNonEditableProperties()
      */
     @Override
     public void addRequiredNonEditableProperties(){
             super.addRequiredNonEditableProperties();
             registerRequiredNonEditableProperty(KNSConstants.REFRESH_CALLER);
     }
     
     public int getNumColumns() {
         return this.numColumns;
     }
 
     public void setNumColumns(int numColumns) {
         this.numColumns = numColumns;
     }
 
     public List<HeaderField> getDocInfo() {
         return this.docInfo;
     }
 
     public void setDocInfo(List<HeaderField> docInfo) {
         this.docInfo = docInfo;
     }
 
     /**
      * no args constructor which must init our tab states list
      */
     public KualiForm() {
         this.tabStates = new HashMap<String, String>();
         this.actionFormUtilMap = new ActionFormUtilMap();
         this.docInfo = new ArrayList<HeaderField>();
     }
 
     /**
      * Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.
      */
     public void populate(HttpServletRequest request) {
         setMethodToCall(WebUtils.parseMethodToCall(this, request));
         
         super.populate(request);
 
         populateBackLocation(request);
         populateFieldLevelHelpEnabled(request);
         
         if (actionFormUtilMap instanceof ActionFormUtilMap) {
             ((ActionFormUtilMap) actionFormUtilMap).setCacheValueFinderResults(true);
         }
     }
         
     private static Boolean ENABLE_FIELD_LEVEL_HELP_IND;
 
     protected void populateBackLocation(HttpServletRequest request){
         if (getParameter(request, "returnLocation") != null) {
             setBackLocation(getParameter(request, "returnLocation"));
         }
     }
     
     /**
      * Populates whether the each field will have field-level help associated with it.  Depending on how the jsp/tags are implemented, the value
      * populated by this method may be overruled by other settings
      * 
      * @param request
      */
     protected void populateFieldLevelHelpEnabled(HttpServletRequest request) {
             if ( ENABLE_FIELD_LEVEL_HELP_IND == null ) {
                     ENABLE_FIELD_LEVEL_HELP_IND = CoreFrameworkServiceLocator.getParameterService().getParameterValueAsBoolean(KNSConstants.KNS_NAMESPACE,
                     KNSConstants.DetailTypes.ALL_DETAIL_TYPE, KNSConstants.SystemGroupParameterNames.ENABLE_FIELD_LEVEL_HELP_IND, Boolean.FALSE);
             }
             setFieldLevelHelpEnabled( ENABLE_FIELD_LEVEL_HELP_IND);
     }
 
     public Map getDisplayedErrors() {
         return displayedErrors;
     }
 
     /**
          * @return the displayedWarnings
          */
         public Map<String, Object> getDisplayedWarnings() {
                 return this.displayedWarnings;
         }
 
         /**
          * @return the displayedInfo
          */
         public Map<String, Object> getDisplayedInfo() {
                 return this.displayedInfo;
         }
 
         /**
      * Used by the dispatch action to determine which action method to call into.
      *
      * @return Returns the methodToCall.
      */
     public String getMethodToCall() {
         return methodToCall;
     }
 
 
     /**
      * @param methodToCall The methodToCall to set.
      */
     public void setMethodToCall(String methodToCall) {
         this.methodToCall = methodToCall;
     }
 
 
     /**
      * Can be used by actions refresh method to determine what called the the refresh method.
      *
      * @return Returns the refreshCaller.
      */
     public String getRefreshCaller() {
         return refreshCaller;
     }
 
 
     /**
      * @param refreshCaller The refreshCaller to set.
      */
     public void setRefreshCaller(String refreshCaller) {
         this.refreshCaller = refreshCaller;
     }
 
     /**
      * @return the tab state list
      */
     public Map<String, String> getTabStates() {
         return tabStates;
     }
 
     /**
      * simple setter for the tab state Map
      *
      * @param tabStates
      */
     public void setTabStates(Map<String, String> tabStates) {
         this.tabStates = tabStates;
     }
 
     /**
      * Special getter based on key to work with multi rows for tab state objects
      */
     public String getTabState(String key) {
         String state = KNSConstants.EMPTY_STRING;
         if (tabStates.containsKey(key)) {
             if (tabStates.get(key) instanceof String) {
                     state = tabStates.get(key);
             }
             else {
                     //This is the case where the value is an Array of String,
                     //so we'll have to get the first element
                     Object result = tabStates.get(key);
                     result.getClass();
                     state = ((String[])result)[0];
             }
         }
 
         return state;
     }
 
     public int getCurrentTabIndex() {
         return currentTabIndex;
     }
 
     public void setCurrentTabIndex(int currentTabIndex) {
         this.currentTabIndex = currentTabIndex;
     }
 
     public void incrementTabIndex() {
         this.currentTabIndex++;
     }
 
     public int getNextArbitrarilyHighIndex() {
         return this.arbitrarilyHighIndex++;
     }
     
         public String getFieldNameToFocusOnAfterSubmit() {
                 return this.fieldNameToFocusOnAfterSubmit;
         }
 
         public void setFieldNameToFocusOnAfterSubmit(String fieldNameToFocusOnAfterSubmit) {
                 this.fieldNameToFocusOnAfterSubmit = fieldNameToFocusOnAfterSubmit;
         }
 
         /**
      * @return Returns the validOptionsMap.
      */
     public Map getActionFormUtilMap() {
         return actionFormUtilMap;
     }
 
     /**
      * @param validOptionsMap The validOptionsMap to set.
      */
     public void setActionFormUtilMap(Map validOptionsMap) {
         this.actionFormUtilMap = validOptionsMap;
     }
 
     /**
      * Gets the headerNavigationTabs attribute.
      *
      * @return Returns the headerNavigationTabs.
      */
     public HeaderNavigation[] getHeaderNavigationTabs() {
         return headerNavigationTabs;
     }
 
     /**
      * Sets the headerNavigationTabs attribute value.
      *
      * @param headerNavigationTabs The headerNavigationTabs to set.
      */
     public void setHeaderNavigationTabs(HeaderNavigation[] headerNavigationTabs) {
         this.headerNavigationTabs = headerNavigationTabs;
     }
 
     /**
      * Gets the navigationCss attribute.
      *
      * @return Returns the navigationCss.
      */
     public String getNavigationCss() {
         return navigationCss;
     }
 
     /**
      * Sets the navigationCss attribute value.
      *
      * @param navigationCss The navigationCss to set.
      */
     public void setNavigationCss(String navigationCss) {
         this.navigationCss = navigationCss;
     }
 
     public String getAnchor() {
         return anchor;
     }
 
     public void setAnchor(String anchor) {
         this.anchor = anchor;
     }
 
     public List<ExtraButton> getExtraButtons() {
         return extraButtons;
     }
 
     public void setExtraButtons(List<ExtraButton> extraButtons) {
         if ( extraButtons instanceof AutoPopulatingList ) {
             this.extraButtons = extraButtons;
         } else {
             this.extraButtons.clear();
             this.extraButtons.addAll( extraButtons );
         }
     }
 
     public ExtraButton getExtraButton( int index ) {
         return extraButtons.get( index );
     }
 
     public void setExtraButton( int index, ExtraButton extraButton ) {
         extraButtons.set( index, extraButton );
     }
 
     /**
      * Returns whether field level help is enabled for this form.
      * 
      * @return
      */
     public boolean isFieldLevelHelpEnabled() {
         return this.fieldLevelHelpEnabled;
     }
 
     public void setFieldLevelHelpEnabled(boolean fieldLevelHelpEnabled) {
         this.fieldLevelHelpEnabled = fieldLevelHelpEnabled;
     }
     
     
     /**
      * Retrieves a value from the form for the purposes of passing it as a parameter into the lookup or inquiry frameworks 
      * 
      * @param parameterName the name of the parameter, as expected by the lookup or inquiry frameworks
      * @param parameterValueLocation the name of the property containing the value of the parameter
      * @return the value of the parameter
      */
     public String retrieveFormValueForLookupInquiryParameters(String parameterName, String parameterValueLocation) {
             // dereference literal values by simply trimming of the prefix
             if (parameterValueLocation.startsWith(literalPrefixAndDelimiter)) {
                     return parameterValueLocation.substring(literalPrefixAndDelimiter.length());
             }
 
             Object value = ObjectUtils.getPropertyValue(this, parameterValueLocation);
                 if (value == null) {
                         return null;
                 }
                 if (value instanceof String) {
                         return (String) value;
                 }
                 Formatter formatter = Formatter.getFormatter(value.getClass());
                 return (String) formatter.format(value);        
     }
 
         /**
          * This overridden method ...
          * 
          * @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#shouldPropertyBePopulatedInForm(java.lang.String, javax.servlet.http.HttpServletRequest)
          */
         @Override
         public boolean shouldPropertyBePopulatedInForm(
                         String requestParameterName, HttpServletRequest request) {
                 if (requestParameterName.startsWith(KNSConstants.TAB_STATES)) {
                         return true;
                 }
                 
                 if (requestParameterName.equals(KNSConstants.DISPATCH_REQUEST_PARAMETER)) {
                         String methodToCallParameterName = request.getParameter(KNSConstants.DISPATCH_REQUEST_PARAMETER);
                         if(StringUtils.equals(methodToCallParameterName, KNSConstants.RETURN_METHOD_TO_CALL)){
                                 return true;
                         }
                 }
                 
                 return super.shouldPropertyBePopulatedInForm(requestParameterName, request);
         }
     
     public boolean shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, HttpServletRequest request) {
             if ("GET".equalsIgnoreCase(request.getMethod())) {
                     return true;
             }
             if (shouldPropertyBePopulatedInForm(methodToCallParameterName, request)) {
                     return true;
             }
             if (methodToCallParameterName != null && WebUtils.endsWithCoordinates(methodToCallParameterName)) {
                     methodToCallParameterName = methodToCallParameterName.substring(0, WebUtils.getIndexOfCoordinateExtension(methodToCallParameterName));
                 if (shouldPropertyBePopulatedInForm(methodToCallParameterName, request)) {
                         return true;
                 }
             }
             if (KNSConstants.METHOD_TO_CALL_PATH.equals(methodToCallParameterName)) {
                     if (shouldPropertyBePopulatedInForm(methodToCallParameterValue, request)) {
                             return true;
                     }
                     if (methodToCallParameterValue != null && WebUtils.endsWithCoordinates(methodToCallParameterName)) {
                             methodToCallParameterValue = methodToCallParameterValue.substring(0, WebUtils.getIndexOfCoordinateExtension(methodToCallParameterName));
                             if (shouldPropertyBePopulatedInForm(methodToCallParameterValue, request)) {
                                 return true;
                         }
                     }
             }
             return false;
     }
 
         /**
          * @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#clearEditablePropertyInformation()
          */
         @Override
         public void clearEditablePropertyInformation() {
                 super.clearEditablePropertyInformation();
         }
         
         public void setDerivedValuesOnForm(HttpServletRequest request) {
         }
 
         /**
          * @see org.apache.struts.action.ActionForm#reset(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)
          */
         @Override
         public void reset(ActionMapping mapping, HttpServletRequest request) {
                 super.reset(mapping, request);
                 if (extraButtons != null) {
                         extraButtons.clear();
                 }
                 //fieldNameToFocusOnAfterSubmit = "";
                 clearDisplayedMessages();
         }
 
         /**
          * @see org.apache.struts.action.ActionForm#reset(org.apache.struts.action.ActionMapping, javax.servlet.ServletRequest)
          */
         @Override
         public void reset(ActionMapping mapping, ServletRequest request) {
                 super.reset(mapping, request);
                 if (extraButtons != null) {
                         extraButtons.clear();
                 }
                 //fieldNameToFocusOnAfterSubmit = "";
                 clearDisplayedMessages();
         }
         
         private void clearDisplayedMessages() {
                 if (displayedErrors != null) {
                         displayedErrors.clear();
                 }
                 if (displayedWarnings != null) {
                         displayedWarnings.clear();
                 }
                 if (displayedInfo != null) {
                         displayedInfo.clear();
                 }
         }
         
     /**
          * @return the backLocation
          */
         public String getBackLocation() {
                 return this.backLocation;
         }
 
         /**
          * @param backLocation the backLocation to set
          */
         public void setBackLocation(String backLocation) {
                 this.backLocation = backLocation;
         }
 
 }

1		/*
2		* Copyright 2006-2011 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.opensource.org/licenses/ecl2.php
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*/
16		package org.kuali.rice.kns.web.struts.form;
17
18		import org.apache.commons.lang.StringUtils;
19		import org.apache.struts.action.ActionMapping;
20		import org.kuali.rice.core.framework.services.CoreFrameworkServiceLocator;
21		import org.kuali.rice.core.web.format.Formatter;
22		import org.kuali.rice.kns.datadictionary.HeaderNavigation;
23		import org.kuali.rice.kns.util.ActionFormUtilMap;
24		import org.kuali.rice.kns.util.KNSConstants;
25		import org.kuali.rice.kns.util.ObjectUtils;
26		import org.kuali.rice.kns.util.WebUtils;
27		import org.kuali.rice.kns.web.struts.pojo.PojoFormBase;
28		import org.kuali.rice.kns.web.ui.ExtraButton;
29		import org.kuali.rice.kns.web.ui.HeaderField;
30		import org.springframework.util.AutoPopulatingList;
31
32		import javax.servlet.ServletRequest;
33		import javax.servlet.http.HttpServletRequest;
34		import java.util.ArrayList;
35		import java.util.HashMap;
36		import java.util.List;
37		import java.util.Map;
38
39		/**
40		* This class common properites for all action forms.
41		*/
42		public class KualiForm extends PojoFormBase {
43		private static final long serialVersionUID = 1L;
44
45		private static final String literalPrefixAndDelimiter =
46		KNSConstants.LOOKUP_PARAMETER_LITERAL_PREFIX+KNSConstants.LOOKUP_PARAMETER_LITERAL_DELIMITER;
47
48		private String backLocation;
49		private String methodToCall;
50		private String refreshCaller;
51		private String anchor;
52		private Map<String, String> tabStates;
53		private Map actionFormUtilMap;
54	0	private Map displayedErrors = new HashMap();
55	0	private Map<String, Object> displayedWarnings = new HashMap<String, Object>();
56	0	private Map<String, Object> displayedInfo = new HashMap<String, Object>();
57	0	private int currentTabIndex = 0;
58	0	private int arbitrarilyHighIndex = 1000000;
59
60		private String navigationCss;
61		private HeaderNavigation[] headerNavigationTabs;
62	0	protected List<ExtraButton> extraButtons = new AutoPopulatingList( ExtraButton.class ) ;
63
64		private boolean fieldLevelHelpEnabled;
65
66		private List<HeaderField> docInfo;
67	0	private int numColumns = 2;
68
69		private String fieldNameToFocusOnAfterSubmit;
70
71		/**
72		* @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#addRequiredNonEditableProperties()
73		*/
74		@Override
75		public void addRequiredNonEditableProperties(){
76	0	super.addRequiredNonEditableProperties();
77	0	registerRequiredNonEditableProperty(KNSConstants.REFRESH_CALLER);
78	0	}
79
80		public int getNumColumns() {
81	0	return this.numColumns;
82		}
83
84		public void setNumColumns(int numColumns) {
85	0	this.numColumns = numColumns;
86	0	}
87
88		public List<HeaderField> getDocInfo() {
89	0	return this.docInfo;
90		}
91
92		public void setDocInfo(List<HeaderField> docInfo) {
93	0	this.docInfo = docInfo;
94	0	}
95
96		/**
97		* no args constructor which must init our tab states list
98		*/
99	0	public KualiForm() {
100	0	this.tabStates = new HashMap<String, String>();
101	0	this.actionFormUtilMap = new ActionFormUtilMap();
102	0	this.docInfo = new ArrayList<HeaderField>();
103	0	}
104
105		/**
106		* Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.
107		*/
108		public void populate(HttpServletRequest request) {
109	0	setMethodToCall(WebUtils.parseMethodToCall(this, request));
110
111	0	super.populate(request);
112
113	0	populateBackLocation(request);
114	0	populateFieldLevelHelpEnabled(request);
115
116	0	if (actionFormUtilMap instanceof ActionFormUtilMap) {
117	0	((ActionFormUtilMap) actionFormUtilMap).setCacheValueFinderResults(true);
118		}
119	0	}
120
121		private static Boolean ENABLE_FIELD_LEVEL_HELP_IND;
122
123		protected void populateBackLocation(HttpServletRequest request){
124	0	if (getParameter(request, "returnLocation") != null) {
125	0	setBackLocation(getParameter(request, "returnLocation"));
126		}
127	0	}
128
129		/**
130		* Populates whether the each field will have field-level help associated with it. Depending on how the jsp/tags are implemented, the value
131		* populated by this method may be overruled by other settings
132		*
133		* @param request
134		*/
135		protected void populateFieldLevelHelpEnabled(HttpServletRequest request) {
136	0	if ( ENABLE_FIELD_LEVEL_HELP_IND == null ) {
137	0	ENABLE_FIELD_LEVEL_HELP_IND = CoreFrameworkServiceLocator.getParameterService().getParameterValueAsBoolean(KNSConstants.KNS_NAMESPACE,
138		KNSConstants.DetailTypes.ALL_DETAIL_TYPE, KNSConstants.SystemGroupParameterNames.ENABLE_FIELD_LEVEL_HELP_IND, Boolean.FALSE);
139		}
140	0	setFieldLevelHelpEnabled( ENABLE_FIELD_LEVEL_HELP_IND);
141	0	}
142
143		public Map getDisplayedErrors() {
144	0	return displayedErrors;
145		}
146
147		/**
148		* @return the displayedWarnings
149		*/
150		public Map<String, Object> getDisplayedWarnings() {
151	0	return this.displayedWarnings;
152		}
153
154		/**
155		* @return the displayedInfo
156		*/
157		public Map<String, Object> getDisplayedInfo() {
158	0	return this.displayedInfo;
159		}
160
161		/**
162		* Used by the dispatch action to determine which action method to call into.
163		*
164		* @return Returns the methodToCall.
165		*/
166		public String getMethodToCall() {
167	0	return methodToCall;
168		}
169
170
171		/**
172		* @param methodToCall The methodToCall to set.
173		*/
174		public void setMethodToCall(String methodToCall) {
175	0	this.methodToCall = methodToCall;
176	0	}
177
178
179		/**
180		* Can be used by actions refresh method to determine what called the the refresh method.
181		*
182		* @return Returns the refreshCaller.
183		*/
184		public String getRefreshCaller() {
185	0	return refreshCaller;
186		}
187
188
189		/**
190		* @param refreshCaller The refreshCaller to set.
191		*/
192		public void setRefreshCaller(String refreshCaller) {
193	0	this.refreshCaller = refreshCaller;
194	0	}
195
196		/**
197		* @return the tab state list
198		*/
199		public Map<String, String> getTabStates() {
200	0	return tabStates;
201		}
202
203		/**
204		* simple setter for the tab state Map
205		*
206		* @param tabStates
207		*/
208		public void setTabStates(Map<String, String> tabStates) {
209	0	this.tabStates = tabStates;
210	0	}
211
212		/**
213		* Special getter based on key to work with multi rows for tab state objects
214		*/
215		public String getTabState(String key) {
216	0	String state = KNSConstants.EMPTY_STRING;
217	0	if (tabStates.containsKey(key)) {
218	0	if (tabStates.get(key) instanceof String) {
219	0	state = tabStates.get(key);
220		}
221		else {
222		//This is the case where the value is an Array of String,
223		//so we'll have to get the first element
224	0	Object result = tabStates.get(key);
225	0	result.getClass();
226	0	state = ((String[])result)[0];
227		}
228		}
229
230	0	return state;
231		}
232
233		public int getCurrentTabIndex() {
234	0	return currentTabIndex;
235		}
236
237		public void setCurrentTabIndex(int currentTabIndex) {
238	0	this.currentTabIndex = currentTabIndex;
239	0	}
240
241		public void incrementTabIndex() {
242	0	this.currentTabIndex++;
243	0	}
244
245		public int getNextArbitrarilyHighIndex() {
246	0	return this.arbitrarilyHighIndex++;
247		}
248
249		public String getFieldNameToFocusOnAfterSubmit() {
250	0	return this.fieldNameToFocusOnAfterSubmit;
251		}
252
253		public void setFieldNameToFocusOnAfterSubmit(String fieldNameToFocusOnAfterSubmit) {
254	0	this.fieldNameToFocusOnAfterSubmit = fieldNameToFocusOnAfterSubmit;
255	0	}
256
257		/**
258		* @return Returns the validOptionsMap.
259		*/
260		public Map getActionFormUtilMap() {
261	0	return actionFormUtilMap;
262		}
263
264		/**
265		* @param validOptionsMap The validOptionsMap to set.
266		*/
267		public void setActionFormUtilMap(Map validOptionsMap) {
268	0	this.actionFormUtilMap = validOptionsMap;
269	0	}
270
271		/**
272		* Gets the headerNavigationTabs attribute.
273		*
274		* @return Returns the headerNavigationTabs.
275		*/
276		public HeaderNavigation[] getHeaderNavigationTabs() {
277	0	return headerNavigationTabs;
278		}
279
280		/**
281		* Sets the headerNavigationTabs attribute value.
282		*
283		* @param headerNavigationTabs The headerNavigationTabs to set.
284		*/
285		public void setHeaderNavigationTabs(HeaderNavigation[] headerNavigationTabs) {
286	0	this.headerNavigationTabs = headerNavigationTabs;
287	0	}
288
289		/**
290		* Gets the navigationCss attribute.
291		*
292		* @return Returns the navigationCss.
293		*/
294		public String getNavigationCss() {
295	0	return navigationCss;
296		}
297
298		/**
299		* Sets the navigationCss attribute value.
300		*
301		* @param navigationCss The navigationCss to set.
302		*/
303		public void setNavigationCss(String navigationCss) {
304	0	this.navigationCss = navigationCss;
305	0	}
306
307		public String getAnchor() {
308	0	return anchor;
309		}
310
311		public void setAnchor(String anchor) {
312	0	this.anchor = anchor;
313	0	}
314
315		public List<ExtraButton> getExtraButtons() {
316	0	return extraButtons;
317		}
318
319		public void setExtraButtons(List<ExtraButton> extraButtons) {
320	0	if ( extraButtons instanceof AutoPopulatingList ) {
321	0	this.extraButtons = extraButtons;
322		} else {
323	0	this.extraButtons.clear();
324	0	this.extraButtons.addAll( extraButtons );
325		}
326	0	}
327
328		public ExtraButton getExtraButton( int index ) {
329	0	return extraButtons.get( index );
330		}
331
332		public void setExtraButton( int index, ExtraButton extraButton ) {
333	0	extraButtons.set( index, extraButton );
334	0	}
335
336		/**
337		* Returns whether field level help is enabled for this form.
338		*
339		* @return
340		*/
341		public boolean isFieldLevelHelpEnabled() {
342	0	return this.fieldLevelHelpEnabled;
343		}
344
345		public void setFieldLevelHelpEnabled(boolean fieldLevelHelpEnabled) {
346	0	this.fieldLevelHelpEnabled = fieldLevelHelpEnabled;
347	0	}
348
349
350		/**
351		* Retrieves a value from the form for the purposes of passing it as a parameter into the lookup or inquiry frameworks
352		*
353		* @param parameterName the name of the parameter, as expected by the lookup or inquiry frameworks
354		* @param parameterValueLocation the name of the property containing the value of the parameter
355		* @return the value of the parameter
356		*/
357		public String retrieveFormValueForLookupInquiryParameters(String parameterName, String parameterValueLocation) {
358		// dereference literal values by simply trimming of the prefix
359	0	if (parameterValueLocation.startsWith(literalPrefixAndDelimiter)) {
360	0	return parameterValueLocation.substring(literalPrefixAndDelimiter.length());
361		}
362
363	0	Object value = ObjectUtils.getPropertyValue(this, parameterValueLocation);
364	0	if (value == null) {
365	0	return null;
366		}
367	0	if (value instanceof String) {
368	0	return (String) value;
369		}
370	0	Formatter formatter = Formatter.getFormatter(value.getClass());
371	0	return (String) formatter.format(value);
372		}
373
374		/**
375		* This overridden method ...
376		*
377		* @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#shouldPropertyBePopulatedInForm(java.lang.String, javax.servlet.http.HttpServletRequest)
378		*/
379		@Override
380		public boolean shouldPropertyBePopulatedInForm(
381		String requestParameterName, HttpServletRequest request) {
382	0	if (requestParameterName.startsWith(KNSConstants.TAB_STATES)) {
383	0	return true;
384		}
385
386	0	if (requestParameterName.equals(KNSConstants.DISPATCH_REQUEST_PARAMETER)) {
387	0	String methodToCallParameterName = request.getParameter(KNSConstants.DISPATCH_REQUEST_PARAMETER);
388	0	if(StringUtils.equals(methodToCallParameterName, KNSConstants.RETURN_METHOD_TO_CALL)){
389	0	return true;
390		}
391		}
392
393	0	return super.shouldPropertyBePopulatedInForm(requestParameterName, request);
394		}
395
396		public boolean shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, HttpServletRequest request) {
397	0	if ("GET".equalsIgnoreCase(request.getMethod())) {
398	0	return true;
399		}
400	0	if (shouldPropertyBePopulatedInForm(methodToCallParameterName, request)) {
401	0	return true;
402		}
403	0	if (methodToCallParameterName != null && WebUtils.endsWithCoordinates(methodToCallParameterName)) {
404	0	methodToCallParameterName = methodToCallParameterName.substring(0, WebUtils.getIndexOfCoordinateExtension(methodToCallParameterName));
405	0	if (shouldPropertyBePopulatedInForm(methodToCallParameterName, request)) {
406	0	return true;
407		}
408		}
409	0	if (KNSConstants.METHOD_TO_CALL_PATH.equals(methodToCallParameterName)) {
410	0	if (shouldPropertyBePopulatedInForm(methodToCallParameterValue, request)) {
411	0	return true;
412		}
413	0	if (methodToCallParameterValue != null && WebUtils.endsWithCoordinates(methodToCallParameterName)) {
414	0	methodToCallParameterValue = methodToCallParameterValue.substring(0, WebUtils.getIndexOfCoordinateExtension(methodToCallParameterName));
415	0	if (shouldPropertyBePopulatedInForm(methodToCallParameterValue, request)) {
416	0	return true;
417		}
418		}
419		}
420	0	return false;
421		}
422
423		/**
424		* @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#clearEditablePropertyInformation()
425		*/
426		@Override
427		public void clearEditablePropertyInformation() {
428	0	super.clearEditablePropertyInformation();
429	0	}
430
431		public void setDerivedValuesOnForm(HttpServletRequest request) {
432	0	}
433
434		/**
435		* @see org.apache.struts.action.ActionForm#reset(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)
436		*/
437		@Override
438		public void reset(ActionMapping mapping, HttpServletRequest request) {
439	0	super.reset(mapping, request);
440	0	if (extraButtons != null) {
441	0	extraButtons.clear();
442		}
443		//fieldNameToFocusOnAfterSubmit = "";
444	0	clearDisplayedMessages();
445	0	}
446
447		/**
448		* @see org.apache.struts.action.ActionForm#reset(org.apache.struts.action.ActionMapping, javax.servlet.ServletRequest)
449		*/
450		@Override
451		public void reset(ActionMapping mapping, ServletRequest request) {
452	0	super.reset(mapping, request);
453	0	if (extraButtons != null) {
454	0	extraButtons.clear();
455		}
456		//fieldNameToFocusOnAfterSubmit = "";
457	0	clearDisplayedMessages();
458	0	}
459
460		private void clearDisplayedMessages() {
461	0	if (displayedErrors != null) {
462	0	displayedErrors.clear();
463		}
464	0	if (displayedWarnings != null) {
465	0	displayedWarnings.clear();
466		}
467	0	if (displayedInfo != null) {
468	0	displayedInfo.clear();
469		}
470	0	}
471
472		/**
473		* @return the backLocation
474		*/
475		public String getBackLocation() {
476	0	return this.backLocation;
477		}
478
479		/**
480		* @param backLocation the backLocation to set
481		*/
482		public void setBackLocation(String backLocation) {
483	0	this.backLocation = backLocation;
484	0	}
485
486		}