Skip to main content


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

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

Property Inventory

Method Inventory


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


property coverSpec as %ZEN.Datatype.string (ZENURL = "SPEC");
Cover spec. This is the string that describes the book cover.
Property methods: coverSpecDisplayToLogical(), coverSpecGet(), coverSpecIsValid(), coverSpecLogicalToDisplay(), coverSpecLogicalToOdbc(), coverSpecNormalize(), coverSpecSet()
property selectedElement as %ZEN.Datatype.string;
Which element is selected.
Property methods: selectedElementDisplayToLogical(), selectedElementGet(), selectedElementIsValid(), selectedElementLogicalToDisplay(), selectedElementLogicalToOdbc(), selectedElementNormalize(), selectedElementSet()


classmethod %GetImageDirectory() as %String
Return the physical directory in which cover images files are stored.
method %OnAfterCreatePage() as %Status
Inherited description: 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.
clientmethod addUndo(spec) [ Language = javascript ]
Add cover spec to undo buffer.
clientmethod adjustSize() [ Language = javascript ]
Adjust sizes components on the page.
clientmethod clearCover() [ Language = javascript ]
Clear the cover spec.
clientmethod closeButtonClick(key) [ Language = javascript ]
Button clicked in navigator close button.
clientmethod 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).
clientmethod getContentForLevel(level, key, value) [ Language = javascript ]
Return an object describing what to display for this level.
clientmethod getCoverImages() [ Language = javascript ]
Get list of available images.
clientmethod getDialogValue() [ Language = javascript ]
Get return value for dialog.
clientmethod getToolbarData() [ Language = javascript ]
Get contents of toolbar.
clientmethod headerButtonClick(key) [ Language = javascript ]
Button clicked in navigator header.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod 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.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod selectElement(which, notify) [ Language = javascript ]
User click on element button.
clientmethod selectItem(key, value) [ Language = javascript ]
Item selected in navigator.
clientmethod toolbarChange(key, value) [ Language = javascript ]
Change of toolbar value.
clientmethod toolbarSelect(key) [ Language = javascript ]
Click on toolbar item.
clientmethod undo() [ Language = javascript ]
Undo the last change.
clientmethod uploadImage() [ Language = javascript ]
Show the upload image dialog.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab