Zapatec.Modal

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.Modal

    Object
       |
       +--Zapatec.Modal

class Zapatec.Modal

Defined in indicator.js

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

Constructor Summary
`Zapatec.Modal(config)` Zapatec modal object.

Method Summary
`void` | `configure(config)` Configurates the object.
`void` | `create()` Creates the actual element and assigns classes and styles to it.
`void` | `hide(destroy)` Hides the modal cover.
`void` | `init(config)` Inits the object with config options.
`void` | `setHeight(height)` Sets the height of the modal cover.
`void` | `setPosition(x, y)` Sets the position of the modal cover.
`void` | `setWidth(width)` Sets the width of the modal cover.
`void` | `show(zIndex)` Shows the modal cover, creates it if it still wasn't.
`void` | `update()` Updates the size and position of modal cove due to container option.

Field Detail

### id

    <static> Object id

Constructor Detail

### Zapatec.Modal

    Zapatec.Modal(config)

Zapatec modal object. It represents the element that imitates modal behaviour. The constructor recognizes the following options: \code prop. name | description ------------------------------------------------------------------------------------------------- zIndex | {number} z-index for the element. Default 1000. x | {number} X coordinate of the element. Default null. y | {number} Y coordinate of the element. Default null. width | {number} width of the element. Default null. height | {number} height of the element. Default null. container | {HTML element or Default View} container for the element. Default window. scroll | {boolean} if the element is fixed on screen. Default false. \endcode

Method Detail

### configure

    void configure(config)

Configurates the object.

Parameters:

`config` - {object} object with configuration.

### create

    void create()

Creates the actual element and assigns classes and styles to it.

### hide

    void hide(destroy)

Hides the modal cover.

Parameters:

`destroy` - {boolean} if true the cover will be destroyed.

### init

    void init(config)

Inits the object with config options.

Parameters:

`config` - {object} object with configuration.

### setHeight

    void setHeight(height)

Sets the height of the modal cover.

Parameters:

`height` - {number} new height.

### setPosition

    void setPosition(x, y)

Sets the position of the modal cover.

Parameters:

`x` - {number} x coordinate of the cover.

`y` - {number} y coordinate of the cover.

### setWidth

    void setWidth(width)

Sets the width of the modal cover.

Parameters:

`width` - {number} new width.

### show

    void show(zIndex)

Shows the modal cover, creates it if it still wasn't.

Parameters:

`zIndex` - {number} z-ndex for the cover.

### update

    void update()

Updates the size and position of modal cove due to container option.

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