Zapatec.Indicator

Overview | File | Class | Tree | Index | Help

Zapatec Utils

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## Class Zapatec.Indicator

    Object
       |
       +--Zapatec.Indicator

class Zapatec.Indicator

Defined in indicator.js

Field Summary
`<static> Object` | `id`

Constructor Summary
`Zapatec.Indicator(config)` Zapatec indicator object The constructor recognizes same options as Zapatec.Modal constructor.

Method Summary
`void` | `configure(config)` Configurates the object.
`void` | `create()` Overwriting parent method.
`void` | `hide(destroy)` Overwriting parent method.
`void` | `init(config)` Inits the object.
`boolean` | `isActive()` Checks if indicator is active.
`void` | `setHeight(height)` Overwriting parent method.
`void` | `setWidth(width)` Overwriting parent method.
`void` | `start(message)` Starts the indicator, filling it with some message and showing.
`void` | `stop()` Stops the indicator.

Field Detail

### id

    <static> Object id

Constructor Detail

### Zapatec.Indicator

    Zapatec.Indicator(config)

Zapatec indicator object The constructor recognizes same options as Zapatec.Modal constructor.

Method Detail

### configure

    void configure(config)

Configurates the object.

Parameters:

`config` - {object} object with configuration.

### create

    void create()

Overwriting parent method.

### hide

    void hide(destroy)

Overwriting parent method.

Parameters:

`destroy` - {boolean} if we destroy the indicator.

### init

    void init(config)

Inits the object.

Parameters:

`config` - {object} object with configuration.

### isActive

    boolean isActive()

Checks if indicator is active.

Returns:

true if it is active, otherwise false.

### setHeight

    void setHeight(height)

Overwriting parent method.

Parameters:

`height` - {number} height to set.

### setWidth

    void setWidth(width)

Overwriting parent method.

Parameters:

`width` - {number} width to set.

### start

    void start(message)

Starts the indicator, filling it with some message and showing. Also puts it to active state.

Parameters:

`message` - {}

### stop

    void stop()

Stops the indicator.

Overview | File | Class | Tree | Index | Help

Zapatec Utils

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Documentation generated by JSDoc on Thu Aug 16 12:18:39 2007