Throbber

Overview

File

Class

Tree

Index

Help

PHP2Go Javascript Framework

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class Throbber

Object
   |
   +--Throbber

class Throbber

Defined in util/throbber.js

Field Summary
`Boolean`	`centralize` Whether to centralize the throbber in its parent
`Object`	`element` The throbber
`Function`	`onHide` onHide handler function
`Function`	`onShow` onShow handler function
`Object`	`parent` Parent element (by position)

Constructor Summary
`Throbber (<Object> opts)` A throbber is a graphic element used to indicate that an action is being performed.

Method Summary
`void`	`hide()` Hide the trobber
`Boolean`	`isActive()` Verify if throbber is currently active (visible)
`void`	`setup()` Initializes throbber element and handler functions
`void`	`show()` Turn on throbber's visibility

Field Detail

centralize

Boolean centralize

Whether to centralize the throbber in its parent

element

Object element

The throbber

onHide

Function onHide

onHide handler function

onShow

Function onShow

onShow handler function

parent

Object parent

Parent element (by position)

Constructor Detail

Throbber

Throbber(<Object> opts)

A throbber is a graphic element used to indicate that an action is being performed. This class exposes a simple API to show/hide these graphic elements

Parameters:

opts

Method Detail

hide

void hide()

Hide the trobber

isActive

Boolean isActive()

Verify if throbber is currently active (visible)

setup

void setup()

Initializes throbber element and handler functions

show

void show()

Turn on throbber's visibility