class views_ticker_style_plugin in Views Ticker 7.2
Same name and namespace in other branches
- 6.2 includes/views_ticker_style_plugin.inc \views_ticker_style_plugin
- 7 includes/views_ticker_style_plugin.inc \views_ticker_style_plugin
Style plugin to render each item in an ordered or unordered list.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_style
- class \views_ticker_style_plugin
- class \views_plugin_style
- class \views_plugin
Expanded class hierarchy of views_ticker_style_plugin
1 string reference to 'views_ticker_style_plugin'
- views_ticker_views_plugins in includes/
views_ticker.views.inc - Implements hook_views_plugin().
File
- includes/
views_ticker_style_plugin.inc, line 13 - Contains the views ticker style plugin.
View source
class views_ticker_style_plugin extends views_plugin_style {
function option_definition() {
$options = parent::option_definition();
$options['scroller_type'] = array(
'default' => 'horizontal',
);
$options['liScroll_Options']['default'] = array(
'liScroll_speed' => '0.07',
'liScroll_direction' => 'left',
'liScroll_mouseover' => 0,
'liScroll_delay' => 0,
'liScroll_bounce' => 0,
);
$options['vTicker_Options']['default'] = array(
'vTicker_mouseover' => 0,
'vTicker_speed' => 500,
'vTicker_pause' => 1000,
'vTicker_items' => 5,
'vTicker_direction' => 'up',
);
return $options;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['scroller_type'] = array(
'#type' => 'select',
'#title' => t('Scroller type'),
'#description' => t(''),
'#default_value' => $this->options['scroller_type'],
'#options' => array(
'horizontal' => t('Horizontal'),
#liScroll
'vertical' => t('Vertical'),
#vTicker
'fade' => t('Fade'),
'bbc' => t('BBC'),
),
);
//####### horizontal Options (liScroll) ########
// horizontal
$form['liScroll_Options'] = array(
'#type' => 'fieldset',
'#title' => t('Horizontal scroller Options'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['liScroll_Options']['liScroll_speed'] = array(
'#type' => 'select',
'#title' => t('Horizontal scroller speed'),
'#description' => t(''),
'#default_value' => $this->options['liScroll_Options']['liScroll_speed'],
'#options' => array(
'0.02' => t('Very slow'),
'0.04' => t('Slow'),
'0.07' => t('Normal'),
'0.10' => t('Fast'),
'0.15' => t('Very fast'),
),
);
$form['liScroll_Options']['liScroll_direction'] = array(
'#type' => 'select',
'#title' => t('Horizontal scroller direction'),
'#description' => t(''),
'#default_value' => $this->options['liScroll_Options']['liScroll_direction'],
'#options' => array(
'left' => t('Left'),
'right' => t('Right'),
),
);
$form['liScroll_Options']['liScroll_mouseover'] = array(
'#type' => 'checkbox',
'#title' => t('Horizontal scroller mouseover'),
'#description' => t(''),
'#default_value' => $this->options['liScroll_Options']['liScroll_mouseover'],
);
//####### vertical Options (vTicker) ########
// vertical
$form['vTicker_Options'] = array(
'#type' => 'fieldset',
'#title' => t('Vertical scroller Options'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['vTicker_Options']['vTicker_items'] = array(
'#type' => 'textfield',
'#title' => t('Number of items'),
'#description' => t('Number of items to display at a time'),
'#default_value' => $this->options['vTicker_Options']['vTicker_items'],
'#element_validate' => array(
'vTicker_numeric_element_validate',
),
);
$form['vTicker_Options']['vTicker_mouseover'] = array(
'#type' => 'checkbox',
'#title' => t('Pause on mouseover'),
'#description' => t(''),
'#default_value' => $this->options['vTicker_Options']['vTicker_mouseover'],
);
$form['vTicker_Options']['vTicker_pause'] = array(
'#type' => 'select',
'#title' => t('Scroller pause'),
'#description' => t(''),
'#default_value' => $this->options['vTicker_Options']['vTicker_pause'],
'#options' => array(
500 => t('500 millisecond'),
1000 => t('One second'),
2000 => t('Two seconds'),
3000 => t('Three seconds'),
4000 => t('Four seconds'),
5000 => t('Five seconds'),
),
);
$form['vTicker_Options']['vTicker_speed'] = array(
'#type' => 'select',
'#title' => t('Scroller speed'),
'#description' => t(''),
'#default_value' => $this->options['vTicker_Options']['vTicker_speed'],
'#options' => array(
1000 => t('Very slow'),
700 => t('Slow'),
500 => t('Normal'),
300 => t('Fast'),
150 => t('Very fast'),
),
);
$form['vTicker_Options']['vTicker_direction'] = array(
'#type' => 'select',
'#title' => t('Scroller direction'),
'#description' => t(''),
'#default_value' => $this->options['vTicker_Options']['vTicker_direction'],
'#options' => array(
'up' => t('Up'),
'down' => t('Down'),
),
);
}
function validate() {
$errors = parent::validate();
if ($this->display->handler
->use_pager()) {
$errors[] = t('The ticker style cannot be used with a pager. Disable the "Use pager" option for this display.');
}
return $errors;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Views handlers use a special construct function. | 4 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function | ||
views_plugin:: |
public | property | The current used views display. | |
views_plugin:: |
public | property | The plugin name of this plugin, for example table or full. | |
views_plugin:: |
public | property | The plugin type of this plugin, for example style or query. | |
views_plugin:: |
public | property |
The top object of a view. Overrides views_object:: |
1 |
views_plugin:: |
public | function | Provide a list of additional theme functions for the theme info page. | |
views_plugin:: |
public | function | Handle any special handling on the validate form. | 9 |
views_plugin:: |
public | function | Return the human readable name of the display. | |
views_plugin:: |
public | function | Returns the summary of the settings in the display. | 8 |
views_plugin:: |
public | function | Provide a full list of possible theme templates used by this style. | |
views_plugin_style:: |
public | property | The row plugin, if it's initialized and the style itself supports it. | |
views_plugin_style:: |
public | property | Store all available tokens row rows. | |
views_plugin_style:: |
public | function | Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. | 1 |
views_plugin_style:: |
public | function | Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. | 1 |
views_plugin_style:: |
public | function |
Destructor. Overrides views_object:: |
|
views_plugin_style:: |
public | function | Should the output of the style plugin be rendered even if it's empty. | 1 |
views_plugin_style:: |
public | function | Get a rendered field. | |
views_plugin_style:: |
public | function | Get the raw field value. | |
views_plugin_style:: |
public | function | Return the token replaced row class for the specified row. | |
views_plugin_style:: |
public | function | Initialize a style plugin. | |
views_plugin_style:: |
public | function |
Validate the options form. Overrides views_plugin:: |
|
views_plugin_style:: |
public | function | Allow the style to do stuff before each row is rendered. | |
views_plugin_style:: |
public | function |
Add anything to the query that we might need to. Overrides views_plugin:: |
2 |
views_plugin_style:: |
public | function | Render the display in this style. | 5 |
views_plugin_style:: |
public | function | Render all of the fields for a given style and store them on the object. | |
views_plugin_style:: |
public | function | Group records as needed for rendering. | |
views_plugin_style:: |
public | function | Render the grouping sets. | |
views_plugin_style:: |
public | function | Take a value and apply token replacement logic to it. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses fields. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses a row plugin. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses a row plugin. | |
views_plugin_style:: |
public | function | Return TRUE if this style uses tokens. | |
views_ticker_style_plugin:: |
function |
Provide a form to edit options for this plugin. Overrides views_plugin_style:: |
||
views_ticker_style_plugin:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_plugin_style:: |
||
views_ticker_style_plugin:: |
function |
Validate that the plugin is correct and can be saved. Overrides views_plugin_style:: |