bbbfly. AppLoader object

bbbfly.AppLoader

Examples
function ngMain(){
  bbbfly.AppLoader.ClearProgress();
  bbbfly.AppLoader.SetStepsCount(actions.length);
  for(var i in actions){
    bbbfly.AppLoader.SetProgressMessage(actions[i].message);
    actions[i].Do();
    bbbfly.AppLoader.MoveByStep();
  }
  bbbfly.AppLoader.Hide();
}

In Packages

Members

static eml enum string

Loader html element IDs
Name Type Default Description
loader string bbbflyAppLoader
load string bbbflyAppLoaderLoad
loadBar string bbbflyAppLoaderLoadBar
loadProgress string bbbflyAppLoaderLoadProgress
loadMessage string bbbflyAppLoaderLoadMessage
error string bbbflyAppLoaderError
errorMessage string bbbflyAppLoaderErrorMessage
errorReload string bbbflyAppLoaderErrorReload

Methods

ClearProgress ()

Set progress to 0% (step 0)
See:

Fail (){boolean}

Returns:
Type Description
boolean If error was indicated

GetElm (string){div}

Get html element
Parameters:
Name Type Description
string bbbfly.AppLoader.eml
Returns:
Type Description
div

GetProgress (){number}

Get percentage progress
See:
Returns:
Type Description
number Progress

Hide (){boolean}

Returns:
Type Description
boolean If loader was hidden

MoveByStep (){boolean}

Move progress by one defined step
See:
Returns:
Type Description
boolean If number of steps was set

SetProgress (progress){boolean}

Set percentage progress
Parameters:
Name Type Description
progress float Percentage progress value
See:
Returns:
Type Description
boolean If progress was valid

SetProgressMessage (message){boolean}

Set current progress message
Parameters:
Name Type Description
message string
Returns:
Type Description
boolean If message was valid

SetStepsCount (count){boolean}

Define number of progress steps for easy progress handling
Parameters:
Name Type Description
count integer Number of progress steps
See:
Returns:
Type Description
boolean If number of steps was valid

Show (){boolean}

Returns:
Type Description
boolean If loader was shown

UpdateProgress (){number}

Update progress visualization
Returns:
Type Description
number If progress was updated