C# Class Fluqi.Widget.jPushButton.Options

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

Properties not yet supported:

Inheritance: Core.Options

Datei anzeigen Open project: toepoke/Fluqi

Public Methods

Method	Description
Finish ( ) : Fluqi.Widget.jPushButton.PushButton	Used to flag that configuration of Options has finished, and returns the PushButton object so we can continue defining Tabs attributes.
Options ( Fluqi.Widget.jPushButton.PushButton btn ) : System	Constructor
SetDisabled ( bool disable ) : Options	Disables (true) or enables (false) the button. Can be set when initialising (first creating) the button.
SetIcons ( Core primaryIconClass ) : Options	Icons to display, with or without text (see text option). The primary icon is displayed by default on the left of the label text, the secondary by default is on the right. Value for the primary and secondary properties must be a classname (String), eg. "ui-icon-gear". For using only one icon: icons: {primary:'ui-icon-locked'}.
SetIcons ( Core primaryIconClass, Core secondaryIconClass ) : Options	Icons to display, with or without text (see text option). The primary icon is displayed by default on the left of the label text, the secondary by default is on the right. Value for the primary and secondary properties must be a classname (String), eg. "ui-icon-gear". For using only one icon: icons: {primary:'ui-icon-locked'}. For using two icons: icons: {primary:'ui-icon-gear',secondary:'ui-icon-triangle-1-s'}
SetIcons ( string primaryIcon ) : Options	Icons to display, with or without text (see text option). The primary icon is displayed by default on the left of the label text, the secondary by default is on the right. Value for the primary and secondary properties must be a classname (String), eg. "ui-icon-gear". For using only one icon: icons: {primary:'ui-icon-locked'}.
SetIcons ( string primaryIcon, string secondaryIcon ) : Options	Icons to display, with or without text (see text option). The primary icon is displayed by default on the left of the label text, the secondary by default is on the right. Value for the primary and secondary properties must be a classname (String), eg. "ui-icon-gear". For using only one icon: icons: {primary:'ui-icon-locked'}. For using two icons: icons: {primary:'ui-icon-gear',secondary:'ui-icon-triangle-1-s'}
SetText ( bool text ) : Options	Whether to show any text - when set to false (display no text), icons (see icons option) must be enabled, otherwise it'll be ignored.

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 PushButton object so we can continue defining Tabs attributes.

public Finish ( ) : Fluqi.Widget.jPushButton.PushButton
return	Fluqi.Widget.jPushButton.PushButton

Options() public method

Constructor

public Options ( Fluqi.Widget.jPushButton.PushButton btn ) : System
btn	Fluqi.Widget.jPushButton.PushButton	PushButton 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 (true) or enables (false) the button. Can be set when initialising (first creating) the button.

public SetDisabled ( bool disable ) : Options
disable	bool	Whether the control is disabled or not
return	Options

SetIcons() public method

Icons to display, with or without text (see text option). The primary icon is displayed by default on the left of the label text, the secondary by default is on the right. Value for the primary and secondary properties must be a classname (String), eg. "ui-icon-gear". For using only one icon: icons: {primary:'ui-icon-locked'}.

public SetIcons ( Core primaryIconClass ) : Options
primaryIconClass	Core	New setting
return	Options

SetIcons() public method

public SetIcons ( Core primaryIconClass, Core secondaryIconClass ) : Options
primaryIconClass	Core	New setting
secondaryIconClass	Core	New setting
return	Options

SetIcons() public method

public SetIcons ( string primaryIcon ) : Options
primaryIcon	string	New setting
return	Options

SetIcons() public method

public SetIcons ( string primaryIcon, string secondaryIcon ) : Options
primaryIcon	string	New setting
secondaryIcon	string	New setting
return	Options

SetText() public method

Whether to show any text - when set to false (display no text), icons (see icons option) must be enabled, otherwise it'll be ignored.

public SetText ( bool text ) : Options
text	bool	New flag setting
return	Options