org.kuali.kfs.sys.document.web.struts
Class FinancialSystemTransactionalDocumentFormBase

java.lang.Object
  org.apache.struts.action.ActionForm
      org.kuali.rice.kns.web.struts.pojo.PojoFormBase
          org.kuali.rice.kns.web.struts.form.KualiForm
              org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase
                  org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase
                      org.kuali.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase

All Implemented Interfaces:

Serializable, org.kuali.rice.kns.web.struts.pojo.PojoForm

Direct Known Subclasses:

AssetTransferForm, BarcodeInventoryErrorForm, BudgetConstructionForm, BulkReceivingForm, CashControlDocumentForm, CloseForm, ContractManagerAssignmentForm, CustomerCreditMemoDocumentForm, CustomerInvoiceWriteoffDocumentForm, EffortCertificationForm, ElectronicInvoiceRejectForm, EndowmentTransactionLinesDocumentFormBase, EquipmentLoanOrReturnForm, HoldingHistoryValueAdjustmentDocumentForm, KualiAccountingDocumentFormBase, PaymentApplicationDocumentForm, ReceivingFormBase

public class FinancialSystemTransactionalDocumentFormBase
extends org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

This class is a Financial System specific transactional document form base

See Also:

Serialized Form

Field Summary

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

forcedReadOnlyFields

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

adHocActionRequestCodes, attachmentFile, documentActions, editingMode, suppressAllButtons

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

extraButtons

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

requiredNonEditableProperties

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

multipartRequestHandler, servlet

Constructor Summary

FinancialSystemTransactionalDocumentFormBase()
Constructs a FinancialSystemTransactionalDocumentFormBase.java.

Method Summary

protected void	extendDocInfoToThreeColumns() Extends the DocInfo on the form to 3 columns if it currently has less than 3 columns.
protected org.kuali.rice.kns.web.ui.ExtraButton	generateErrorCorrectionButton() Generates an ExtraButton which represents the error correction button
List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraButtons()
void	populateHeaderFields(org.kuali.rice.kns.workflow.service.KualiWorkflowDocument workflowDocument)

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

discoverDocumentTypeName, formatReversalDate, getForcedReadOnlyFields, getTransactionalDocument, instantiateTransactionalDocumentByDocumentTypeName, populate, populateEmptyMultiSelect, populateFalseCheckboxes, populationSpecialEmptyFields, setForcedReadOnlyFields, shouldMethodToCallParameterBeUsed

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

addRequiredNonEditableProperties, buildHtmlLink, customInitMaxUploadSizes, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDefaultDocumentTypeName, getDocId, getDocNum, getDocTypeName, getDocument, getDocumentActions, getDocumentHandlerUrl, getEditingMode, getErrorMapFromPreviousRequest, getFormKey, getInitiator, getInitiatorNetworkId, getMessageMapFromPreviousRequest, getNewAdHocRoutePerson, getNewAdHocRouteWorkgroup, getNewNote, getPersonInquiryUrlLink, getStandardHeaderFields, getWorkflowDocument, hasDocumentId, initializeHeaderNavigationTabs, instantiateDocument, isDocumentEnRoute, isFormDocumentInitialized, isHasWorkflowDocument, isReturnToActionList, isSuppressAllButtons, isUserDocumentInitiator, reset, setAdditionalScriptFile, setAdditionalScriptFiles, setAdHocActionRequestCodes, setAdHocRoutePersons, setAdHocRouteWorkgroups, setAnnotation, setAttachmentFile, setBoNotes, setCommand, setDerivedValuesOnForm, setDocId, setDocNum, setDocTypeName, setDocument, setDocumentActions, setEditingMode, setErrorMapFromPreviousRequest, setFormKey, setMessageMapFromPreviousRequest, setNewAdHocRoutePerson, setNewAdHocRouteWorkgroup, setNewNote, setReturnToActionList, setSuppressAllButtons, shouldPropertyBePopulatedInForm, validate

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

clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getMethodToCall, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populateBackLocation, populateFieldLevelHelpEnabled, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setMethodToCall, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates

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

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

FinancialSystemTransactionalDocumentFormBase

public FinancialSystemTransactionalDocumentFormBase()

Constructs a FinancialSystemTransactionalDocumentFormBase.java.

Method Detail

populateHeaderFields

public void populateHeaderFields(org.kuali.rice.kns.workflow.service.KualiWorkflowDocument workflowDocument)

Overrides:

populateHeaderFields in class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

See Also:

KualiDocumentFormBase.populateHeaderFields(org.kuali.rice.kns.workflow.service.KualiWorkflowDocument)

extendDocInfoToThreeColumns

protected void extendDocInfoToThreeColumns()

Extends the DocInfo on the form to 3 columns if it currently has less than 3 columns. If it has exactly 3 or more columns, no action will be taken.

getExtraButtons

public List<org.kuali.rice.kns.web.ui.ExtraButton> getExtraButtons()

Overrides:

getExtraButtons in class org.kuali.rice.kns.web.struts.form.KualiForm

See Also:

KualiForm.getExtraButtons()

generateErrorCorrectionButton

protected org.kuali.rice.kns.web.ui.ExtraButton generateErrorCorrectionButton()

Generates an ExtraButton which represents the error correction button

Returns:

an ExtraButton representing an ErrorCorrection button