Uiinfrastructure API Docs  
 

AFormDP Members

AFormDP overview

Public Static Fields

GET 
HTMLFORM_NAME The name of the main form (for use in Javascript, etc...)
JAVASCRIPT_SETUP_FOR_SUBMIT_TO_CONTROL Name of helper javascript function to set up for postToPassthru function
JAVASCRIPT_SUBMIT_FORM The name of the main form javascript submission function
JAVASCRIPT_SUBMIT_TO_CONTROL Name of helper javascript function to post the form, then pass through to another control
MULTIPART_ENCODING multi-part form data encoding constant
POST Form submission types

Public Instance Constructors

AFormDP Constructor Initializes a new instance of the AFormDP class.

Public Instance Methods

AddToValidationFunction This is a helper method that adds a function to the client side page validation. If this is not called, then a blank default validation function will be used. AddValidationFunction() should be called when the DisplayPage is first being constructed in the Activity Space. It should not be called each time the page is being displayed. The function name should be just the name of the function without parentheses or semicolons. I.E. myValidateFunction, which will be called by AFormDP as myValidateFunction(). These functions should return true if the page is valid, or display an error message and return false if the page is invalid.
Display 
DisplayForm This is a helper method that adds the main form to the page. It also calls PageDisplay, so AddForm and PageDisplay should not be used in the same page.
DisplayHTMLAfterForm This is a method that classes extending this one can over write. The HTML returned by that method will get printed out after the FORM tag E. g.: If you have other forms, like with portlets. Override this method to display HTML after the form.
DisplayHTMLBeforeForm This is a method that classes extending this one can over write. The HTML returned by that method will get printed out before the FORM tag and AFTER the BODY tag. E.g.: DIV tags should go in that method. Override this method to display HTML after the body and before the form.
DisplayHTMLinHEAD This is a method that classes extending this one can over write. The HTML returned by that method will get printed out in the head. Warning: Only TITLE LINK and META can be added to the head with that method (use DisplayJavaScriptFromChild for SCRIPT) Override this method to display HTML in the head.
DisplayJavascript This is a helper method that displays the javascript in the page. SetValidationFunction() and AddJavascript() should be called before this method.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
Get508RepostURL Method Get508RepostURL.
GetCloseOnCancel This is a helper method that determines whether or not cancels should close the window immediately. This is useful in the case of pop up windows, where you don't need to know anything unless the user presses finish. In this case, cancel should just call window.close(); Override this method to immediately close the pop ups.
GetFormPageType This method returns the current page type. Override this method to display a different page type (small pop-up, etc...) This gets called at Init() time. Default has no buttons on the form.
GetFormTitle This is a helper method that all classes that inherit from AFormDP need to implement. The method should return the title that should be displayed in the window TITLE element as well as on the form header bar, if displayed. The String returned by this method needs to already be HTML Encoded for safe display.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetName 
GetOnLoad This is a method that classes extending this one can overwrite to set an onload handler for the page.
GetOwner 
GetStatusViewEnabled This method returns whether the status view is enabled.
GetStatusViewRepostValues This method returns the repost values that we will turn the status view on for. The status view replaces the body of the existing view. Be default, AFormDP is initialized to show the status view only after a FINISH repost.
GetType (inherited from Object)Gets the Type of the current instance.
GetUseJavascript 
GetWindowFocusEnabled 
Init 
InsertJavascriptBeforeFormSubmit Helper method to insert custom javascript in the form submit method right before the form is submitted. javascript should have 4 spaces indenting each line to make it line up with the code it is being inserted into.
PageDisplay This is a helper method that all classes that inherit from AFormDP need to implement. The method should add whatever HTML the child class wants to display to the body argument. The parent class will then add that HTML to the HTMLPage after filling in the banner and navigation.
PartialContentDisplay This is a helper method that all classes that inherit from AFormDP can override. When displaying in place refresh content, this method is called instead of PageDisplay. In place refresh can be enabled via setting a flag in the activity space.
RemoveFromValidationFunction This is a helper method that removes a function from the client side page validation. The function name should be just the name of the function without parentheses or semicolons. I.E. myValidateFunction, which will be called by AFormDP as myValidateFunction().
SetMultiPartEncoding This method sets whether or not the form should use multipart encoding.
SetShow508FormFooter This method sets whether or not the form should display the done and cancel buttons at the bottom of the page in 508 mode. This variable is ignored in normal mode. It is only valid in 508 and low bandwidth modes. This is for developers who provide their own buttons in standard mode, but want to use the AFormDP buttons in 508 mode (such as the editor).
SetStatusViewEnabled This method sets whether the status view is enabled.
SetStatusViewRepostValues This method sets the repost values that we will turn the status view on for. The status view replaces the body of the existing view. Be default, AFormDP is initialized to show the status view only after a FINISH repost. Set this to NULL to allow all values to display the view.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Fields

m_asOwner The parent activity space. Warning: EditorDP overrides this to provide an editor specific version, so GetOwner() must be used in this class file.

Protected Instance Methods

DisplayJavaScriptFromChild This is a helper method that all classes that inherit from AFormDP can override if they like. The method provides a hook into the head so that DP's can add javascript. Simply override and return and HTMLScript. Also, it is best to return the results of the DisplayJavaScript functions from the appropriate views. Override this method to Display javascript from child IViews
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetRepostControlName This method is provided so that the repost control name can be overridden on a per DP basis.
GetRepostTypeIsPost Override this method to set the form submission type.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

AFormDP Class | com.plumtree.uiinfrastructure.form Namespace