Package 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:
InquiryForm, KualiDocumentFormBase, KualiExceptionIncidentForm, KualiFeedbackHandlerForm, KualiHelpForm, LookupForm, QuestionPromptForm
@Deprecated public class KualiForm extends PojoFormBase
Deprecated.
Use UifFormBase.
This class common properites for all action forms.
See Also:

  • Field Details

  • Constructor Details

    • KualiForm

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

  • Method Details

    • addRequiredNonEditableProperties

      public void addRequiredNonEditableProperties()
      Deprecated.
      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:
      • invalid reference 
        org.kuali.rice.krad.web.struts.pojo.PojoFormBase#addRequiredNonEditableProperties()

    • getNumColumns

      public int getNumColumns()
      Deprecated.

    • setNumColumns

      public void setNumColumns(int numColumns)
      Deprecated.

    • getDocInfo

      public List<HeaderField> getDocInfo()
      Deprecated.

    • setDocInfo

      public void setDocInfo(List<HeaderField> docInfo)
      Deprecated.

    • populate

      public void populate(javax.servlet.http.HttpServletRequest request)
      Deprecated.
      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)
      Deprecated.

    • populateFieldLevelHelpEnabled

      protected void populateFieldLevelHelpEnabled(javax.servlet.http.HttpServletRequest request)
      Deprecated.
      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()
      Deprecated.

    • getDisplayedWarnings

      public Map<String,Object> getDisplayedWarnings()
      Deprecated.
      Returns:
      the displayedWarnings

    • getDisplayedInfo

      public Map<String,Object> getDisplayedInfo()
      Deprecated.
      Returns:
      the displayedInfo

    • getMethodToCall

      public String getMethodToCall()
      Deprecated.
      Used by the dispatch action to determine which action method to call into.
      Returns:
      Returns the methodToCall.

    • setMethodToCall

      public void setMethodToCall(String methodToCall)
      Deprecated.
      Parameters:
      methodToCall - The methodToCall to set.

    • getRefreshCaller

      public String getRefreshCaller()
      Deprecated.
      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)
      Deprecated.
      Parameters:
      refreshCaller - The refreshCaller to set.

    • getTabStates

      public Map<String,String> getTabStates()
      Deprecated.
      Returns:
      the tab state list

    • setTabStates

      public void setTabStates(Map<String,String> tabStates)
      Deprecated.
      simple setter for the tab state Map
      Parameters:
      tabStates -

    • getTabState

      public String getTabState(String key)
      Deprecated.
      Special getter based on key to work with multi rows for tab state objects

    • getCurrentTabIndex

      public int getCurrentTabIndex()
      Deprecated.

    • setCurrentTabIndex

      public void setCurrentTabIndex(int currentTabIndex)
      Deprecated.

    • incrementTabIndex

      public void incrementTabIndex()
      Deprecated.

    • getNextArbitrarilyHighIndex

      public int getNextArbitrarilyHighIndex()
      Deprecated.

    • getFieldNameToFocusOnAfterSubmit

      public String getFieldNameToFocusOnAfterSubmit()
      Deprecated.

    • setFieldNameToFocusOnAfterSubmit

      public void setFieldNameToFocusOnAfterSubmit(String fieldNameToFocusOnAfterSubmit)
      Deprecated.

    • getActionFormUtilMap

      public Map getActionFormUtilMap()
      Deprecated.
      Returns:
      Returns the validOptionsMap.

    • setActionFormUtilMap

      public void setActionFormUtilMap(Map validOptionsMap)
      Deprecated.
      Parameters:
      validOptionsMap - The validOptionsMap to set.

    • getHeaderNavigationTabs

      public HeaderNavigation[] getHeaderNavigationTabs()
      Deprecated.
      Gets the headerNavigationTabs attribute.
      Returns:
      Returns the headerNavigationTabs.

    • setHeaderNavigationTabs

      public void setHeaderNavigationTabs(HeaderNavigation[] headerNavigationTabs)
      Deprecated.
      Sets the headerNavigationTabs attribute value.
      Parameters:
      headerNavigationTabs - The headerNavigationTabs to set.

    • getNavigationCss

      public String getNavigationCss()
      Deprecated.
      Gets the navigationCss attribute.
      Returns:
      Returns the navigationCss.

    • setNavigationCss

      public void setNavigationCss(String navigationCss)
      Deprecated.
      Sets the navigationCss attribute value.
      Parameters:
      navigationCss - The navigationCss to set.

    • getAnchor

      public String getAnchor()
      Deprecated.

    • setAnchor

      public void setAnchor(String anchor)
      Deprecated.

    • getExtraButtons

      public List<ExtraButton> getExtraButtons()
      Deprecated.

    • setExtraButtons

      public void setExtraButtons(List<ExtraButton> extraButtons)
      Deprecated.

    • getExtraButton

      public ExtraButton getExtraButton(int index)
      Deprecated.

    • setExtraButton

      public void setExtraButton(int index, ExtraButton extraButton)
      Deprecated.

    • isFieldLevelHelpEnabled

      public boolean isFieldLevelHelpEnabled()
      Deprecated.
      Returns whether field level help is enabled for this form.
      Returns:

    • setFieldLevelHelpEnabled

      public void setFieldLevelHelpEnabled(boolean fieldLevelHelpEnabled)
      Deprecated.

    • retrieveFormValueForLookupInquiryParameters

      public String retrieveFormValueForLookupInquiryParameters(String parameterName, String parameterValueLocation)
      Deprecated.
      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)
      Deprecated.
      Description copied from interface: PojoForm
      Returns whether a request parameter should be populated as a property of the form, assuming that the request parameter name corresponds to a property on the form. This method makes no determination whether the request parameter is a property of the form, but rather from a security perspective, whether the framework should attempt to set the form property with the same name as the request parameter.
      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:

    • shouldMethodToCallParameterBeUsed

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

    • clearEditablePropertyInformation

      public void clearEditablePropertyInformation()
      Deprecated.
      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:
      • invalid reference 
        org.kuali.rice.krad.web.struts.pojo.PojoFormBase#clearEditablePropertyInformation()

    • setDerivedValuesOnForm

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

    • reset

      public void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      Returns:
      the backLocation

    • setBackLocation

      public void setBackLocation(String backLocation)
      Deprecated.
      Parameters:
      backLocation - the backLocation to set