Changes between Version 14 and Version 15 of S3/S3Summary

Timestamp:

08/05/14 12:20:49 (11 years ago)

Author:

Dominic König

Comment:

--

S3/S3Summary

@@ -101 +101 @@
 == Code ==
 
+=== S3Summary ===
+
+The '''S3Summary''' meta-method handler is implemented in modules/s3/s3summary.py. 
+
+By default, S3Summary is assigned to the '''summary''' URL method, for all request methods and formats. 
+
+If called with a URL query variable "w", the request will be forwarded to the widget at this index position (counting from 0):
+
+{{{
+# URL for the method handler of the second widget
+/eden/org/organisation/summary?w=1
+}}}
+
+The index position can be inferred from the widget_id (HTML element ID assigned by S3Summary), e.g. "summary-0" indicates index position 0 - so that widgets can send Ajax-requests to their respective back-end method via the summary URL.
+
+Without the "w" parameter, the request is executed by S3Summary itself, sequentially invoking all configured widget handlers (full page load).
+
+=== Widget Handlers ===
+
+S3Summary does not render the widgets itself, but calls the {{{widget()}}} function of the specified method handler, with the signature:
+
+{{{
+widget(r, method=method, widget_id=widget_id, visible=visible, **attr)
+}}}
+
+The parameters '''r''' (S3Request) and '''attr''' (controller attributes) are the same as for {{{apply_method()}}}.
+
+The '''widget_id''' contains the HTML element ID that shall be assigned to this widget (contains the widget's index position), and '''visible''' is a boolean indicating whether the widget is initially visible or not.
+
+If the specified method does not implement a widget() function, S3Summary will raise an "Unsupported Method" exception (HTTP 405).
 == Future Extensions ==