|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.form.AFormDP
public abstract class AFormDP
All AActivitySpaces that contain IDisplayPages that extend AFormDP must also implement IRepostAS. The exception to this rule is that PlumtreeDP extends AFormDP, but by default does not include the form code. Therefore, when you are using PlumtreeDP, you only need to implement IRepostAS if you have called SetAddMainForm(true);
Field Summary | |
---|---|
static java.lang.String |
GET
|
static java.lang.String |
HTMLFORM_NAME
The name of the main form (for use in Javascript, etc...) |
static java.lang.String |
JAVASCRIPT_SETUP_FOR_SUBMIT_TO_CONTROL
Name of helper javascript function to set up for postToPassthru function |
static java.lang.String |
JAVASCRIPT_SUBMIT_FORM
The name of the main form javascript submission function |
static java.lang.String |
JAVASCRIPT_SUBMIT_TO_CONTROL
Name of helper javascript function to post the form, then pass through to another control |
protected AActivitySpace |
m_asOwner
The parent activity space. |
static java.lang.String |
MULTIPART_ENCODING
multi-part form data encoding constant |
static java.lang.String |
POST
Form submission types |
Constructor Summary | |
---|---|
AFormDP()
|
Method Summary | |
---|---|
void |
AddToValidationFunction(java.lang.String functionName)
This is a helper method that adds a function to the client side page validation. |
void |
Display(IWebData pageData)
Construct the HTMLPage for Display. |
HTMLForm |
DisplayForm()
This is a helper method that adds the main form to the page. |
HTMLElementCollection |
DisplayHTMLAfterForm()
This is a method that classes extending this one can over write. |
HTMLElementCollection |
DisplayHTMLBeforeForm()
This is a method that classes extending this one can over write. |
HTMLElementCollection |
DisplayHTMLinHEAD()
This is a method that classes extending this one can over write. |
HTMLScriptCollection |
DisplayJavascript()
This is a helper method that displays the javascript in the page. |
protected HTMLScriptCollection |
DisplayJavaScriptFromChild()
This is a helper method that all classes that inherit from AFormDP can override if they like. |
ASURL |
Get508RepostURL(int nRepostAction)
Method Get508RepostURL. |
boolean |
GetCloseOnCancel()
This is a helper method that determines whether or not cancels should close the window immediately. |
FormPageTypes |
GetFormPageType()
This method returns the current page type. |
abstract java.lang.String |
GetFormTitle()
This is a helper method that all classes that inherit from AFormDP need to implement. |
abstract java.lang.String |
GetName()
Return the name of the MVC object. |
java.lang.String |
GetOnLoad()
This is a method that classes extending this one can overwrite to set an onload handler for the page. |
AActivitySpace |
GetOwner()
Return the owning Activity Space. |
protected java.lang.String |
GetRepostControlName()
This method is provided so that the repost control name can be overridden on a per DP basis. |
protected boolean |
GetRepostTypeIsPost()
Override this method to set the form submission type. |
boolean |
GetStatusViewEnabled()
This method returns whether the status view is enabled. |
int[] |
GetStatusViewRepostValues()
This method returns the repost values that we will turn the status view on for. |
boolean |
GetUseJavascript()
|
boolean |
GetWindowFocusEnabled()
|
void |
Init(AActivitySpace parent)
Initialize the Display Page. |
void |
InsertJavascriptBeforeFormSubmit(XPStringBuilder sb)
Helper method to insert custom javascript in the form submit method right before the form is submitted. |
abstract HTMLElement |
PageDisplay()
This is a helper method that all classes that inherit from AFormDP need to implement. |
HTMLElement |
PartialContentDisplay()
This is a helper method that all classes that inherit from AFormDP can override. |
void |
RemoveFromValidationFunction(java.lang.String functionName)
This is a helper method that removes a function from the client side page validation. |
void |
SetMultiPartEncoding(boolean bMultiPart)
This method sets whether or not the form should use multipart encoding. |
void |
SetShow508FormFooter(boolean bShow508Footer)
This method sets whether or not the form should display the done and cancel buttons at the bottom of the page in 508 mode. |
void |
SetStatusViewEnabled(boolean bEnabled)
This method sets whether the status view is enabled. |
void |
SetStatusViewRepostValues(int[] aRepostValues)
This method sets the repost values that we will turn the status view on for. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String HTMLFORM_NAME
public static final java.lang.String JAVASCRIPT_SUBMIT_FORM
public static final java.lang.String JAVASCRIPT_SETUP_FOR_SUBMIT_TO_CONTROL
public static final java.lang.String JAVASCRIPT_SUBMIT_TO_CONTROL
public static final java.lang.String MULTIPART_ENCODING
public static final java.lang.String POST
public static final java.lang.String GET
protected AActivitySpace m_asOwner
Constructor Detail |
---|
public AFormDP()
Method Detail |
---|
public final void AddToValidationFunction(java.lang.String functionName)
String
- the name of the Javascript function to call for validationpublic final void RemoveFromValidationFunction(java.lang.String functionName)
String
- the name of the Javascript function to remove from the list
of functions to call for validationpublic final void SetMultiPartEncoding(boolean bMultiPart)
boolean
- true implies multipart encoding in the form.public final void SetShow508FormFooter(boolean bShow508Footer)
boolean
- true implies buttons in footer, no header is displayed (in 508 mode).public FormPageTypes GetFormPageType()
public HTMLElementCollection DisplayHTMLBeforeForm()
public HTMLElementCollection DisplayHTMLAfterForm()
public int[] GetStatusViewRepostValues()
public void SetStatusViewRepostValues(int[] aRepostValues)
aRepostValues
- Values for which you want the status view on.public boolean GetStatusViewEnabled()
public void SetStatusViewEnabled(boolean bEnabled)
bEnabled
- True to enable the status view, false otherwise.public HTMLElementCollection DisplayHTMLinHEAD()
public java.lang.String GetOnLoad()
public boolean GetCloseOnCancel()
public abstract java.lang.String GetFormTitle()
public abstract java.lang.String GetName()
IMVCObject
GetName
in interface IMVCObject
IMVCObject.GetName()
public abstract HTMLElement PageDisplay()
public void Display(IWebData pageData)
IDisplayPage
Display
in interface IDisplayPage
Warning: PlumtreeDP overrides this, so if you change things here, you probably
need to change it there as well.
public final HTMLScriptCollection DisplayJavascript()
public boolean GetWindowFocusEnabled()
public void InsertJavascriptBeforeFormSubmit(XPStringBuilder sb)
sb
- StringBuilder to add your custom javascript to.public HTMLForm DisplayForm()
public ASURL Get508RepostURL(int nRepostAction)
nRepostAction
-
public AActivitySpace GetOwner()
IDisplayPage
GetOwner
in interface IDisplayPage
IDisplayPage.GetOwner()
public void Init(AActivitySpace parent)
IDisplayPage
Init
in interface IDisplayPage
IDisplayPage.Init(AActivitySpace)
protected HTMLScriptCollection DisplayJavaScriptFromChild()
protected java.lang.String GetRepostControlName()
protected boolean GetRepostTypeIsPost()
public boolean GetUseJavascript()
public HTMLElement PartialContentDisplay()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |