Home > Class Reference > ENSLIB namespace > EnsPortal.Component.packageText
Private  

EnsPortal.Component.packageText

class EnsPortal.Component.packageText extends %ZEN.Component.control

Input control specialized for handling date values.
This displays a text box as well as a button that displays a popup calendar.
When the user enters a value into this control, it will be converted into the closest matching date value or and invalid date message.
Setting the value property of this control, will bypass date matching.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 4 6

Summary

Properties
%condition %import %includeFiles %page
%resource align aux clientType
composite containerStyle controlClass controlStyle
dataBinding disabled dragEnabled dropEnabled
enclosingClass enclosingStyle error height
hidden hint hintClass hintStyle
id index invalid invalidDateMessage
invalidMessage label labelClass labelDisabledClass
labelStyle maxDate minDate name
onafterdrag onbeforedrag onblur onchange
onclick ondblclick ondrag ondrop
onfocus onhide onkeydown onkeypress
onkeyup onmousedown onmouseout onmouseover
onmouseup onrefresh onshow onshowPopup
onsubmit ontouchend ontouchmove ontouchstart
onupdate onvalidate originalValue parent
readOnly required requiredMessage showLabel
slice tabIndex title tuple
valign value visible width
window
Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetEventHandlers %GetForm %GetParameter
%GetXMLName %IsA %IsModified %MakeId
%Name %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnDrawEnclosingDiv %OnDrawObjectProperties
%OnObjectSynch %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %RemoveFromSaveSet %Self
%SerializeObject %SetDefaultValues %SetModified %ValidateObject
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
applyDate dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler exposeComponent
findElement fireOnUpdateEvent focus formatValue
getDisabled getDragData getEnclosingDiv getForm
getHidden getHintElement getInvalidReason getLabelElement
getProperty getReadOnly getSettings getType
getValue invokeSuper isModified isOfType
isValid makeId normalizeValue onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onStartModalHandler onchangeHandler
ondatechangeHandler onloadHandler onunloadHandler onupdateHandler
refreshContents render renderContents renderSVG
select setDisabled setHidden setOverlayMode
setProperty setReadOnly setValue showDateSelector
startProgressBar stopProgressBar sysName unformatValue
validationHandler

Parameters

parameter DEFAULTCONTROLCLASS = "comboboxInput";
The default css class used for the main element within this control. This is overridden by subclasses.
parameter USECOMMONDIRECTORY = 1;
If true, then the include files generated for this component, are placed in the common /csp/broker directory and not the local /csp/*namespace* directory.
This is intended for use with packages that are mapped so as to be visible to every namespace.
All Zen classes within the same package must have the same value for this parameter. It is the developer's responsibility to ensure this.

Properties

property invalidDateMessage as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Invalid Date","%ZEN") ];
Localized "invalid date" message displayed by control.
property maxDate as %ZEN.Datatype.string;
Optional. If specified, this is the latest date allowed by the calendar. This is a date in the form "YYYY-MM-DD".
property minDate as %ZEN.Datatype.string;
Optional. If specified, this is the earliest date allowed by the calendar. This is a date in the form "YYYY-MM-DD".
property onshowPopup as %ZEN.Datatype.eventHandler;
onshowPopup event handler: This event is fired just before the popup calendar is displayed. It provides an opportunity to pass additional settings to the popup calendar.
The argument, settings, passed to this callback, is an object (associative array). Property values within this object are passed on as setting to the calendar control.
For example:
settings['gapWidth'] = '100px';

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 applyDate(group) [ Language = javascript ]
Apply the value from the popup to the input control.
method isValid() [ Language = javascript ]
This method is called by the form validation mechanism to test if the current contents of this control are valid.
method ondatechangeHandler() [ Language = javascript ]
onchange handler for this component.
method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
method showDateSelector() [ Language = javascript ]
Display date selector for this control.