import SpinnerBehavior from 'flexicious-react-datagrid/js/behaviors/SpinnerBehavior.js'

public class | source

SpinnerBehavior

Extends:

TypedObject → SpinnerBehavior

Attaches the spinner behavior to the owner component. When the startspin method of this behavior is called, the behavior will instantiate a new spinner based on the owners Spinner Factory, and position it in the middle of the owner components display area. When the stop spin method is called, the behavior will remove the spinner from the owner component and stop the spin.

Constructor Summary

Public Constructor
public	constructor(ownerComponent: *)

Member Summary

Public Members
public	label: *
public	ownerComponent: * The spinner associates itself with this component
public	spinner: *
public	spinnerVisible: * Whether or not this control is visible.

Method Summary

Public Methods
public	getClassNames(): string[]
public	hideSpinner() Removes the spinner and sets the bodyContainer.alpha back to 1
public	kill()
public	onOwnerCreationComplete(event: *)
public	showMessage(msg: *)
public	showSpinner(msg: *) Shows the spinner with default values defined below: Label: "Loading please wait" X Position : center X of the grid Y Position : center Y of the grid Grid Alpa when the spinner is active : 0.3 Spinner appearance can be modified using styles .

Inherited Summary

From class TypedObject
public	typeCache: {}
public	constructed()
public	getClassNames(): Array Returns a list of strings that represent the object hierarchy for this object.
public	implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class.

Public Constructors

public constructor(ownerComponent: *) source

Override:

TypedObject#constructor

Params:

Name	Type	Attribute	Description
ownerComponent	*

Public Members

public label: * source

public ownerComponent: * source

The spinner associates itself with this component

Properties:

Name	Type	Attribute	Description
ownerComponent	*

public spinner: * source

public spinnerVisible: * source

Whether or not this control is visible.

Properties:

Name	Type	Attribute	Description
spinnerVisible	*

Public Methods

public getClassNames(): string[] source

Returns a list of strings that represent the object hierarchy for this object.

Override:

TypedObject#getClassNames

Return:

string[]

public hideSpinner() source

Removes the spinner and sets the bodyContainer.alpha back to 1

public kill() source

public onOwnerCreationComplete(event: *) source

Params:

Name	Type	Attribute	Description
event	*

public showMessage(msg: *) source

Params:

Name	Type	Attribute	Description
msg	*

public showSpinner(msg: *) source

Shows the spinner with default values defined below:
Label: "Loading please wait"
X Position : center X of the grid
Y Position : center Y of the grid
Grid Alpa when the spinner is active : 0.3
Spinner appearance can be modified using styles
.

Params:

Name	Type	Attribute	Description
msg	*