Docs For Class atkPlainMenu

Inherited Properties	Inherited Methods
	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 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 ]

Property Summary

mixed

$m_height

[ Top ]

Method Summary

atkPlainMenu	atkPlainMenu()	Constructor
int	getHeight()	Get the height for this menu
string	getMenu()	Get the menu
int	getMultilevel()	Is this menu multilevel?
int	getPosition()	Get the menu position
int	getScrollable()	Is this menu scrollable?
int	menu_cmp()	Compare two menuitems
String	render()	Render the menu

[ Top ]

Properties

mixed $m_height [line 28]

Redefinition of:

atkmenuinterface::$m_height

[ Top ]

Methods

Constructor atkPlainMenu [line 35]

atkPlainMenu atkPlainMenu(
)

Constructor

[ Top ]

getHeight [line 145]

int getHeight(
)

Get the height for this menu

API Tags:

Return:

The height of the menu

Redefinition of:

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.

[ Top ]

getMenu [line 58]

string getMenu(
)

Get the menu

API Tags:

Return:

The menu

Redefined in descendants as:

atkDropdownMenu::getMenu() : Get the menu
atkModernMenu::getMenu() : Get the menu
atkcookmenu::getMenu() : Get the menu

[ Top ]

getMultilevel [line 181]

int getMultilevel(
)

Is this menu multilevel?

API Tags:

Return:

MENU_MULTILEVEL or MENU_NOMULTILEVEL

Redefinition of:

atkmenuinterface::getMultilevel(): Determine if the menu can handle multiple levels of submenu.

[ Top ]

getPosition [line 155]

int getPosition(
)

Get the menu position

API Tags:

Return:

The menu position (MENU_RIGHT, MENU_TOP, MENU_BOTTOM or MENU_LEFT)

Redefinition of:

atkmenuinterface::getPosition(): Retrieve the position in which the menu is displayed.

[ Top ]

getScrollable [line 171]

int getScrollable(
)

Is this menu scrollable?

API Tags:

Return:

MENU_SCROLLABLE or MENU_UNSCROLLABLE

Redefinition of:

atkmenuinterface::getScrollable(): Retrieve the scrolling possibilities of the menu.

[ Top ]

menu_cmp [line 134]

int menu_cmp(
array
$a, array
$b 
)

Compare two menuitems

Parameters:

array	$a:
array	$b:

[ Top ]

render [line 44]

String render(
)

Render the menu

API Tags:

Return:

HTML fragment containing the menu.

Redefinition of:

atkmenuinterface::render(): Render the menu

Redefined in descendants as:

atkDropdownMenu::render() : Render the menu
atkFramesMenu::render() : Render the menu
atkModernMenu::render() : Render the menu

[ Top ]