diff options
Diffstat (limited to 'public/javascripts/shadowbox/players/README')
| -rw-r--r-- | public/javascripts/shadowbox/players/README | 35 |
1 files changed, 0 insertions, 35 deletions
diff --git a/public/javascripts/shadowbox/players/README b/public/javascripts/shadowbox/players/README deleted file mode 100644 index 7f32991..0000000 --- a/public/javascripts/shadowbox/players/README +++ /dev/null | |||
| @@ -1,35 +0,0 @@ | |||
| 1 | A Shadowbox "player" is a class that is used specifically for displaying a | ||
| 2 | particular medium. For example, an image player is included for displaying | ||
| 3 | images, a QuickTime player is included for playing QuickTime movies, etc. | ||
| 4 | |||
| 5 | All players should implement the same interface. This makes it possible for the | ||
| 6 | Shadowbox class to know what methods to call and properties to check on player | ||
| 7 | objects. | ||
| 8 | |||
| 9 | The interface is described here, with some simple explanations of how each | ||
| 10 | method and/or property is to be used. | ||
| 11 | |||
| 12 | METHOD/PROPERTY DESCRIPTION | ||
| 13 | |||
| 14 | height (Number) The height of the object (in pixels) | ||
| 15 | width (Number) The width of the object (in pixels) | ||
| 16 | ready (optional, Boolean) True if the content is ready to be | ||
| 17 | loaded, false otherwise. Useful when the script should wait | ||
| 18 | until the content loads before proceeding (see below) | ||
| 19 | resizable (optional, Boolean) True if the content can be dynamically | ||
| 20 | resized by the script (e.g. images, but not most movie | ||
| 21 | formats) | ||
| 22 | append() Appends this object to the DOM | ||
| 23 | remove() Removes this object from the DOM | ||
| 24 | onLoad() (optional) Called after the content is loaded and the | ||
| 25 | loading layer is hidden | ||
| 26 | onWindowResize() (optional) Called when the window is resized | ||
| 27 | |||
| 28 | If the ready property is set to false, the script will wait until it is set true | ||
| 29 | before proceeding to call the onReady callback. This property should be changed | ||
| 30 | in some callback function within the player class itself. | ||
| 31 | |||
| 32 | In this case, the object's height and width do not need to be made available | ||
| 33 | immediately (because they may not initially be known). However, in the same | ||
| 34 | callback, the height and width should be set. See the Shadowbox.img class (in | ||
| 35 | shadowbox-img.js) for an example of this behavior. | ||
