C# Class Fluqi.Widget.jMenu.Options

A set of properties to apply to a set of jQuery UI Menu.

Properties not yet supported:

Inheritance: Core.Options

Datei anzeigen Open project: toepoke/Fluqi

Public Methods

Method	Description
Finish ( ) : Menu	Used to flag that configuration of Options has finished, and returns the Menu object so we can continue defining Tabs attributes.
Options ( Menu menu ) : System	Constructor
SetDisabled ( bool value ) : Options	Disables the menu if set to true.
SetIcons ( Core subMenuIcon ) : Options	Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.
SetIcons ( string subMenuIcon ) : Options	Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.
SetMenus ( string value ) : Options	Selector for the elements that serve as the menu container, including sub-menus.
SetRole ( string role ) : Options	Customize the ARIA roles used for the menu and menu items. The default uses "menuitem" for items. Setting the role option to "listbox" will use "option" for items. If set to null, no roles will be set, which is useful if the menu is being controlled by another element that is maintaining focus.

Protected Methods

Method	Description
DiscoverOptions ( Core options ) : void	Builds up a set of options the control can use (i.e. jQuery UI control supports). Which is then used in rendering the JavaScript required to initialise the control properties.
Reset ( ) : void	Resets all the control properties back to their default settings (i.e. the defaults as documented by jQuery UI library

Method Details

DiscoverOptions() protected method

Builds up a set of options the control can use (i.e. jQuery UI control supports). Which is then used in rendering the JavaScript required to initialise the control properties.

protected DiscoverOptions ( Core options ) : void
options	Core	Collection to add the identified options to
return	void

Finish() public method

Used to flag that configuration of Options has finished, and returns the Menu object so we can continue defining Tabs attributes.

public Finish ( ) : Menu
return	Menu

Options() public method

Constructor

public Options ( Menu menu ) : System
menu	Menu	Menu to configure options of
return	System

Reset() protected method

Resets all the control properties back to their default settings (i.e. the defaults as documented by jQuery UI library

protected Reset ( ) : void
return	void

SetDisabled() public method

Disables the menu if set to true.

public SetDisabled ( bool value ) : Options
value	bool	If true disables the menu, enabled otherwise
return	Options

SetIcons() public method

Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.

public SetIcons ( Core subMenuIcon ) : Options
subMenuIcon	Core	Sub menu icon to use
return	Options

SetIcons() public method

Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.

public SetIcons ( string subMenuIcon ) : Options
subMenuIcon	string	Sub menu icon to use
return	Options

SetMenus() public method

Selector for the elements that serve as the menu container, including sub-menus.

public SetMenus ( string value ) : Options
value	string
return	Options

SetRole() public method

Customize the ARIA roles used for the menu and menu items. The default uses "menuitem" for items. Setting the role option to "listbox" will use "option" for items. If set to null, no roles will be set, which is useful if the menu is being controlled by another element that is maintaining focus.

public SetRole ( string role ) : Options
role	string	Role to use
return	Options