Home > Class Reference > ENSLIB namespace > %ZEN.Portal.assistedText
Private  Storage   

%ZEN.Portal.assistedText


class %ZEN.Portal.assistedText extends %ZEN.Component.control

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 10 22


Summary


Properties
%condition %import %includeFiles %page
%resource OnUpdateDataServer align aux
clientType composite containerStyle controlClass
controlStyle controlType controlWidth dataBinding
disabled dragEnabled dropEnabled enclosingClass
enclosingStyle error height hidden
hideGhost hint hintClass hintStyle
id index invalid invalidMessage
isSuggestedDataComplete label labelClass labelDisabledClass
labelStyle listSize name onUpdateDataClient
onafterdrag onbeforedrag onblur onchange
onclick ondblclick ondrag ondrop
onfocus onhide onkeydown onkeypress
onkeyup onmousedown onmouseout onmouseover
onmouseup onrefresh onshow onsubmit
ontouchend ontouchmove ontouchstart onupdate
onvalidate originalValue parent placeholder
readOnly required requiredMessage showLabel
slice tabIndex title triggerChars
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
ServerGetClassPackageList ServerGetPropertyList XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType controlClicked controlGotFocus
controlKeyPressed controlOnBlur deferredComboUpdate deferredEscapeAction
deferredLostFocus deferredSaveCurrentTextValue doAction dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler exposeComponent findElement fireOnUpdateEvent
focus formatValue getDisabled getDragData
getEnclosingDiv getForm getHidden getHintElement
getInvalidReason getLabelElement getProperty getReadOnly
getSelection getSettings getType getValue
invokeSuper isModified isOfType isValid
makeId normalizeValue onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onStartModalHandler onchangeHandler onloadHandler
onunloadHandler onupdateHandler refreshContents render
renderContents renderSVG select selectorChanged
selectorDblClicked selectorGotFocus setComboOptions setDisabled
setHidden setOverlayMode setProperty setReadOnly
setSelection setSelectorStyle setValue startProgressBar
stopProgressBar sysName unformatValue updateData
validationHandler


Parameters


• parameter DEFAULTCONTROLCLASS = "assistedText";
The default css class used for the main element within this control. This is overridden by subclasses.
• parameter INCLUDEFILES = "zenCSLM.js";
Comma-separated list of additional JS include files for the page.

Properties


• property OnUpdateDataServer as %ZEN.Datatype.delegator(FORMALSPEC="pBase:%String",RETURNTYPE="%String");
This property has been deprecated. Please use onUpdateDataClient instead.
• property controlType as %ZEN.Datatype.string [ InitialExpression = "custom" ];
Specify the type of the control, it accepts 3 formats: classname - use build in assist for classname property: - use build in assist for property names with the top level context class being custom - this is default, the control calls onUpdateDataClient to populate the selector control
• property controlWidth as %ZEN.Datatype.string;
This property is obsolete. Please use controlStyle to set width The width of the control, must end in a unit, i.e. 100px or 30%
• property hideGhost as %ZEN.Datatype.boolean;
This property is obsolete. We do not display ghost text anymore.
• property isSuggestedDataComplete as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
When isSuggestedDataComplete is false, it indicates the string list returned by update data callbacks are partial strings and they are to be appended to the original base string to be used as suggested text. When isSuggestedDataComplete is true, it indicates the string list returned by update data callbacks are complete strings and they do not need to be appended to the original base string. When controlType is either classname or property, isSuggestedDataComplete is ignored. It is assumed to be false.
• property listSize as %ZEN.Datatype.integer(MINVAL=0) [ InitialExpression = 5 ];
The size (number of lines) of the drop-down area for this assistedText control.
• property onUpdateDataClient as %ZEN.Datatype.eventHandler;
When controlType is custom, this is the client method to call to get data to populate the selector control The format of this attribute is "zenPage.(base);" The client method takes one argument that is the base text. The base text is either empty string or it ends with the trigger character. The return value is a single-character delimited list with the delimiter character as the first character.
• property placeholder as %ZEN.Datatype.string;
The placeholder attribute specifies a short hint that describes the expected value of an input field (e.g. a sample value or a short description of the expected format). The hint is displayed in the input field when it is empty.
• property triggerChars as %ZEN.Datatype.string [ InitialExpression = "." ];
list of characters that triggers the calls to update data. When controlType is either classname or property, triggerChars is ignored. It is assumed to be the dot character.

Methods


• method %DrawHTML()
Draw content of control.
• classmethod ServerGetClassPackageList(pBase As %String) as %String [ ZenMethod ]
• classmethod ServerGetPropertyList(pBase As %String, pClassname As %String) as %String [ ZenMethod ]
• method controlClicked() [ Language = javascript ]
• method controlGotFocus() [ Language = javascript ]
• method controlKeyPressed(event) [ Language = javascript ]
• method controlOnBlur(event) [ Language = javascript ]
• method deferredComboUpdate() [ Language = javascript ]
• method deferredEscapeAction() [ Language = javascript ]
• method deferredLostFocus() [ Language = javascript ]
• method deferredSaveCurrentTextValue(keyCode) [ Language = javascript ]
• method doAction(skipModifiedCheck) [ Language = javascript ]
• method getSelection(ctrl) [ Language = javascript ]
• method onCreate() [ Language = javascript ]
client-side initialization for this object.
• method selectorChanged() [ Language = javascript ]
• method selectorDblClicked() [ Language = javascript ]
• method selectorGotFocus() [ Language = javascript ]
• method setComboOptions(combo, options, insertBlank) [ Language = javascript ]
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
• method setSelection(ctrl, pos1, pos2) [ Language = javascript ]
• method setSelectorStyle() [ Language = javascript ]
• method updateData(base) [ Language = javascript ]