org.kuali.rice.kns.web.struts.form
Class KualiForm

java.lang.Object
  org.apache.struts.action.ActionForm
      org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase
          org.kuali.rice.kns.web.struts.form.KualiForm

All Implemented Interfaces:

Serializable, PojoForm

Direct Known Subclasses:

ActionListFilterForm, ActionListForm, AuthorizationExceptionForm, BackdoorForm, DelegateRuleForm, DisplayInactivationBlockersForm, DocumentConfigurationViewForm, DocumentContentOperationForm, DocumentOperationForm, FeedbackForm, IngesterForm, InquiryForm, KewRoutingKualiForm, KualiDocumentFormBase, KualiExceptionIncidentForm, KualiFeedbackHandlerForm, KualiHelpForm, LookupForm, NoteForm, PreferencesForm, QuestionPromptForm, QuickLinksForm, RouteLogForm, RoutingReportForm, RuleForm, RuleQuickLinksForm, StatsForm

public class KualiForm
extends PojoFormBase

This class common properites for all action forms.

See Also:

Serialized Form

Nested Class Summary

static class

KualiForm.TabState Tab state UI literals

Field Summary

protected List<ExtraButton>

extraButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

requiredNonEditableProperties

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

KualiForm()
no args constructor which must init our tab states list

Method Summary

void	addRequiredNonEditableProperties() This method adds the required property names, that are not directly editable by user on the html page, to a list, regardless of the context in which they appear.
void	clearEditablePropertyInformation() Reinitializes the form to allow it to register the editable properties of the currently processing request.
Map	getActionFormUtilMap()
String	getAnchor()
String	getBackLocation()
int	getCurrentTabIndex()
Map	getDisplayedErrors()
Map<String,Object>	getDisplayedInfo()
Map<String,Object>	getDisplayedWarnings()
List<HeaderField>	getDocInfo()
ExtraButton	getExtraButton(int index)
List<ExtraButton>	getExtraButtons()
String	getFieldNameToFocusOnAfterSubmit()
HeaderNavigation[]	getHeaderNavigationTabs() Gets the headerNavigationTabs attribute.
String	getMethodToCall() Used by the dispatch action to determine which action method to call into.
String	getNavigationCss() Gets the navigationCss attribute.
int	getNextArbitrarilyHighIndex()
int	getNumColumns()
String	getRefreshCaller() Can be used by actions refresh method to determine what called the the refresh method.
String	getTabState(String key) Special getter based on key to work with multi rows for tab state objects
Map<String,String>	getTabStates()
void	incrementTabIndex()
boolean	isFieldLevelHelpEnabled() Returns whether field level help is enabled for this form.
void	populate(javax.servlet.http.HttpServletRequest request) Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.
protected void	populateBackLocation(javax.servlet.http.HttpServletRequest request)
protected void	populateFieldLevelHelpEnabled(javax.servlet.http.HttpServletRequest request) Populates whether the each field will have field-level help associated with it.
void	reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
void	reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.ServletRequest request)
String	retrieveFormValueForLookupInquiryParameters(String parameterName, String parameterValueLocation) Retrieves a value from the form for the purposes of passing it as a parameter into the lookup or inquiry frameworks
void	setActionFormUtilMap(Map validOptionsMap)
void	setAnchor(String anchor)
void	setBackLocation(String backLocation)
void	setCurrentTabIndex(int currentTabIndex)
void	setDerivedValuesOnForm(javax.servlet.http.HttpServletRequest request)
void	setDocInfo(List<HeaderField> docInfo)
void	setExtraButton(int index, ExtraButton extraButton)
void	setExtraButtons(List<ExtraButton> extraButtons)
void	setFieldLevelHelpEnabled(boolean fieldLevelHelpEnabled)
void	setFieldNameToFocusOnAfterSubmit(String fieldNameToFocusOnAfterSubmit)
void	setHeaderNavigationTabs(HeaderNavigation[] headerNavigationTabs) Sets the headerNavigationTabs attribute value.
void	setMethodToCall(String methodToCall)
void	setNavigationCss(String navigationCss) Sets the navigationCss attribute value.
void	setNumColumns(int numColumns)
void	setRefreshCaller(String refreshCaller)
void	setTabStates(Map<String,String> tabStates) simple setter for the tab state Map
boolean	shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, javax.servlet.http.HttpServletRequest request)
boolean	shouldPropertyBePopulatedInForm(String requestParameterName, javax.servlet.http.HttpServletRequest request) This overridden method ...

