Changes between Version 18 and Version 19 of S3/S3Navigation

Timestamp:

03/05/12 13:28:59 (14 years ago)

Author:

Dominic König

Comment:

--

S3/S3Navigation

@@ -94 +94 @@
 === Implementing Layouts ===
 
+Subclasses of S3NavigationItem must implement the layout method:
+
+{{{
+class MyMenuLayout(S3NavigationItem):
+
+    @staticmethod
+    def layout(item):
+        # Layout goes here
+}}}
+
+Usually, this should be a static method. It will be called with an instance of the same class, and is expected to return a web2py HTML helper instance (i.e. a subclass of DIV, which implements the xml method).
+
+S3NavigationItem provides an API for the layout method (=renderer) to introspect the item before rendering.
+
+==== Item Attributes ====
+
+||='''Attribute'''=||='''Type'''=||='''Contents'''=||='''Comments'''=||
+||'''controller'''||string||controller name of the item target URL||don't use directly, use get method instead||
+||'''function'''||string||function name of the item target URL||don't use directly, use get method instead||
+||'''application'''||string||application name of the item target URL||don't use directly, use get method instead||
+||'''r'''||request object||the request this item got matched against||defaults to current.request||
+||'''args'''||list of strings||the args for the item target URL|| ||
+||'''vars'''||dict of strings||the query variables for the item target URL|| ||
+||'''extension'''||string||the format extension for the item target URL|| ||
+||'''tablename'''||string||the name of the target table of the item target URL|| ||
+||'''attr'''||dict||the HTML attributes||as passed during item definition||
+||'''opts'''||dict||the renderer options||as passed during item definition||
+
+==== Introspection Methods ====
+
+==== Rendering Methods ====
 === Invoking the Renderer ===