Interface ImageSwitchCfg

Class name used for the active pager link

Transition callback (this context set to element that was shown)

Allows or prevents click event on pager anchors from bubbling

An object of CSS properties and values that the animation will move toward. Properties that define how the slide animates in.

An object of CSS properties and values that the animation will move toward. Properties that define how the slide animates out

A number other than 0 to end slideshow after X transitions (where X == slide count)

Number of transitions (optionally used with autostop to define X)

true to start slideshow at last slide and move backwards through the stack

Transition callback (this context set to element to be shown)

A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.

true if clearType corrections should be applied (for IE)

Set to true to disable extra cleartype fixing (leave false to force background color setting on slides)

Resize container to fit largest slide

true to start next transition immediately after current one completes

Properties that defined the state of the slide after transitioning out

Properties that define the initial state of the slide before transitioning in

Additional delay (in ms) for first transition (hint: can be negative)

Easing for "in" transition

Easing for "out" transition

Easing method for both in and out transitions

Callback invoked when the slideshow terminates (use with autostop or nowrap options)

Force fast transitions when triggered manually (via pager or prev/next); value == time in ms

Force slides to fit container

ID of the form to use for AJAX requests.

Name of transition effect (or comma separated names, ex: 'fade,scrollUp,shuffle')

Function used to control the transition

Container height (if the 'fit' option is true, the slides will be set to this height as well)

The client-side ID of the widget, with all parent naming containers, such as myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs multiple container elements (such as Paginator), this may also be an array if IDs.

Causes manual transition to stop an active transition instead of being ignored

Data attribute that holds the option data for the slideshow

Selector for element to use as event trigger for next slide

true to prevent slideshow from wrapping

Callback fn for pager events

Callback fn for prev/next events

Selector for element to use as pager container

Name of event which drives the pager navigation

true to enable "pause on hover"

true to pause when hovering over pager link

An optional callback that is invoked after this widget was created successfully, at the end of the init method. This is usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called during a refresh (AJAX update).

An optional callback that is invoked after this widget was refreshed after an AJAX update, at the end of the refresh method. This is usually specified via the widgetPostRefresh attribute on the JSF component.

An optional callback that is invoked before this widget is about to be destroyed, e.g. when the component was removed at the end of an AJAX update. This is called at the beginning of the destroy method. This is usually specified via the widgetPreDestroy attribute on the JSF component.

Selector for element to use as event trigger for previous slide

Event which drives the manual transition to the previous or next slide

true for random, false for sequence (not applicable to shuffle fx)

Valid when multiple effects are used; true to make the effect sequence random

Requeue the slideshow if any image slides are not yet loaded

Delay in milliseconds for requeue.

Causes animations to transition in reverse (for effects that support it such as scrollHorz/scrollVert/shuffle)

Coordinates for shuffle animation, ex: { top:15, left: 200 }

CSS selector for selecting slides (if something other than all children is required)

Force slide width/height to fixed size before every transition

Speed of the transition in milliseconds (any valid fx speed value)

Speed of the 'in' transition in milliseconds

Speed of the 'out' transition in milliseconds

Zero-based index of the first slide to be displayed

true if in/out transitions should occur simultaneously

Milliseconds between slide transitions (0 to disable auto advance)

Callback for determining per-slide timeout value

Callback fn invoked to update the active pager link (adds/removes activePagerClass style)

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF("myWidgetVar").

Container width (if the 'fit' option is true, the slides will be set to this width as well)