%DeepSee.Component.coverView
class %DeepSee.Component.coverView
extends
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.
Inventory
Summary
Parameters
Subclasses can set this to change default enclosingClass used for this component.
This is the XML namespace used for library components.
Properties
Style applied to coverView background and category labels.
Category to use for items with no category.
True for cover editor page.
onactivate event handler: If defined, this event is fired when the user invokes an action on a cover.
ongetdata event handler: If defined, this event is returns an array of items to be displayed within this component.
ongetdetails event handler: If defined, this event is fired in order to get a list of popup details for a cover.
ongetitemcontext event handler: If defined, this returns a context object for the given cover. This is used to resolve $var references within covers.
onselect event handler: If defined, this event is fired when the user clicks on a cover.
onselectelement event handler: Design mode only. If defined, this event is fired when the user clicks on a cover element.
Used by cover editor.
Index (0-based) of selected cover.
Zoom level (1,2 or 3).
Methods
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.
Invoke the given action for the given cover.
Utility method. Escape a javascript string.
Convert a spec string into a spec object.
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.
Given its index (0-based), return the book object for a cover.
Get the model used to drive the view.
Notification that the dataController associated with this dataView has raised an event.
Utility method. Split a css value into individual style values. Return an object containing these values.
Client-side method to render this control.
Select a cover given its index (0-based).
Select an element within the cover.
User has clicked on the element selector.
Given its index (0-based), set the book object for a cover.
Set the value of a named property.
Convert a display spec back into a json string.