+INTRODUCTION
+============
+
Development with MKWS consists primarily of defining new types of
widgets. These can interact with the core functionality is several
defined ways.
-You cleare a new widget ttpe this by calling the
-mkws.registerWidgetType function, passing in the widget name and a
-function. The name is used to recognise HTML elements as being widgets
-of this type -- for example, if you register a "Foo" widget, elements
-like <div class="mkwsFoo"> will be widgets of this type.
+You create a new widget type by calling the mkws.registerWidgetType
+function, passing in the widget name and a function. The name is used
+to recognise HTML elements as being widgets of this type -- for
+example, if you register a "Foo" widget, elements like <div
+class="mkwsFoo"> will be widgets of this type.
The function promotes a bare widget object (passed as `this') into a
widget of the appropriate type. MKWS doesn't use classes or explicit
which is called whenever the event is published. The arguments to
the function are different for different events.
+* The value of `this' is lost inside the subscribe callback, so it
+ must be saved if it's to be used inside that callback (typically as
+ a local variable named `that').
+
+
+SPECIALISATION (INHERITANCE)
+============================
+
+Many widgets are simple specialisations of existing widgets. For
+example, the "Record" widget is the same as the "Records" widget
+except that it defaults to displaying a single record. It's defined as
+follows:
+
+ mkws.registerWidgetType('Record', function() {
+ mkws.promotionFunction('Records').call(this);
+ if (!this.config.maxrecs) this.config.maxrecs = 1;
+ });
+
+Remember that when a promotion function is called, it's passed a base
+widget object that's not specialised for any particular task. To make
+a specialised widget, first promote that base widget into the type
+that you want to specialise from -- in this case, "Records" -- using
+the promotion function that's been registered for that type.
+
+Once this has been done, the specialisations can be introduced. In
+this case, it's a very matter of changing the "maxrecs" configuration
+setting to 1 unless it's already been given an explicit value. (That
+would occur if the HTML used an element like <div class="mkwsRecord"
+maxrecs="2">, though it's not obvious why anyone would do that.)
+
+
+WIDGET PROPERTIES AND METHODS
+=============================
+
+String this.type -- a string containing the type of the widget.
+
+Team this.team -- the team object to which this widget belongs. The
+ team has several additional important properties and methods,
+ described below.
+
+DOMElement this.node -- the DOM element of the widget
+
+Hash this.config -- a table of configuration values for the
+ widget. This table inherits missing values from the team's
+ configuration, which in turn inherits from the top-level MKWS
+ configuration, which inherits from the default
+ configuration. Instances of widgets in HTML can set
+ configuration items as HTML attributes, as in <div
+ class="mkwsRecords" maxrecs="2">.
+
+String this.toString() -- a function returning a string that briefly
+ names this widget. Can be useful in logging.
+
+Void this.log(string) -- a function to log a string for debugging
+ purposes. The string is written on the browser console, and
+ also published to any "log" subcribers.
+
+
+TEAM METHODS
+============
+
+Since the team object is supposed to be opaque to widgets, all access
+is via the following API methods rather than direct access to
+properties.
+
+String team.name()
+Bool team.submitted()
+Num team.perpage()
+Num team.totalRecordCount()
+Num team.currentPage();
+String team.currentRecordId() -- simple accessor functions that
+ provide the ability to read properties of the team.
+
+Array team.filters() -- another accessor function, providing access to
+ the array of prevailing filters (which narrow the search
+ results by means of Pazpar2 filters and limits). This is
+ really too complicated an object for the widgets to be given
+ access to, but it's convenient to do it this way. See the
+ "Navi" widget, which is the only place it's used.
+
+Hash team.config() -- access to the team's configuration
+ settings. There is almost certainly no reason to use this: the
+ settings that haven't been overridden are accessible via
+ this.config.
+
+Void team.set_sortOrder(string)
+Void team.set_perpage(number) -- "setter" functions for the team's
+ sortOrder and perpage functions. Unlikely to be needed outside
+ of the "Sort" and "Perpage" widgets.
+
+Queue team.queue(eventName)
+ Returns the queue associated with the named event: this can be
+ used to subscribe to the event (or more rarely to publish it).
+
+Bool team.targetFiltered(targetId)
+
+
+team.log(string)
+team.newSearch(query, sortOrder, maxrecs, perpage, limit, targets, targetfilter)
+team.recordElementId(recordId)
+team.currentRecordData()
+team.renderDetails(recordData)
+team.loadTemplate(templateName)
+team.resetPage()
+team.reShow()
projects / mkws-moved-to-github.git / blobdiff