This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

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

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.

Property Inventory

Method Inventory

Parameters

parameter DEFAULTCONTROLCLASS = comboboxInput;
Inherited description: The default css class used for the main element within this control. This is overridden by subclasses.
parameter USECOMMONDIRECTORY = 1;
Inherited description: 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 methods: invalidDateMessageDisplayToLogical(), invalidDateMessageGet(), invalidDateMessageIsValid(), invalidDateMessageLogicalToDisplay(), invalidDateMessageLogicalToOdbc(), invalidDateMessageNormalize(), invalidDateMessageSet()
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 methods: maxDateDisplayToLogical(), maxDateGet(), maxDateIsValid(), maxDateLogicalToDisplay(), maxDateLogicalToOdbc(), maxDateNormalize(), maxDateSet()
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 methods: minDateDisplayToLogical(), minDateGet(), minDateIsValid(), minDateLogicalToDisplay(), minDateLogicalToOdbc(), minDateNormalize(), minDateSet()
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';
Property methods: onshowPopupDisplayToLogical(), onshowPopupGet(), onshowPopupIsValid(), onshowPopupLogicalToDisplay(), onshowPopupLogicalToOdbc(), onshowPopupNormalize(), onshowPopupSet()

Methods

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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window