Home > Class Reference > %SYS namespace > %ZEN.Component.loginForm

%ZEN.Component.loginForm

class %ZEN.Component.loginForm extends %ZEN.Component.group

Login Form component.
This is a specialized type of form designed to be used in a login page. Unlike the regular form component, this is a very simple object with none of the more advanced form features that are inappropriate for a login page.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DEFAULTGROUPCLASS = form;
Inherited description: Subclasses can set this to change default css class for a group.
parameter DEFAULTGROUPSTYLE = padding: 5px;;
Default style for cells within forms
parameter SYSMODULE = form;
Inherited description: If set, this indicates that this system component should be placed in the given "module". A module is a grouping of components within the same class package that share common include (js or css) files. Note that certain root classes are implicitly placed within the "core" module.
Classes outside of the Zen library should not set this, they should use the MODULE instead.

Properties (Including Private)

property enctype as %ZEN.Datatype.string;
Specifies the enctype for the form. (Refer to the HTML form element for details).
Property methods: enctypeDisplayToLogical(), enctypeGet(), enctypeIsValid(), enctypeLogicalToDisplay(), enctypeLogicalToOdbc(), enctypeNormalize(), enctypeSet()
property ondefault as %ZEN.Datatype.eventHandler);
ondefault event handler: This is a special event that is fired when the user performs an action that triggers the default action for a form. Typically this is when the user presses the Enter key within a control within the form.
Property methods: ondefaultDisplayToLogical(), ondefaultGet(), ondefaultIsValid(), ondefaultLogicalToDisplay(), ondefaultLogicalToOdbc(), ondefaultNormalize(), ondefaultSet()
property onsubmit as %ZEN.Datatype.eventHandler);
onsubmit event handler: This event is fired when this form is about to be submitted. It provides a chance to perform client-side validation of values within the form. If this event handler returns false, then the submit operation will not occur.
Note that unlike the HTML onsubmit event, this callback is always called when the form is submitted.
Property methods: onsubmitDisplayToLogical(), onsubmitGet(), onsubmitIsValid(), onsubmitLogicalToDisplay(), onsubmitLogicalToOdbc(), onsubmitNormalize(), onsubmitSet()

Methods (Including Private)

method %DrawHTML()
Inherited description: Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
method %OnAddToPageAfter() as %Status
This callback ensures that CSRF tokens are set (if desired) in any page employing this widget
method %OnDrawForm() as %Status
This callback gives form subclasses a chance to add additional hidden fields.
clientmethod getController() [ Language = javascript ]
In case a control thinks this is a normal form, indicate that there is no data controller in play.
clientmethod getFormElement() [ Language = javascript ]
Return the HTML form element associated with this component. This is provided in case there are addition HTML form properties or methods that an application needs access to.
clientmethod handleKey(e) [ Language = javascript ]
clientmethod reset() [ Language = javascript ]
Reset the HTML form associated with this component.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod submit(action) [ Language = javascript ]
Submit the HTML form associated with this component. action if defined, is the action value that is passed on to the server %OnSubmit callback method.
clientmethod submitHandler() [ Language = javascript ]
Internal method.
Onsubmit event handler. This is an internal method used to trap the default action of the form.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)