C# Class Fluqi.Widget.jMenu.Methods

Methods for changing options (after initialisation).
Inheritance: Core.Methods
Datei anzeigen Open project: toepoke/Fluqi

Public Methods

Method Description
Blur ( ) : void

Removes focus from a menu, resets any active element styles and triggers the menu's blur event.
Close ( ) : void

Removes focus from a menu, resets any active element styles and triggers the menu's blur event.
Collapse ( ) : void

Closes the currently active sub-menu.
CollapseAll ( ) : void

Closes all open sub-menus.
Destroy ( ) : void

Removes the menu functionality completely. This will return the element back to its pre-init state.
Disable ( ) : void

Disables the menu.
Enable ( ) : void

Enables the menu.
Expand ( ) : void

Opens the sub-menu below the currently active item, if one exists.
Focus ( string itemSelector ) : void

Activates a particular menu item, begins opening any sub-menu if present and triggers the menu's focus
GetDisabled ( ) : void

Disables the menu if set to true.
GetIcons ( ) : void

Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.
GetMenus ( ) : void

Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.
GetPosition ( ) : void

Returns [in JavaScript] the current "position" setting.
GetRole ( ) : void

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.
IsFirstItem ( ) : void

Returns a boolean value stating whether or not the currently active item is the first item in the menu.
IsLastItem ( ) : void

Returns a boolean value stating whether or not the currently active item is the last item in the menu.
Methods ( Menu menu ) : System

Constructor
Next ( ) : void

Moves active state to next menu item.
NextPage ( ) : void

Moves active state to first menu item below the bottom of a scrollable menu or the last item if not scrollable.
Previous ( ) : void

Moves active state to previous menu item.
PreviousPage ( ) : void

Moves active state to first menu item above the top of a scrollable menu or the first item if not scrollable.
Refresh ( ) : void

Initializes sub-menus and menu items that have not already been initialized. New menu items, including sub-menus can be added to the menu or all of the contents of the menu can be replaced and then initialized with the refresh() method.
Select ( ) : void

Selects the currently active menu item, collapses all sub-menus and triggers the menu's select event.
SetDisabled ( bool value ) : void

Disables the menu if set to true.
SetIcons ( Core submenu ) : void

Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.
SetIcons ( string submenu ) : void

Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.
SetMenus ( string menus ) : void

Selector for the elements that serve as the menu container, including sub-menus.
SetPosition ( Core position ) : void

Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.
SetPosition ( Core pos1, Core pos2 ) : void

Specifies where the dialog should be displayed. Possible values: An array containing x,y position string values (e.g. ['right','top'] for top right corner)
SetPosition ( int pos1, int pos2 ) : void

Specifies where the dialog should be displayed. Possible values: An array containing an x,y coordinate pair in pixel offset from left, top corner of viewport (e.g. [350,100])
SetPosition ( string position ) : void

Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.
SetPosition ( string position, bool inDoubleQuotes ) : void

Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.
SetPosition ( string pos1, string pos2 ) : void

Specifies where the dialog should be displayed. Possible values: An array containing x,y position string values (e.g. ['right','top'] for top right corner)
SetPositionJS ( string position ) : void

Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).
SetRole ( string role ) : void

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.
Widget ( ) : void

Returns a jQuery object containing the menu.

Method Details

Blur() public method

Removes focus from a menu, resets any active element styles and triggers the menu's blur event.
public Blur ( ) : void
return void

Close() public method

Removes focus from a menu, resets any active element styles and triggers the menu's blur event.
public Close ( ) : void
return void

Collapse() public method

Closes the currently active sub-menu.
public Collapse ( ) : void
return void

CollapseAll() public method

Closes all open sub-menus.
public CollapseAll ( ) : void
return void

Destroy() public method

Removes the menu functionality completely. This will return the element back to its pre-init state.
public Destroy ( ) : void
return void

Disable() public method

Disables the menu.
public Disable ( ) : void
return void

Enable() public method

Enables the menu.
public Enable ( ) : void
return void

Expand() public method

