Summary: Field | Method | Constr Detail: Field | Method | Constr

Swat.SwatGroupedMenu

/Swat/SwatGroupedMenu.php at line 20

Class SwatGroupedMenu

SwatObject
 └─SwatUIObject
    └─SwatWidget
       └─SwatControl
          └─SwatAbstractMenu
             └─SwatGroupedMenu

public class SwatGroupedMenu
extends SwatAbstractMenu

A menu control where menu items are grouped together

Copyright:: 2007 silverorange
License:: http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
See Also:: SwatMenuGroup

Field Summary
protected array	$groups The set of SwatMenuGroup objects contained in this grouped menu.

Field Summary

protected array

$groups

The set of SwatMenuGroup objects contained in this grouped menu.

Fields inherited from Swat.SwatAbstractMenu
auto_sub_menu_display, click_to_hide

Method Summary
void	addChild(SwatMenuGroup child) Adds a child object.
void	addGroup(SwatMenuGroup group) Adds a group to this grouped menu.
SwatUIObject	copy(string id_suffix) Performs a deep copy of the UI tree starting with this UI object.
void	display() Displays this grouped menu.
array	getDescendantStates() Gets descendant states.
array	getDescendants(string class_name) Gets descendant UI-objects.
SwatUIObject	getFirstDescendant(string class_name) Gets the first descendant UI-object of a specific class.
void	init() Initializes this grouped menu.
void	setDescendantStates(array states) Sets descendant states.

Methods inherited from Swat.SwatAbstractMenu
getInlineJavaScript, getJavaScriptClass, setMenuItemValues

Methods inherited from Swat.SwatControl
addMessage, getNote, printWidgetTree

Methods inherited from Swat.SwatWidget
addCompositeWidget, addMessage, confirmCompositeWidgets, copy, createCompositeWidgets, display, displayHtmlHeadEntries, getCSSClassNames, getCompositeWidget, getCompositeWidgets, getFocusableHtmlId, getHtmlHeadEntrySet, getMessages, hasMessage, init, isDisplayed, isInitialized, isProcessed, isSensitive, printWidgetTree, process, replaceWithContainer

Methods inherited from Swat.SwatUIObject
addComment, addJavaScript, addStyleSheet, addTangoAttribution, copy, getCSSClassNames, getCSSClassString, getFirstAncestor, getHtmlHeadEntrySet, getInlineJavaScript, getUniqueId, isVisible

Field Detail

/Swat/SwatGroupedMenu.php at line 29

groups

protected array $groups = array()

The set of SwatMenuGroup objects contained in this grouped menu

Method Detail

/Swat/SwatGroupedMenu.php at line 63

addChild

public void addChild(SwatMenuGroup child)

Adds a child object

This method fulfills the SwatUIParent interface. It is used by SwatUI when building a widget tree and should not need to be called elsewhere. To add a menu group to a grouped menu, use SwatGroupedMenu::addGroup().

Parameters:: child - the child object to add.
Throws:: SwatInvalidClassException
See Also:: SwatUIParent; SwatGroupedMenu::addGroup()

/Swat/SwatGroupedMenu.php at line 39

addGroup

public void addGroup(SwatMenuGroup group)

Adds a group to this grouped menu

Parameters:: group - the group to add.

/Swat/SwatGroupedMenu.php at line 256

copy

public SwatUIObject copy(string id_suffix)

Performs a deep copy of the UI tree starting with this UI object

Parameters:: id_suffix - optional. A suffix to append to copied UI objects in the UI tree.
Returns:: a deep copy of the UI tree starting with this UI object.
See Also:: SwatUIObject::copy()

/Swat/SwatGroupedMenu.php at line 92

display

public void display()

Displays this grouped menu

/Swat/SwatGroupedMenu.php at line 213

getDescendantStates

public array getDescendantStates()

Gets descendant states

Retrieves an array of states of all stateful UI-objects in the widget subtree below this grouped menu.

Returns:: an array of UI-object states with UI-object identifiers as array keys.

/Swat/SwatGroupedMenu.php at line 142

getDescendants

public array getDescendants(string class_name)

Gets descendant UI-objects

Parameters:: class_name - optional class name. If set, only UI-objects that are instances of $class_name are returned.
Returns:: the descendant UI-objects of this grouped menu. If descendant objects have identifiers, the identifier is used as the array key.
See Also:: SwatUIParent::getDescendants()

/Swat/SwatGroupedMenu.php at line 178

getFirstDescendant

public SwatUIObject getFirstDescendant(string class_name)

Gets the first descendant UI-object of a specific class

Parameters:: class_name - class name to look for.
Returns:: the first descendant UI-object or null if no matching descendant is found.
See Also:: SwatUIParent::getFirstDescendant()

/Swat/SwatGroupedMenu.php at line 79

init

public void init()

Initializes this grouped menu

/Swat/SwatGroupedMenu.php at line 235

setDescendantStates

public void setDescendantStates(array states)

Sets descendant states

Sets states on all stateful UI-objects in the widget subtree below this grouped menu.

Parameters:: states - an array of UI-object states with UI-object identifiers as array keys.

Frames No frames