CORE
NATIVE
TABLE
MAKE
CUSTOMIZE
EFFECTS
effects_base.js
effects_morph.js
effects_fade.js
effects_move.js
effects_extra.js
effects_toggle.js
effects_cycle.js
effects_cycles.js
VIRTUAL BOX
PLUG-IN
virtual_base.js
Contains the Virtual Class which is a wrapper for creating complex virtual modal boxes
Contains
Class Virtual, Class Virtual.single
Requires
Summary
| Virtual | A wrapper for creating virtual contents like Virtual.Box and Virtual.Ajax Classes | |
| Virtual.single | Utility Wrapper to create single virtual boxes. Implemented by the other virtual single Classes |
A wrapper for creating virtual contents like Virtual.Box and Virtual.Ajax Classes
Implements
Overlay, Options, Events
Constructor
new Virtual (options)
Options
| enable | an object which allows you to decide which features must be enabled | |
| effect | the effect type. Can be 'open' (default), 'slide:vertical' (or 'slide'), 'slide:horizontal', 'fold' or 'fix' | |
| effectOptions | the main Fx effect options | |
| style | if true the boxes will be styled with the custom styles | |
| adjustStyles | if true the virtual box will be placed in the middle when user resize the window. Default is true. | |
| zones | an object which allows to set the class names for some zones of the virtual box | |
| arrowsBoxText | the text of the arrows box | |
| leftArrowText | the text of the left arrow. Default is 'prev' | |
| rightArrowText | the text of the right arrow. Default is 'next' | |
| closeButtonText | the text of the close button. Default is 'close' | |
| captionOpacity | the caption's opacity. Default is 0.4 |
enable:
-
arrows: if true the arrows will be enabled -
closeButton: if true the closeButton will be enabled. Otherwise you can close the box clicking on the overlay -
arrowsKeyboard: if true you can change the virtual box with the arrows of the keyboard -
closeKeyboard: if true you can remove the virtual box by pressing the 'esc' key -
caption: if true the caption will be enabled, and it will have a title an a content catched by the title property of the respective link
Events
| onShow | function fired when a new virtual box comes in | |
| onClose | function fired when the virtual box is closed | |
| onNext | function fired when the next virtual box comes in | |
| onPrev | function fired when the previous virtual box comes in |
Methods
| setEffect | sets the type of the entry effect | |
| virtualStyle | injects a css file dedicated to virtual box / virtual ajax | |
| setIDs | sets the id property to the specified zones |
top method setEffect
sets the type of the entry effect
Arguments
| effect | the effect |
Example
// open effect virtual.setEffect('open'); // fix effect virtual.setEffect('fix');
top method virtualStyle
injects a css file dedicated to virtual box / virtual ajax
Arguments
| path | the file path |
Example
virtual.virtualStyle('myPath/virtual_style.css');
top method setIDs
sets the id property to the specified zones
Arguments
| zones | an object with keywords as zones and values as id values |
Utility Wrapper to create single virtual boxes. Implemented by the other virtual single Classes.
Methods
| create | calls the virtual box |
top method create
calls the virtual box
Documentation By
Riccardo Degni -
powered by MakeDocs, CMS by RD
The moo.rd documentation is released under the
Creative Commons BY-NC SA License