Methods inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, customInitMaxUploadSizes, formatterClassForKeypath, formatValue, getActionEditablePropertiesGuid, getEditableProperties, getFormatter, getFormatterTypes, getIsNewForm, getMaxUploadSizes, getMethodToCallsToBypassSessionRetrievalForGETRequests, getParameter, getParameterValues, getPopulateEditableProperties, getPopulateEditablePropertiesGuid, getPropertyType, getRequiredNonEditableProperties, getStrutsActionMappingScope, getUnconvertedValues, getUnknownKeys, initMaxUploadSizes, isPropertyEditable, isPropertyNonEditableButRequired, populateForProperty, postprocessRequestParameters, processValidationFail, registerEditableProperty, registerIsNewForm, registerRequiredNonEditableProperty, registerStrutsActionMappingScope, setActionEditablePropertiesGuid, setFormatterType, setFormatterTypes, setPopulateEditablePropertiesGuid, setUnconvertedValues

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

extraButtons

protected List<ExtraButton> extraButtons

Constructor Detail

KualiForm

public KualiForm()

no args constructor which must init our tab states list

Method Detail

addRequiredNonEditableProperties

public void addRequiredNonEditableProperties()

Description copied from interface: PojoForm

This method adds the required property names, that are not directly editable by user on the html page, to a list, regardless of the context in which they appear. Request parameter names corresponding to these properties will be populated into the form.

Specified by:

addRequiredNonEditableProperties in interface PojoForm

Overrides:

addRequiredNonEditableProperties in class PojoFormBase

See Also:

org.kuali.rice.krad.web.struts.pojo.PojoFormBase#addRequiredNonEditableProperties()

getNumColumns

public int getNumColumns()

setNumColumns

public void setNumColumns(int numColumns)

getDocInfo

public List<HeaderField> getDocInfo()

setDocInfo

public void setDocInfo(List<HeaderField> docInfo)

populate

public void populate(javax.servlet.http.HttpServletRequest request)

Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.

Specified by:

populate in interface PojoForm

Overrides:

populate in class PojoFormBase

populateBackLocation

protected void populateBackLocation(javax.servlet.http.HttpServletRequest request)

populateFieldLevelHelpEnabled

protected void populateFieldLevelHelpEnabled(javax.servlet.http.HttpServletRequest request)

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

Parameters:

request -

getDisplayedErrors

public Map getDisplayedErrors()

getDisplayedWarnings

public Map<String,Object> getDisplayedWarnings()

Returns:

the displayedWarnings

getDisplayedInfo

public Map<String,Object> getDisplayedInfo()

Returns:

the displayedInfo

getMethodToCall

public String getMethodToCall()

Used by the dispatch action to determine which action method to call into.

Returns:

Returns the methodToCall.

setMethodToCall

public void setMethodToCall(String methodToCall)

Parameters:

methodToCall - The methodToCall to set.

getRefreshCaller

public String getRefreshCaller()

Can be used by actions refresh method to determine what called the the refresh method.

Returns:

Returns the refreshCaller.

setRefreshCaller

public void setRefreshCaller(String refreshCaller)

Parameters:

refreshCaller - The refreshCaller to set.

getTabStates

public Map<String,String> getTabStates()

Returns:

the tab state list

setTabStates

public void setTabStates(Map<String,String> tabStates)

simple setter for the tab state Map

Parameters:

tabStates -

getTabState

public String getTabState(String key)

Special getter based on key to work with multi rows for tab state objects

getCurrentTabIndex

public int getCurrentTabIndex()

setCurrentTabIndex

public void setCurrentTabIndex(int currentTabIndex)

incrementTabIndex

public void incrementTabIndex()

getNextArbitrarilyHighIndex

public int getNextArbitrarilyHighIndex()

getFieldNameToFocusOnAfterSubmit

public String getFieldNameToFocusOnAfterSubmit()

