Class | SimpleNavigation::ItemContainer |
In: |
lib/simple_navigation/rails_controller_methods.rb
lib/simple_navigation/core/item_container.rb |
Parent: | Object |
Holds the Items for a navigation ‘level’.
auto_highlight | [RW] | |
dom_class | [RW] | |
dom_id | [RW] | |
items | [R] | |
level | [R] | |
renderer | [RW] |
Returns the active item_container for the specified level (recursively looks up items in selected sub_navigation if level is deeper than this container‘s level).
# File lib/simple_navigation/core/item_container.rb, line 101 def active_item_container_for(desired_level) return self if self.level == desired_level return nil unless selected_sub_navigation? return selected_item.sub_navigation.active_item_container_for(desired_level) end
Returns true if there are no items defined for this container.
# File lib/simple_navigation/core/item_container.rb, line 108 def empty? items.empty? end
Creates a new navigation item.
The key is a symbol which uniquely defines your navigation item in the scope of the primary_navigation or the sub_navigation.
The name will be displayed in the rendered navigation. This can also be a call to your I18n-framework.
The url is the address that the generated item points to. You can also use url_helpers (named routes, restful routes helper, url_for etc.)
The options can be used to specify the following things:
The block - if specified - will hold the item‘s sub_navigation.
# File lib/simple_navigation/core/item_container.rb, line 37 def item(key, name, url, options={}, &block) (@items << SimpleNavigation::Item.new(self, key, name, url, options, nil, &block)) if should_add_item?(options) end
# File lib/simple_navigation/core/item_container.rb, line 41 def items=(items) items.each do |item| item = SimpleNavigation::ItemAdapter.new(item) (@items << item.to_simple_navigation_item(self)) if should_add_item?(item.options) end end
Returns the level of the item specified by navi_key. Recursively works its way down the item‘s sub_navigations if the desired item is not found directly in this container‘s items. Returns nil item cannot be found.
# File lib/simple_navigation/core/item_container.rb, line 58 def level_for_item(navi_key) my_item = self[navi_key] return self.level if my_item items.each do |i| if i.sub_navigation level = i.sub_navigation.level_for_item(navi_key) return level unless level.nil? end end return nil end
Renders the items in this ItemContainer using the configured renderer.
The options are the same as in the view‘s render_navigation call (they get passed on)
# File lib/simple_navigation/core/item_container.rb, line 73 def render(options={}) renderer_instance = if options[:renderer] if options[:renderer].instance_of?(Symbol) && SimpleNavigation.registered_renderers.key?(options[:renderer]) SimpleNavigation.registered_renderers[options[:renderer]].new(options) else options[:renderer].new(options) end else self.renderer.new(options) end renderer_instance.render(self) end
Returns true if any of this container‘s items is selected.
# File lib/simple_navigation/core/item_container.rb, line 88 def selected? items.any? {|i| i.selected?} end