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

Swat.SwatMenuGroup

/Swat/SwatMenuGroup.php at line 24

Class SwatMenuGroup

SwatObject
 └─SwatUIObject
    └─SwatWidget
       └─SwatControl
          └─SwatMenuGroup

public class SwatMenuGroup
extends SwatControl

A group of menu items

SwatMenuGroup objects are added to SwatGroupedMenu objects and are used to group together a set of SwatMenuItem objects.

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

Field Summary
protected array	$items The set of SwatMenuItem objects contained in this group.
string	$title The user-visible title of this group.

Field Summary

protected array

$items

The set of SwatMenuItem objects contained in this group.

string

$title

The user-visible title of this group.

Method Summary
void	addChild(SwatMenuItem child) Adds a child object.
void	addItem(SwatMenuItem item) Adds a menu item to this group.
SwatUIObject	copy(string id_suffix) Performs a deep copy of the UI tree starting with this UI object.
void	display(boolean first) Displays this menu group.
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	setDescendantStates(array states) Sets descendant states.
void	setMenuItemValues(string value) Sets the value of all SwatMenuItem objects within this menu group.

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/SwatMenuGroup.php at line 43

items

protected array $items = array()

The set of SwatMenuItem objects contained in this group

/Swat/SwatMenuGroup.php at line 33

title

public string $title

The user-visible title of this group

Method Detail

/Swat/SwatMenuGroup.php at line 77

addChild

public void addChild(SwatMenuItem 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 item to a menu group, use SwatMenuGroup::addItem().

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

/Swat/SwatMenuGroup.php at line 53

addItem

public void addItem(SwatMenuItem item)

Adds a menu item to this group

Parameters:: item - the item to add.

/Swat/SwatMenuGroup.php at line 290

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/SwatMenuGroup.php at line 97

display

public void display(boolean first)

Displays this menu group

Parameters:: first - optional. Whether or not this group is the first group in a {@link SwatGroupedMenu}. Defaults to false.

/Swat/SwatMenuGroup.php at line 247

getDescendantStates

public array getDescendantStates()

Gets descendant states

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

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

/Swat/SwatMenuGroup.php at line 176

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 menu group. If descendant objects have identifiers, the identifier is used as the array key.
See Also:: SwatUIParent::getDescendants()

/Swat/SwatMenuGroup.php at line 212

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/SwatMenuGroup.php at line 269

setDescendantStates

public void setDescendantStates(array states)

Sets descendant states

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

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

/Swat/SwatMenuGroup.php at line 153

setMenuItemValues

public void setMenuItemValues(string value)

Sets the value of all SwatMenuItem objects within this menu group

This is usually easier than setting all the values manually if the values are dynamic.

Frames No frames