setFieldNameToFocusOnAfterSubmit

public void setFieldNameToFocusOnAfterSubmit(String fieldNameToFocusOnAfterSubmit)

getActionFormUtilMap

public Map getActionFormUtilMap()

Returns:

Returns the validOptionsMap.

setActionFormUtilMap

public void setActionFormUtilMap(Map validOptionsMap)

Parameters:

validOptionsMap - The validOptionsMap to set.

getHeaderNavigationTabs

public HeaderNavigation[] getHeaderNavigationTabs()

Gets the headerNavigationTabs attribute.

Returns:

Returns the headerNavigationTabs.

setHeaderNavigationTabs

public void setHeaderNavigationTabs(HeaderNavigation[] headerNavigationTabs)

Sets the headerNavigationTabs attribute value.

Parameters:

headerNavigationTabs - The headerNavigationTabs to set.

getNavigationCss

public String getNavigationCss()

Gets the navigationCss attribute.

Returns:

Returns the navigationCss.

setNavigationCss

public void setNavigationCss(String navigationCss)

Sets the navigationCss attribute value.

Parameters:

navigationCss - The navigationCss to set.

getAnchor

public String getAnchor()

setAnchor

public void setAnchor(String anchor)

getExtraButtons

public List<ExtraButton> getExtraButtons()

setExtraButtons

public void setExtraButtons(List<ExtraButton> extraButtons)

getExtraButton

public ExtraButton getExtraButton(int index)

setExtraButton

public void setExtraButton(int index,
                           ExtraButton extraButton)

isFieldLevelHelpEnabled

public boolean isFieldLevelHelpEnabled()

Returns whether field level help is enabled for this form.

Returns:

setFieldLevelHelpEnabled

public void setFieldLevelHelpEnabled(boolean fieldLevelHelpEnabled)

retrieveFormValueForLookupInquiryParameters

public String retrieveFormValueForLookupInquiryParameters(String parameterName,
                                                          String parameterValueLocation)

Retrieves a value from the form for the purposes of passing it as a parameter into the lookup or inquiry frameworks

Parameters:

parameterName - the name of the parameter, as expected by the lookup or inquiry frameworks

parameterValueLocation - the name of the property containing the value of the parameter

Returns:

the value of the parameter

shouldPropertyBePopulatedInForm

public boolean shouldPropertyBePopulatedInForm(String requestParameterName,
                                               javax.servlet.http.HttpServletRequest request)

This overridden method ...

Specified by:

shouldPropertyBePopulatedInForm in interface PojoForm

Overrides:

shouldPropertyBePopulatedInForm in class PojoFormBase

Parameters:

requestParameterName - the name of the request parameter

request - the HTTP request

Returns:

whether the parameter should be

See Also:

org.kuali.rice.krad.web.struts.pojo.PojoFormBase#shouldPropertyBePopulatedInForm(java.lang.String, javax.servlet.http.HttpServletRequest)

shouldMethodToCallParameterBeUsed

public boolean shouldMethodToCallParameterBeUsed(String methodToCallParameterName,
                                                 String methodToCallParameterValue,
                                                 javax.servlet.http.HttpServletRequest request)

clearEditablePropertyInformation

public void clearEditablePropertyInformation()

Description copied from interface: PojoForm

Reinitializes the form to allow it to register the editable properties of the currently processing request.

Specified by:

clearEditablePropertyInformation in interface PojoForm

Overrides:

clearEditablePropertyInformation in class PojoFormBase

See Also:

org.kuali.rice.krad.web.struts.pojo.PojoFormBase#clearEditablePropertyInformation()

setDerivedValuesOnForm

public void setDerivedValuesOnForm(javax.servlet.http.HttpServletRequest request)

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)

Overrides:

reset in class org.apache.struts.action.ActionForm

See Also:

ActionForm.reset(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.ServletRequest request)

Overrides:

reset in class org.apache.struts.action.ActionForm

See Also:

ActionForm.reset(org.apache.struts.action.ActionMapping, javax.servlet.ServletRequest)

getBackLocation

public String getBackLocation()

Returns:

the backLocation

setBackLocation

public void setBackLocation(String backLocation)

Parameters:

backLocation - the backLocation to set