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 > %SYS namespace > %DeepSee.Component.coverView


class %DeepSee.Component.coverView extends %ZEN.Component.component, %ZEN.Component.dataView

Cover view component.
This provides an way to display a set of options as "book covers". Each cover is defined by a javaScript object or its string equivalent in JSON format.

Property Inventory (Including Private)

Method Inventory (Including Private)


Inherited description: Subclasses can set this to change default enclosingClass used for this component.
parameter NAMESPACE =;
Inherited description: This is the XML namespace used for library components.

Properties (Including Private)

property backgroundStyle as;
Style applied to coverView background and category labels.
Property methods: backgroundStyleDisplayToLogical(), backgroundStyleGet(), backgroundStyleIsValid(), backgroundStyleLogicalToDisplay(), backgroundStyleLogicalToOdbc(), backgroundStyleNormalize(), backgroundStyleSet()
property defaultCategory as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Others","%DeepSee") ];
Category to use for items with no category.
Property methods: defaultCategoryDisplayToLogical(), defaultCategoryGet(), defaultCategoryIsValid(), defaultCategoryLogicalToDisplay(), defaultCategoryLogicalToOdbc(), defaultCategoryNormalize(), defaultCategorySet()
property designMode as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
True for cover editor page.
Property methods: designModeDisplayToLogical(), designModeGet(), designModeIsValid(), designModeLogicalToDisplay(), designModeLogicalToOdbc(), designModeLogicalToXSD(), designModeNormalize(), designModeSet(), designModeXSDToLogical()
property onactivate as %ZEN.Datatype.eventHandler;
onactivate event handler: If defined, this event is fired when the user invokes an action on a cover.
Property methods: onactivateDisplayToLogical(), onactivateGet(), onactivateIsValid(), onactivateLogicalToDisplay(), onactivateLogicalToOdbc(), onactivateNormalize(), onactivateSet()
property ongetdata as %ZEN.Datatype.eventHandler;
ongetdata event handler: If defined, this event is returns an array of items to be displayed within this component.
Property methods: ongetdataDisplayToLogical(), ongetdataGet(), ongetdataIsValid(), ongetdataLogicalToDisplay(), ongetdataLogicalToOdbc(), ongetdataNormalize(), ongetdataSet()
property ongetdetails as %ZEN.Datatype.eventHandler;
ongetdetails event handler: If defined, this event is fired in order to get a list of popup details for a cover.
Property methods: ongetdetailsDisplayToLogical(), ongetdetailsGet(), ongetdetailsIsValid(), ongetdetailsLogicalToDisplay(), ongetdetailsLogicalToOdbc(), ongetdetailsNormalize(), ongetdetailsSet()
property ongetitemcontext as %ZEN.Datatype.eventHandler;
ongetitemcontext event handler: If defined, this returns a context object for the given cover. This is used to resolve $var references within covers.
Property methods: ongetitemcontextDisplayToLogical(), ongetitemcontextGet(), ongetitemcontextIsValid(), ongetitemcontextLogicalToDisplay(), ongetitemcontextLogicalToOdbc(), ongetitemcontextNormalize(), ongetitemcontextSet()
property onselect as %ZEN.Datatype.eventHandler;
onselect event handler: If defined, this event is fired when the user clicks on a cover.
Property methods: onselectDisplayToLogical(), onselectGet(), onselectIsValid(), onselectLogicalToDisplay(), onselectLogicalToOdbc(), onselectNormalize(), onselectSet(), onselectelementDisplayToLogical(), onselectelementGet(), onselectelementIsValid(), onselectelementLogicalToDisplay(), onselectelementLogicalToOdbc(), onselectelementNormalize(), onselectelementSet()
property onselectelement as %ZEN.Datatype.eventHandler;
onselectelement event handler: Design mode only. If defined, this event is fired when the user clicks on a cover element.
Property methods: onselectelementDisplayToLogical(), onselectelementGet(), onselectelementIsValid(), onselectelementLogicalToDisplay(), onselectelementLogicalToOdbc(), onselectelementNormalize(), onselectelementSet()
property selectedElement as %ZEN.Datatype.string (ZENSETTING = 0);
Used by cover editor.
Property methods: selectedElementDisplayToLogical(), selectedElementGet(), selectedElementIsValid(), selectedElementLogicalToDisplay(), selectedElementLogicalToOdbc(), selectedElementNormalize(), selectedElementSet()
property selectedIndex as %ZEN.Datatype.integer [ InitialExpression = -1 ];
Index (0-based) of selected cover.
Property methods: selectedIndexDisplayToLogical(), selectedIndexGet(), selectedIndexIsValid(), selectedIndexLogicalToDisplay(), selectedIndexLogicalToOdbc(), selectedIndexNormalize(), selectedIndexSet()
property zoomLevel as %ZEN.Datatype.integer (XMLPROJECTION = "none", ZENSETTING = 0) [ InitialExpression = 1 ];
Zoom level (1,2 or 3).
Property methods: zoomLevelDisplayToLogical(), zoomLevelGet(), zoomLevelIsValid(), zoomLevelLogicalToDisplay(), zoomLevelLogicalToOdbc(), zoomLevelNormalize(), zoomLevelSet()

Methods (Including Private)

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 activateCover(evt, index, action) [ Language = javascript ]
Invoke the given action for the given cover.
clientmethod escapeJS(str) [ Language = javascript ]
Utility method. Escape a javascript string.
clientmethod evalSpec(spec) [ Language = javascript ]
Convert a spec string into a spec object.
clientmethod getCoverArt(index, book, popupMode) [ Language = javascript ]
Get HTML for one book cover. A spec is a ^-delimited string of rendering instructions. Each piece takes the form: "type:header;text:ABC;style:prop:val;" style is always at the end.
clientmethod getCoverObject(index) [ Language = javascript ]
Given its index (0-based), return the book object for a cover.
clientmethod getModel() [ Language = javascript ]
Get the model used to drive the view.
clientmethod notifyViewHandler(reason, data1, data2, data3) [ Language = javascript ]
Notification that the dataController associated with this dataView has raised an event.
clientmethod parseStyle(style) [ Language = javascript ]
Utility method. Split a css value into individual style values. Return an object containing these values.
clientmethod renderContents() [ Language = javascript ]
Client-side method to render this control.
clientmethod selectCover(index, force) [ Language = javascript ]
Select a cover given its index (0-based).
clientmethod selectElement(which, notify) [ Language = javascript ]
Select an element within the cover.
clientmethod selectorMouseDown(evt) [ Language = javascript ]
User has clicked on the element selector.
clientmethod setCoverObject(index, book) [ Language = javascript ]
Given its index (0-based), set the book object for a cover.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod specToString(specObj) [ Language = javascript ]
Convert a display spec back into a json string.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)