Class Reference
%DeepSee.UI.Dialog.BookCoverBuilder
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%DeepSee] >  [UI] >  [Dialog] >  [BookCoverBuilder]
Private  Storage

class %DeepSee.UI.Dialog.BookCoverBuilder extends %DeepSee.UI.Dialog.standardDialog

This dialog lets the user create or edit a DeepSee Book Cover filter definition.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 2 25


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
ValidationErrorMsg align aux backgroundTimerInterval
cellAlign cellSize cellStyle cellVAlign
children composite containerStyle coverSpec
cssLevel dialogTitle disabled disabledStyle
dragAndDrop dragEnabled dropEnabled enclosingClass
enclosingStyle error groupClass groupStyle
height hidden hideApplyButton hideCancelButton
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelPosition labelStyle layout name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate parent selectedElement showLabel
slice title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %DrawTitle %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetImageDirectory
%GetLinks %GetPageName %GetParameter %GetValueById
%GetValueByName %GetXMLName %IsA %IsModified
%Link %LinkCSS %LinkScript %MakeId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication
%OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody
%OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask
%OnGetSubtitle %OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren
%OnObjectSynch %OnPreHTTP %OnSubmit %OnUseSoftModals
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %RemoveChild %RemoveChildren %RemoveComponent
%RemoveFromSaveSet %RunBackgroundMethod %Self %SerializeObject
%SetBackgroundMethodStatus %SetErrorById %SetErrorByName %SetModified
%SetValueById %SetValueByName %SetValuesByName %StartScript
%ValidateObject %ZENVersion ConvertParameter Decrypt
Encrypt EscapeHTML EscapeURL EvalResult
GetCoverList GetImageList HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled Link OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore addUndo adjustSize btnApply
btnOK cancelPopup childrenMutated clearCover
closeButtonClick correctIELayering createComponent createComponentNS
ctrlKeyDown dataChange deleteComponent dialogApply
dialogCancel dialogFinish dialogTitleGet disableButtons
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getContentForLevel getCoverImages getDialogValue getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getToolbarData getType
gotoPage headerButtonClick invokeSuper isOfType
launchPopupWindow makeId onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondialogCancel ondialogFinish ondialogStart
ondisabledHandler onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
refreshContents removeChild render renderContents
renderSVG resetMsg selectElement selectItem
setComponentId setHidden setOverlayMode setProperty
setPropertyAll setTraceOption showMsg startModal
startProgressBar stopProgressBar stripWhitespaces toolbarChange
toolbarSelect undo uploadImage validateRequired


Parameters

• parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.

Properties

• property coverSpec as %ZEN.Datatype.string(ZENURL="SPEC");
Cover spec. This is the string that describes the book cover.
• property selectedElement as %ZEN.Datatype.string;
Which element is selected.

Methods

• classmethod %GetImageDirectory() as %String
Return the physical directory in which cover images files are stored.
• method %OnAfterCreatePage() as %Status
Be sure to do ##super() when overriding.
• method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
• method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
• method GetCoverList(ByRef pParameters, Output pMetaData, Output pData) as %Status
Get list of book covers for JSON provider.
• classmethod GetImageList(ByRef pParameters, Output pMetaData, Output pData) as %Status
Get list of images in the covers directory for JSON provider.
• method addUndo(spec) [ Language = javascript ]
Add cover spec to undo buffer.
• method adjustSize() [ Language = javascript ]
Adjust sizes components on the page.
• method clearCover() [ Language = javascript ]
Clear the cover spec.
• method closeButtonClick(key) [ Language = javascript ]
Button clicked in navigator close button.
• method dataChange(key, value, final) [ Language = javascript ]
This is called when a data value within the navigator is changed. key is the key for the item and value is the new value. final is true if this is the final value (controls such as a slider may provide intermediate values as well while the user is actively dragging it).
• method getContentForLevel(level, key, value) [ Language = javascript ]
Return an object describing what to display for this level.
• method getCoverImages() [ Language = javascript ]
Get list of available images.
• method getDialogValue() [ Language = javascript ]
Get return value for dialog.
• method getToolbarData() [ Language = javascript ]
Get contents of toolbar.
• method headerButtonClick(key) [ Language = javascript ]
Button clicked in navigator header.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
• method ondialogFinish(action) [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
• method ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
• method selectElement(which, notify) [ Language = javascript ]
User click on element button.
• method selectItem(key, value) [ Language = javascript ]
Item selected in navigator.
• method toolbarChange(key, value) [ Language = javascript ]
Change of toolbar value.
• method toolbarSelect(key) [ Language = javascript ]
Click on toolbar item.
• method undo() [ Language = javascript ]
Undo the last change.
• method uploadImage() [ Language = javascript ]
Show the upload image dialog.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.