Docs For Class atkmenuinterface

Home

Documentation home

Atk index

Docs For Class atkmenuinterface [ package: atk ]

Class: atkmenuinterface

Source Location: /menu/class.atkmenuinterface.inc

Class atkmenuinterface

Class Overview

Abstract baseclass (interface) for all menu implementations. Any menu implementation should extend this class and override the methods defined by this interface.

Located in /menu/class.atkmenuinterface.inc [line 29]

Wiki documentation

Author(s):

Ivo Jansch <ivo@ibuildings.nl>
Sandy Pleyte <sandy@ibuildings.nl>

Information Tags:

Properties

$m_height

Methods

[ Top ]

Descendants

Child Class	Description
atkDhtmlMenu	Implementation of the dhtml menu.
atkOutlookMenu	Wrapperclass for the outplook menu.
atkPlainMenu	Implementation of the plaintext menu.

[ Top ]

Property Summary

mixed

$m_height

[ Top ]

Method Summary

string	getFooter()	Return the menu footer
string	getHeader()	Return the menu header
int	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.
Translation	getMenuTranslation()	Translates a menuitem with the menu_ prefix, or if not found without
boolean	getMultilevel()	Determine if the menu can handle multiple levels of submenu.
int	getPosition()	Retrieve the position in which the menu is displayed.
int	getScrollable()	Retrieve the scrolling possibilities of the menu.
enabled?	isEnabled()	Recursively checks if a menuitem should be enabled or not.
String	render()	Render the menu

[ Top ]

Properties

mixed $m_height [line 31]

Redefined in descendants as:

[ Top ]

Methods

getFooter [line 69]

string getFooter(
string
$atkmenutop 
)

Return the menu footer

Parameters:

string

$atkmenutop:

API Tags:

Return:

The menu footer

[ Top ]

getHeader [line 59]

string getHeader(
string
$atkmenutop 
)

Return the menu header

Parameters:

string

$atkmenutop:

API Tags:

Return:

The menu header

Redefined in descendants as:

atkModernMenu::getHeader() : Get the header

[ Top ]

getHeight [line 80]

int 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.

The framework calls this method to determine the frameset dimensions.

API Tags:

Return:

The required frame height.

Redefined in descendants as:

atkDhtmlMenu::getHeight() : Get the menu height
atkPlainMenu::getHeight() : Get the height for this menu

[ Top ]

getMenuTranslation [line 48]

Translation getMenuTranslation(
String
$menuitem, [String
$modname = 'atk'] 
)

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

Parameters:

String	$menuitem:	Menuitem to translate
String	$modname:	Module to which the menuitem belongs

API Tags:

Return:

of the given menuitem

[ Top ]

getMultilevel [line 109]

boolean getMultilevel(
)

Determine if the menu can handle multiple levels of submenu.

API Tags:

Return:

True if multiple levels are supported, false if each menu can only have one level of submenuitems.

Redefined in descendants as:

atkDhtmlMenu::getMultilevel() : Is this menu multilevel?
atkOutlookMenu::getMultilevel() : Is this menu multilevel?
atkPlainMenu::getMultilevel() : Is this menu multilevel?

[ Top ]

getPosition [line 91]

int getPosition(
)

Retrieve the position in which the menu is displayed.

The framework calls this method to determine the structure of the frameset.

API Tags:

Return:

The MENU_* frameposition.

Redefined in descendants as:

atkDhtmlMenu::getPosition() : Get the menu position
atkOutlookMenu::getPosition() : Get the position of this menu
atkPlainMenu::getPosition() : Get the menu position

[ Top ]

getScrollable [line 99]

int getScrollable(
)

Retrieve the scrolling possibilities of the menu.

API Tags:

Return:

the MENU_* scroll definition

Redefined in descendants as:

atkDhtmlMenu::getScrollable() : Is this menu scrollable?
atkOutlookMenu::getScrollable() : Is this menu scrollable?
atkPlainMenu::getScrollable() : Is this menu scrollable?

[ Top ]

isEnabled [line 120]

enabled? isEnabled(
array
$menuitem 
)

Recursively checks if a menuitem should be enabled or not.

Parameters:

array

$menuitem:

menuitem array

[ Top ]

render [line 37]

String render(
)

Render the menu

API Tags:

Return:

HTML fragment containing the menu.

Redefined in descendants as:

atkDhtmlMenu::render() : Render the menu
atkOutlookMenu::render() : Render the menu
atkPlainMenu::render() : Render the menu
atkDropdownMenu::render() : Render the menu
atkFramesMenu::render() : Render the menu
atkModernMenu::render() : Render the menu

[ Top ]