Newer
Older
Nate Lampton
committed
<?php
// $Id$
/**
* @file
* Contains the jCarousel style plugin.
*/
/**
* Style plugin to render each item in an ordered or unordered list.
*
* @ingroup views_style_plugins
*/
class jcarousel_style_plugin extends views_plugin_style {
function option_definition() {
$options = parent::option_definition();
$options['wrap'] = array('default' => NULL);
$options['skin'] = array('default' => 'default');
$options['visible'] = array('default' => NULL);
$options['scroll'] = array('default' => '');
$options['auto'] = array('default' => 0);
$options['autoPause'] = array('default' => '1');
Nate Lampton
committed
$options['animation'] = array('default' => '');
Nate Lampton
committed
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
$options['start'] = array('default' => '1');
$options['easing'] = array('default' => NULL);
$options['vertical'] = array('default' => FALSE);
return $options;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
// Build the list of skins as options.
$skins = array();
foreach (jcarousel_skins() as $key => $skin) {
$skins[$key] = $skin['title'];
}
$skins[''] = t('None');
// Number of options to provide in count-based options.
$range = drupal_map_assoc(range(1, 10));
$auto_range = array('' => t('Auto')) + $range;
$form['description'] = array(
'#type' => 'markup',
'#value' => '<div class="messages">' . t('The jCarousel style is affected by several other settings within the display. Enable the "Use AJAX" option on your display to have items loaded dynamically. The "Items to display" option will determine how many items are preloaded into the carousel on each AJAX request. Non-AJAX carousels will contain the total number of items set in the "Items to display" option. Carousels may not be used with the "Use pager" option.') . '</div>',
);
$form['wrap'] = array(
'#type' => 'select',
'#title' => t('Wrap content'),
'#default_value' => $this->options['wrap'],
'#description' => t('Specifies whether to wrap at the first/last item (or both) and jump back to the start/end.'),
'#options' => array(
0 => t('Disabled'),
'circular' => t('Circular'),
'both' => t('Both'),
'last' => t('Last'),
'first' => t('First'),
),
);
$form['skin'] = array(
'#type' => 'select',
'#title' => t('Skin'),
'#default_value' => $this->options['skin'],
'#options' => $skins,
'#description' => t('Skins may be provided by other modules. Set to "None" if your theme includes carousel theming directly in style.css or another stylesheet.'),
);
$form['visible'] = array(
'#type' => 'select',
'#title' => t('Number of visible items'),
'#options' => $auto_range,
'#default_value' => $this->options['visible'],
'#description' => t('Set an exact number of items to show at a time. It is recommended to leave set this to "auto", in which the number of items will be determined automatically by the space available to the carousel.') . ' <strong>' . t('Changing this option will override "width" properties set in your CSS.') . '</strong>',
);
$form['scroll'] = array(
'#type' => 'select',
'#title' => t('Scroll'),
'#description' => t('The number of items to scroll at a time. The "auto" setting scrolls all the visible items.'),
'#options' => $auto_range,
'#default_value' => $this->options['scroll'],
);
$form['auto'] = array(
'#type' => 'textfield',
'#title' => t('Auto-scroll after'),
'#size' => 4,
'#maxlength' => 4,
'#default_value' => $this->options['auto'],
'#field_suffix' => ' ' . t('seconds'),
'#description' => t('Specifies how many seconds to periodically auto-scroll the content. If set to 0 (default) then autoscrolling is turned off.'),
);
$form['advanced'] = array(
'#type' => 'fieldset',
'#title' => t('Advanced'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#parents' => array('style_options'),
);
Nate Lampton
committed
$form['advanced']['animation'] = array(
'#type' => 'textfield',
'#title' => t('Animation speed'),
'#size' => 10,
'#maxlength' => 10,
'#default_value' => $this->options['animation'],
'#description' => t('The speed of the scroll animation as string in jQuery terms ("slow" or "fast") or milliseconds as integer (See <a href="http://api.jquery.com/animate/">jQuery Documentation</a>).'),
Nate Lampton
committed
);
$form['advanced']['easing'] = array(
'#type' => 'textfield',
'#title' => t('Easing effect'),
'#size' => 10,
'#maxlength' => 10,
'#default_value' => $this->options['easing'],
'#description' => t('The name of the easing effect that you want to use such as "swing" (the default) or "linear". See list of options in the <a href="http://api.jquery.com/animate/">jQuery Documentation</a>.'),
);
Nate Lampton
committed
$form['advanced']['start'] = array(
'#type' => 'select',
'#title' => t('Start position'),
'#description' => t('The item that will be shown as the first item in the list upon loading. Useful for starting a list in the middle of a set.') . $ajax_warning,
'#options' => $range,
'#default_value' => $this->options['start'],
);
$form['advanced']['autoPause'] = array(
'#type' => 'checkbox',
'#title' => t('Pause auto-scroll on hover'),
'#description' => t('If auto-scrolling, pause the carousel when the user hovers the mouse over an item.'),
'#default_value' => $this->options['autoPause'],
);
Nate Lampton
committed
$form['advanced']['vertical'] = array(
'#type' => 'checkbox',
'#title' => t('Vertical'),
'#description' => t('Specifies wether the carousel appears in horizontal or vertical orientation. Changes the carousel from a left/right style to a up/down style carousel. Defaults to horizontal.'),
'#default_value' => $this->options['vertical'],
);
}
function validate() {
$errors = parent::validate();
if ($this->display->handler->use_pager()) {
$errors[] = t('The jCarousel style cannot be used with a pager. Disable the "Use pager" option for this display.');
}
return $errors;
}
}