Opens the sub-menu below the currently active item, if one exists.
public Expand ( ) : void
return void

Focus() public method

Activates a particular menu item, begins opening any sub-menu if present and triggers the menu's focus
public Focus ( string itemSelector ) : void
itemSelector string
return void

GetDisabled() public method

Disables the menu if set to true.
public GetDisabled ( ) : void
return void

GetIcons() public method

Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.
public GetIcons ( ) : void
return void

GetMenus() public method

Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.
public GetMenus ( ) : void
return void

GetPosition() public method

Returns [in JavaScript] the current "position" setting.
public GetPosition ( ) : void
return void

GetRole() 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 GetRole ( ) : void
return void

IsFirstItem() public method

Returns a boolean value stating whether or not the currently active item is the first item in the menu.
public IsFirstItem ( ) : void
return void

IsLastItem() public method

Returns a boolean value stating whether or not the currently active item is the last item in the menu.
public IsLastItem ( ) : void
return void

Methods() public method

Constructor
public Methods ( Menu menu ) : System
menu Menu Menu object to call
return System

Next() public method

Moves active state to next menu item.
public Next ( ) : void
return void

NextPage() public method

Moves active state to first menu item below the bottom of a scrollable menu or the last item if not scrollable.
public NextPage ( ) : void
return void

Previous() public method

Moves active state to previous menu item.
public Previous ( ) : void
return void

PreviousPage() public method

Moves active state to first menu item above the top of a scrollable menu or the first item if not scrollable.
public PreviousPage ( ) : void
return void

Refresh() public method

Initializes sub-menus and menu items that have not already been initialized. New menu items, including sub-menus can be added to the menu or all of the contents of the menu can be replaced and then initialized with the refresh() method.
public Refresh ( ) : void
return void

Select() public method

Selects the currently active menu item, collapses all sub-menus and triggers the menu's select event.
public Select ( ) : void
return void

SetDisabled() public method

Disables the menu if set to true.
public SetDisabled ( bool value ) : void
value bool
return void

SetIcons() public method

Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.
public SetIcons ( Core submenu ) : void
submenu Core
return void

SetIcons() public method

Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.
public SetIcons ( string submenu ) : void
submenu string
return void

SetMenus() public method

Selector for the elements that serve as the menu container, including sub-menus.
public SetMenus ( string menus ) : void
menus string
return void

SetPosition() public method

Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.
public SetPosition ( Core position ) : void
position Core New position setting
return void

SetPosition() public method

Specifies where the dialog should be displayed. Possible values: An array containing x,y position string values (e.g. ['right','top'] for top right corner)
public SetPosition ( Core pos1, Core pos2 ) : void
pos1 Core First position setting
pos2 Core Second position setting
return void

SetPosition() public method

Specifies where the dialog should be displayed. Possible values: An array containing an x,y coordinate pair in pixel offset from left, top corner of viewport (e.g. [350,100])
public SetPosition ( int pos1, int pos2 ) : void
pos1 int First position setting
pos2 int Second position setting
return void

SetPosition() public method

Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.
public SetPosition ( string position ) : void
position string New position setting
return void

SetPosition() public method

Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'.
public SetPosition ( string position, bool inDoubleQuotes ) : void
position string New position setting
inDoubleQuotes bool /// true - double quotes (") /// false - single quotes (') ///
return void

SetPosition() public method

Specifies where the dialog should be displayed. Possible values: An array containing x,y position string values (e.g. ['right','top'] for top right corner)
public SetPosition ( string pos1, string pos2 ) : void
pos1 string First position setting
pos2 string Second position setting
return void

SetPositionJS() public method

Specifies where the dialog should be displayed. Possible values: A single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'. This entry point does _not_ add quotes to the input value and is indended for passing JavaScript (that is when rendered, the input value will refer to a JavaScript variable for instance).
public SetPositionJS ( string position ) : void
position string New position setting
return void

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 ) : void
role string
return void

Widget() public method

Returns a jQuery object containing the menu.
public Widget ( ) : void
return void