IRISLIB database
TableForm Class Reference

This class is used internally by InterSystems IRIS. More...

Inheritance diagram for TableForm:
Collaboration diagram for TableForm:

Public Member Functions

_.Library.Status OnSubmit (_.Library.String pID, _.Library.String pSubmit)
 This callback is called when this form is submitted. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Static Public Member Functions

_.CSP.Util.AutoForm CreateInstance (_.Library.String pID)
 Create an instance of the AutoForm object using the provided ID value(s). More...
 
_.Library.Status DrawHTMLForm (_.Library.RegisteredObject pObj, _.Library.String pID, _.Library.String pActionURL, _.CSP.Util.FormButton pButtons, _.Library.String pTarget)
 Draw an HTML form for this form object. More...
 
 OnDefineButtons (_.CSP.Util.FormButton pButtons)
 define standard Login buttons
 
- Static Public Member Functions inherited from AutoForm
_.Library.Status DispatchSubmit (_.Library.String pSubmit)
 This method invokes a submit on the appropriate form class. More...
 
_.Library.String DoSubmit ()
 Common expiration date used for cookies. More...
 
 DrawFormButtons (_.CSP.Util.FormButton pButtons)
 Draw the buttons for a form...
 
_.Library.Status DrawHTMLForm (_.Library.RegisteredObject pObj, _.Library.String pID, _.Library.String pActionURL, _.CSP.Util.FormButton pButtons, _.Library.String pTarget)
 Draw an HTML form for this form object. More...
 
_.Library.Status DrawHTMLTable (_.Library.RegisteredObject pObj, _.Library.String pID)
 Draw an HTML detail table for this form object. More...
 
_.Library.String GetComboBoxHTML (_.Library.String pValue, _.Library.String pName, _.Library.String pClass, _.Library.String pQuery, _.Library.String pCaptionColumn, _.Library.String pValueColumn, _.Library.String pP1, _.Library.String pP2, _.Library.String pP3)
 Construct an HTML string defining a combo box for the given query. More...
 
_.Library.String GetFormError ()
 Get error message to be displayed within an AutoForm.
 
 OnDefineButtons (_.CSP.Util.FormButton pButtons)
 Subclasses can override this to redefine the buttons for a form.
 
_.CSP.Util.AutoForm ProcessSubmit (_.CSP.Request pRequest, _.Library.String pID, _.Library.String pErrorMsg)
 Takes submitted data for a form and returns an instance of AutoForm object.
 
 SetFormError (_.Library.String pMsg)
 Set a error message to be displayed within an AutoForm.
 
_.Library.Status Submit (_.CSP.Request pRequest, _.Library.String pSubmit)
 Called by the page handler when a form is submitted. More...
 

Public Attributes

 NumberOfColumns
 Number of Columns. More...
 
 SchemaName
 Schema. More...
 
 TableName
 Table Name. More...
 

Additional Inherited Members

- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 
- Static Public Attributes inherited from AutoForm
 COMMANDFORM = None
 If true (1) then this is a specialized type of form that only. More...
 
 DOMAIN = None
 Default domain for the Portal's localization.
 
 FORMCOLUMNS = None
 Number of columns used to layout forms for this class.
 

Detailed Description

This class is used internally by InterSystems IRIS.

You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Create New Table

Member Function Documentation

◆ CreateInstance()

_.CSP.Util.AutoForm CreateInstance ( _.Library.String  pID)
static

Create an instance of the AutoForm object using the provided ID value(s).

This is overridden by subclasses.
The default implementation will perform an OpenId if the AutoForm is a persistent object.

Reimplemented from AutoForm.

◆ DrawHTMLForm()

_.Library.Status DrawHTMLForm ( _.Library.RegisteredObject  pObj,
_.Library.String  pID,
_.Library.String  pActionURL,
_.CSP.Util.FormButton  pButtons,
_.Library.String  pTarget 
)
static

Draw an HTML form for this form object.


pObj is an instance of the form object that provides the initial values for the form.
pActionURL is the URL to submit this form to.
pButtons is an array of submit buttons to display for the form. If not provided, the default Save and Cancel buttons are shown. pButtons is an integer-subscripted array of <class>FormButton</class> objects.

◆ OnSubmit()

_.Library.Status OnSubmit ( _.Library.String  pID,
_.Library.String  pSubmit 
)

This callback is called when this form is submitted.

pID is the ID value associated with the form. The default implementation will perform a Save if the AutoForm is a persistent object.
pSubmit is the name of the submit button (i.e., $AUTOFORM_SAVE).

Reimplemented from AutoForm.

Member Data Documentation

◆ NumberOfColumns

NumberOfColumns

Number of Columns.

 

◆ SchemaName

SchemaName

Schema.

 

◆ TableName

TableName

Table Name.