Home > Class Reference > ENSLIB namespace > %ZEN.Component.loginForm
Private  Storage   

%ZEN.Component.loginForm


class %ZEN.Component.loginForm extends 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.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 3 11


Summary


Properties
%condition %import %includeFiles %page
%resource align aux cellAlign
cellSize cellStyle cellVAlign children
composite containerStyle disabled dragEnabled
dropEnabled enclosingClass enclosingStyle enctype
error groupClass groupStyle height
hidden hint hintClass hintStyle
id index label labelClass
labelDisabledClass labelPosition labelStyle layout
name onafterdrag onbeforedrag onclick
ondefault ondrag ondrop onhide
onrefresh onshow onsubmit onupdate
parent showLabel slice title
tuple valign visible width
window

Methods
%AddChild %AddChildAfter %AddChildBefore %AddToSaveSet
%Attr %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawComponentHTML %DrawHTML %DrawJSStrings %EnclosingDivId
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetEventHandlers %GetParameter %GetXMLName
%IsA %IsModified %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnDrawEnclosingDiv %OnDrawForm %OnDrawObjectProperties %OnMutateChildren
%OnObjectSynch %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %RemoveChild %RemoveChildren
%RemoveFromSaveSet %Self %SerializeObject %SetModified
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
childrenMutated dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler exposeComponent
findElement fireOnUpdateEvent getChildIndex getController
getEnclosingDiv getFormElement getHidden getHintElement
getLabelElement getProperty getSettings getType
handleKey invokeSuper isOfType makeId
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onStartModalHandler
ondisabledHandler onloadHandler onunloadHandler onupdateHandler
refreshContents removeChild render renderContents
renderSVG reset setHidden setOverlayMode
setProperty setPropertyAll startProgressBar stopProgressBar
submit submitHandler


Parameters


• parameter DEFAULTGROUPCLASS = "form";
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";
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


• property enctype as %ZEN.Datatype.string;
Specifies the enctype for the form. (Refer to the HTML form element for details).
• property ondefault as %ZEN.Datatype.eventHandler(HANDLER="");
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 onsubmit as %ZEN.Datatype.eventHandler(HANDLER="");
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.

Methods


• method %DrawHTML()
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.
• method getController() [ Language = javascript ]
In case a control thinks this is a normal form, indicate that there is no data controller in play.
• method 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.
• method handleKey(e) [ Language = javascript ]
• method reset() [ Language = javascript ]
Reset the HTML form associated with this component.
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
• method 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.
• method submitHandler() [ Language = javascript ]
Internal method.
Onsubmit event handler. This is an internal method used to trap the default action of the form.