Source code for superdjango.ui.runtime.menus

# Classes


class Location(object):
    """A location of menus and their items for use in templates."""

    def __init__(self, name, sort_order=1):
        """Initialize a menu location.

        :param name: The location name.
        :type name: str

        :param sort_order: The order in which the location appears next to other locations.
        :type sort_order: str

        """
        self.items = list()
        self.name = name
        self.sort_order = sort_order

    def __iter__(self):
        return iter(self.items)

    def __repr__(self):
        return "<%s:Runtime %s. %s (%s)>" % (self.__class__.__name__, self.sort_order, self.name, len(self.items))

    def append(self, item):
        """Add a menu or item to the location.

        :param item: The item to be added.
        :type item: Item | Menu

        """
        self.items.append(item)


class Menu(object):
    """A collection of menu items for use in templates."""

    def __init__(self, label, name, flat=False, icon=None, sort_order=1, url=None, **kwargs):
        """Initialize a menu.

        :param label: The label of the menu shown to users.
        :type label: str

        :param name: The programmatic name of the menu.
        :type name: str

        :param flat: Indicates the menu should be flattened, e.g. all items are display horizontally or at least using
                     no sub-menu structure.
        :type flat: bool

        :param icon: The icon to use for the menu.
        :type icon: str

        :param sort_order: The order of the menu in a list of menus.
        :type sort_order: int

        :param url: The URL of the menu.
        :type url: str

        Additional kwargs are available as properties of the menu instance.

        """
        self.flat = flat
        self.icon = icon
        self.items = list()
        self.label = label
        self.name = name
        self.sort_order = sort_order
        self.url = url
        self._kwargs = kwargs

    def __getattr__(self, item):
        return self._kwargs.get(item)

    def __iter__(self):
        return iter(self.items)

    def __repr__(self):
        return "<%s:Runtime %s. %s (%s)>" % (self.__class__.__name__, self.sort_order, self.name, len(self.items))

    @property
    def is_separator(self):
        """Runtime menu instances are never used as separators.

        :rtype: bool

        """
        return False


class Item(object):
    """An individual menu item.

    .. note::
        This class is typically used in situations where a registered menu item contains only one model.

    """

    def __init__(self, label, name, icon=None, sort_order=1, url=None, **kwargs):
        """Initialize an item.

        :param label: The label of the menu item as shown to users.
        :type label: str

        :param name: The programmatic name of the item.
        :type name: str

        :param icon: The icon to display as part of the item label.
        :type icon: str

        :param sort_order: The sort order of the item within a menu.
        :type sort_order: int

        :param url: The URL of the item.
        :type url: str

        Additional kwargs are available as properties of the item instance.

        """
        self.icon = icon
        self.items = None
        self.label = label
        self.name = name
        self.sort_order = sort_order
        self.url = url
        self._kwargs = kwargs

    def __getattr__(self, item):
        return self._kwargs.get(item)

    def __repr__(self):
        return "<%s:Runtime %s. %s (%s)>" % (self.__class__.__name__, self.sort_order, self.name, self.label)

    @property
    def is_separator(self):
        """Runtime item instances are never used as separators.

        :rtype: bool

        """
        return False