C# Class Fluqi.Utilities.jAnimation.Options

Inheritance: Core.Options

Exibir arquivo Open project: toepoke/Fluqi

Public Methods

Method	Description
Finish ( ) : Animation	Used to flag that configuration of Options has finished, and returns the Animation object so we can continue defining Tabs attributes.
Options ( Animation ani, string caller ) : System	Constructor
SetDisabled ( ) : Options	Turns off the animation
SetDuration ( Core speed ) : Options	The duration the effect should play for.
SetDuration ( int duration ) : Options	The duration the effect should play for (in milliseconds).
SetDuration ( string duration ) : Options	The duration the effect should play for.
SetEasing ( Core easing ) : Options	The easing effect to use when showing/hiding.
SetEasing ( string easing ) : Options	The easing effect to use when showing/hiding.
SetEffect ( Core animation ) : Options	The effect to use when showing/hiding.
SetEffect ( string effect ) : Options	The effect to use when showing/hiding.
SetJSON ( string json ) : Options	Sets the effects as a JSON object

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.
GetAnimationScriptOption ( ) : Core.ScriptOption	Gets a script option defining the Animation options (this is exposed as the Animation control is used in other controls).
GetAnimationScriptOption ( bool asChild ) : Core.ScriptOption	Gets a script option defining the Animation options (this is exposed as the Animation control is used in other controls).
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 Animation object so we can continue defining Tabs attributes.

public Finish ( ) : Animation
return	Animation

GetAnimationScriptOption() protected method

Gets a script option defining the Animation options (this is exposed as the Animation control is used in other controls).

protected GetAnimationScriptOption ( ) : Core.ScriptOption
return	Core.ScriptOption

GetAnimationScriptOption() protected method

Gets a script option defining the Animation options (this is exposed as the Animation control is used in other controls).

protected GetAnimationScriptOption ( bool asChild ) : Core.ScriptOption
asChild	bool	Flags that this option should be added a child
return	Core.ScriptOption

Options() public method

Constructor

public Options ( Animation ani, string caller ) : System
ani	Animation	Animation object to define options for
caller	string	caller
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

Turns off the animation

public SetDisabled ( ) : Options
return	Options

SetDuration() public method

The duration the effect should play for.

public SetDuration ( Core speed ) : Options
speed	Core	Duration enum to use.
return	Options

SetDuration() public method

The duration the effect should play for (in milliseconds).

public SetDuration ( int duration ) : Options
duration	int	Duration (milliseconds) to use.
return	Options

SetDuration() public method

The duration the effect should play for.

public SetDuration ( string duration ) : Options
duration	string	Duration to use, can be milliseconds, or "fast", "slow" or "normal".
return	Options

SetEasing() public method

The easing effect to use when showing/hiding.

public SetEasing ( Core easing ) : Options
easing	Core	Easing enum to use
return	Options

SetEasing() public method

The easing effect to use when showing/hiding.

public SetEasing ( string easing ) : Options
easing	string	Easing name to use
return	Options

SetEffect() public method

The effect to use when showing/hiding.

public SetEffect ( Core animation ) : Options
animation	Core	Effect enum to use
return	Options

SetEffect() public method

The effect to use when showing/hiding.

public SetEffect ( string effect ) : Options
effect	string	Effect as a string to use
return	Options

SetJSON() public method

Sets the effects as a JSON object

public SetJSON ( string json ) : Options
json	string	JSON object to use
return	Options