X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-developer.markdown;h=d302027c55d748d328f27b2aabcf861857e0001d;hb=1d330de3056b4799c7cef1495ba98dd4faaa6154;hp=067650956820920edaf5e008edddfa702a980610;hpb=a00953319ac270b69585f035768a47c7c410338b;p=mkws-moved-to-github.git diff --git a/doc/mkws-developer.markdown b/doc/mkws-developer.markdown index 0676509..d302027 100644 --- a/doc/mkws-developer.markdown +++ b/doc/mkws-developer.markdown @@ -3,8 +3,11 @@ % 11 August 2014 -Introduction -============ +Overview +======== + +Core concepts +------------- Development with MKWS consists primarily of defining new types of widgets. These can interact with the core functionality is several @@ -61,7 +64,7 @@ This simple widget illustrates several important points: Widget specialisation (inheritance) -=================================== +----------------------------------- Many widgets are simple specialisations of existing widgets. For example, the `Record` widget is the same as the `Records` widget @@ -75,116 +78,126 @@ follows: 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 +a specialised widget, you 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 simple matter of changing the "maxrecs" +this case, it's a very simple 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
, though it's not obvious why anyone +value. (That would occur if the HTML used an element like `
`, though it's not obvious why anyone would do that.) -Widget Properties and Methods -============================= +Reference Guide +=============== + + +Widget properties and methods +----------------------------- + +The following properties and methods exist in the bare widget object +that is passed into `registerWidgetType`'s callback function, and can +be used by the derived widget. -String this.type +* `String this.type` -- A string containing the type of the widget. -Team this.team +* `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 +* `DOMElement this.node` -- The DOM element of the widget -Hash this.config +* `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 -
. + in HTML can set configuration items as HTML attributes: for + example, the HTML element + `
`. + creates a widget for which `this.config.maxrecs` is set to 10. -String this.toString() +* `String this.toString()` -- A function returning a string that briefly names this widget. Can be useful in logging. -Void this.log(string) +* `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. + subcribers to the `log` event. -String this.value() +* `String this.value()` -- A function returning the value of the widget's HTML element. 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() -String team.currentRecordData() +* `String team.name()` +* `Bool team.submitted()` +* `Num team.perpage()` +* `Num team.totalRecordCount()` +* `Num team.currentPage();` +* `String team.currentRecordId()` +* `String team.currentRecordData()` -- Simple accessor functions that provide the ability to read properties of the team. -Array team.filters() +* `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. + convenient to do it this way. If you must insist on using + this, see the `Navi` widget, which is the only place it's used. -Hash team.config() +* `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. + been overridden are accessible via `this.config`. -Void team.set_sortOrder(string) -Void team.set_perpage(number) +* `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. + functions. Unlikely to be needed outside of the `Sort` and + `Perpage` widgets. -Queue team.queue(eventName) +* `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) +* `Bool team.targetFiltered(targetId)` -- Indicates whether the specified target has been filtered by selection as a facet. -Void team.newSearch(query, sortOrder, maxrecs, perpage, limit, targets, targetfilter) +* `Void team.newSearch(query, sortOrder, maxrecs, perpage, limit, targets, targetfilter)` -- Starts a new search with the specified parameters. All but the query may be omitted, in which case the prevailing defaults are used. -Void team.reShow() +* `Void team.reShow()` -- Using the existing search, re-shows the result records after a change in sort-order, per-page count, etc. -String team.recordElementId(recordId) +* `String team.recordElementId(recordId)` -- Utility function for converting a record identifer (returned from Pazpar2) into a version suitable for use as an HTML element ID. -String team.renderDetails(recordData) +* `String team.renderDetails(recordData)` -- Utility function returns an HTML rendering of the record represented by the specified data. -Template team.loadTemplate(templateName) +* `Template team.loadTemplate(templateName)` -- Loads (or retrieves from cache) the named Handlebars template, and returns it in a form that can be invoked as a function, passed a data-set.