Class CAF.Output

Object
   |
   +--CAF.Output

class CAF.Output

CAF Output utilities.
Defined in core.js

Constructor Detail

CAF.Output

CAF.Output()

registerDefaultHideEffect

<static> void registerDefaultHideEffect(id, effect, options)

Registers a scriptaculous effect to use to hide an element.

Parameters:
id - Element client-side id.
effect - String effect name (ex 'Effect.Fade').
options - (optional) Scriptaculous effect options.

registerDefaultShowEffect

<static> void registerDefaultShowEffect(id, effect, options)

Registers a scriptaculous effect to use to show an element.

Parameters:
id - Element client-side id.
effect - String effect name (ex 'Effect.Appear').
options - (optional) Scriptaculous effect options.

registerHideEffect

<static> void registerHideEffect(id, fn)

Registers an effect function to use to hide an element. Function takes two arguments:
1. element dom object
2. fn (optional) if provided, this fn must be called when element is hidden. it takes a single CAF.Output.argument = the;original element dom object

Parameters:
id - Element client-side id.
fn - Function that hides the element.

registerShowEffect

<static> void registerShowEffect(id, fn)

Registers an effect function to use to show an element. Function takes two arguments:
1. element dom object
2. fn (optional) if provided, this fn must be called when element is shown. it takes a single CAF.Output.argument = the;original element dom object

Parameters:
id - Element client-side id.
fn - Function that shows the element.