Changes between Version 24 and Version 25 of S3/S3Navigation

Timestamp:

03/05/12 14:01:11 (14 years ago)

Author:

Dominic König

Comment:

--

S3/S3Navigation

@@ -131 +131 @@
 
 S3NavigationItem provides a number of helper methods for item introspection:
+
+Get a sub-item of this item:
+{{{
+    sub_item = item[i]
+}}}
+
+Loop over sub-items:
+{{{
+    for sub_item in item:
+        ...
+}}}
+
+Get the root item of the tree:
+{{{
+    root_item = item.get_root()
+}}}
+
+Get the path (list of items) from the root item down to this item:
+{{{
+    path = item.path()
+}}}
+
+Get all sub-items with certain flags (can also take multiple flags):
+{{{
+    enabled_sub_items = item.get_all(enabled=True)
+}}}
+
+Get the first sub-item with certain flags (can also take multiple flags):
+{{{
+    first_authorized_and_enabled_sub_item = item.get_first(enabled=True, authorized=True)
+}}}
+
+Get the last sub-item with certain flags (analogous to above):
+{{{
+    last_authorized_and_enabled_sub_item = item.get_last(enabled=True, authorized=True)
+}}}
+
+Number of sub-items:
+{{{
+    number_of_subitems = len(item)
+}}}
+
+Position of a sub-item within the sub-items list:
+{{{
+    sub_item_position = item.index(sub_item)
+}}}
+
+Check whether this is the first sub-item with certain flags:
+{{{
+    is_first_enabled = item.is_first(enabled=True)
+}}}
+
+Check whether this is the last sub-item with certain flags:
+{{{
+    is_last_authorized_and_visible = item.is_last(authorized=True, visible=True)
+}}}
+
+Get all preceding siblings of this item within the parent (as list):
+{{{
+    preceding_siblings = item.preceding()
+}}}
+
+Get all following siblings of this item within the parent (as list):
+{{{
+    following_siblings = item.following()
+}}}
+
+Get the last preceding item with certain flags:
+{{{
+    preceding_enabled = item.get_prev(enabled=True)
+}}}
+
+Get the first following item with certain flags:
+{{{
+    following_visible_and_enabled = item.get_next(visible=True, enabled=True)
+}}}
+
+Get the item URL:
+{{{
+    url = item.url()
+}}}
+
+Get an inherited attribute (i.e. controller, function or application; these attributes should never be accessed directly):
+{{{
+    controller = item.get("controller")
+}}}
+
+Check whether this item or any item underneath it contains a certain tag:
+{{{
+    tag = "special"
+    if tag in item:
+        # This item or at least one underneath it contains this tag
+}}}
+
+==== Manipulation methods ====
+
+These methods can be used by controllers to influence the rendering of items:
+
+Get all items underneath this item with a certain tag (as list):
+{{{
+    tag = "special"
+    special_items = item.findall(tag)
+}}}
+
+Enable/disable items by tag:
+{{{
+    tag = "special"
+    item.enable(tag) # enables all descendand items with the tag "special"
+
+    tag = "nonspecial"
+    item.disable(tag) # disables all descendand items with the tag "nonspecial"
+}}}
+
+If enable or disable are used without tag, then only the current item gets enabled/disabled
+
+Set layout:
+{{{
+    tag = "special"
+    def f(item):
+        # Layout goes here
+
+    # Set this layout to all descendand items with the tag "special"
+    item.set_layout(f, tag=tag, recursive=True)
+}}}
 ==== Rendering Methods ====
 === Invoking the Renderer ===