UE3:WebAdminMenu (UT3)

Object >> WebAdminMenu

Package: 

WebAdmin

Menu manager for the webadmin

Copyright 2008 Epic Games, Inc. All Rights Reserved

Author: Michiel 'elmuerte' Hendriks

Properties

menu

Type: array<MenuItem>

tree

Type: array<TreeItem>

webadmin

Type: WebAdmin

Structs

MenuItem

string path 

The absolute path (from the webapp path). Examples:

foo foo/bar/quux bar bar/quux bar/quux2

string title 

Title of the menu item

string description 

A short description

int weight 

The weight of this item. A low number means it will be higher in the list.

IQueryHandler handler 

The handler responsible for handling this menu item.

TreeItem

int cur 

Index to the item in the menu list;

string elm 

Path element

array<int> children 

Instance functions

addMenu

function addMenu (string path, string title, IQueryHandler handler, optional string description, optional int weight)

Add a new menu item (or overwrite the previous for the given path).

addMenuItem

function addMenuItem (MenuItem item)

Add an item to the menu, or if the path already exist, update an existing item. To create a hidden item simply leave out the title.

addSortedItem

protected function addSortedItem (MenuItem item)

Add a menu item to the list sorting on the full path.

createTree

protected function createTree ()

Parses the sorted list of menu items and creates the tree.

getHandlerFor

function IQueryHandler getHandlerFor (string path, out string title, out string desc)

Get the menu handler for a given path

getUserMenu

function WebAdminMenu getUserMenu (IWebAdminUser forUser)

return the menu instance of the given user. All paths to which the user has no access will be filtered from the list.

Returns:

none when the user has absolutely no access, otherwise an instance is returned that only contains the paths the user has access to.

render

function string render ()

Render the current menu tree to a navigation menu

renderChilds

protected function string renderChilds (array<int> childs, WebResponse wr)