Docs For Class atkModernMenu

Home

Documentation home

Atk index

Docs For Class atkModernMenu [ package: atk ]

Class: atkModernMenu

Source Location: /menu/class.atkmodernmenu.inc

Class atkModernMenu

Class Overview

Modern menu implementation

Located in /menu/class.atkmodernmenu.inc [line 30]

Wiki documentation

atkmenuinterface
   |
   --atkPlainMenu
      |
      --atkModernMenu

Author(s):

Ber Dohmen <ber@ibuildings.nl>
Sandy Pleyte <sandy@ibuildings.nl>

Information Tags:

Methods

[ Top ]

Descendants

Child Class	Description
atkcookmenu	The atkBoolAttribute class represents an attribute of a node that can either be true or false.

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkPlainMenu atkPlainMenu::$m_height	Inherited From atkPlainMenu atkPlainMenu::atkPlainMenu() Constructor atkPlainMenu::getHeight() Get the height for this menu atkPlainMenu::getMenu() Get the menu atkPlainMenu::getMultilevel() Is this menu multilevel? atkPlainMenu::getPosition() Get the menu position atkPlainMenu::getScrollable() Is this menu scrollable? atkPlainMenu::menu_cmp() Compare two menuitems atkPlainMenu::render() Render the menu Inherited From atkmenuinterface atkmenuinterface::getFooter() Return the menu footer atkmenuinterface::getHeader() Return the menu header atkmenuinterface::getHeight() If the menu is displayed in the top frame of the application, this method should return the height of the frame that the menu requires. atkmenuinterface::getMenuTranslation() Translates a menuitem with the menu_ prefix, or if not found without atkmenuinterface::getMultilevel() Determine if the menu can handle multiple levels of submenu. atkmenuinterface::getPosition() Retrieve the position in which the menu is displayed. atkmenuinterface::getScrollable() Retrieve the scrolling possibilities of the menu. atkmenuinterface::isEnabled() Recursively checks if a menuitem should be enabled or not. atkmenuinterface::render() Render the menu

Inherited Properties

Inherited Methods

Inherited From atkPlainMenu

atkPlainMenu::$m_height

Inherited From atkPlainMenu

atkPlainMenu::atkPlainMenu()

Constructor

atkPlainMenu::getHeight()

Get the height for this menu

atkPlainMenu::getMenu()

Get the menu

atkPlainMenu::getMultilevel()

Is this menu multilevel?

atkPlainMenu::getPosition()

Get the menu position

atkPlainMenu::getScrollable()

Is this menu scrollable?

atkPlainMenu::menu_cmp()

Compare two menuitems

atkPlainMenu::render()

Render the menu

Inherited From atkmenuinterface

atkmenuinterface::getFooter()

Return the menu footer

atkmenuinterface::getHeader()

Return the menu header

atkmenuinterface::getHeight()

If the menu is displayed in the top frame of the application, this method should return the height of the frame that the menu requires.

atkmenuinterface::getMenuTranslation()

Translates a menuitem with the menu_ prefix, or if not found without

atkmenuinterface::getMultilevel()

Determine if the menu can handle multiple levels of submenu.

atkmenuinterface::getPosition()

Retrieve the position in which the menu is displayed.

atkmenuinterface::getScrollable()

Retrieve the scrolling possibilities of the menu.

atkmenuinterface::isEnabled()

Recursively checks if a menuitem should be enabled or not.

atkmenuinterface::render()

Render the menu

[ Top ]

Method Summary

atkModernMenu	atkModernMenu()	Constructor
void	addSubMenuForMenuItem()	Add submenu for menu item
string	getHeader()	Get the header
string	getMenu()	Get the menu
array	getMenuItems()	Get menuitems
string	getMenuTopName()	Get the menu top name
unknown	render()	Render the menu

[ Top ]

Properties

Methods

Constructor atkModernMenu [line 37]

atkModernMenu atkModernMenu(
)

Constructor

[ Top ]

addSubMenuForMenuItem [line 168]

void addSubMenuForMenuItem(
array
$menu, 
&$menuitem, array
$menuitem 
)

Add submenu for menu item

Parameters:

array	$menu:
array	$menuitem:
	&$menuitem:

[ Top ]

getHeader [line 213]

string getHeader(
string
$atkmenutop 
)

Get the header

Parameters:

string

$atkmenutop:

API Tags:

Return:

Empty string

Redefinition of:

atkmenuinterface::getHeader(): Return the menu header

[ Top ]

getMenu [line 68]

string getMenu(
)

Get the menu

API Tags:

Return:

The menu

Redefinition of:

atkPlainMenu::getMenu(): Get the menu

Redefined in descendants as:

atkcookmenu::getMenu() : Get the menu

[ Top ]

getMenuItems [line 125]

array getMenuItems(
array
$menu, string
$menutop 
)

Get menuitems

Parameters:

array	$menu:
string	$menutop:

API Tags:

Return:

Array with menu items

[ Top ]

getMenuTopName [line 110]

string getMenuTopName(
array
$menuitems, string
$menutop 
)

Get the menu top name

Parameters:

array	$menuitems:
string	$menutop:

API Tags:

Return:

The name of the menu top item

[ Top ]

render [line 47]

unknown render(
)

Render the menu

Redefinition of:

atkPlainMenu::render(): Render the menu

[ Top ]