You are here

Home » API reference » Views Ticker 7 » views_ticker_style_plugin.inc

class views_ticker_style_plugin in Views Ticker 7

Same name and namespace in other branches
  1. 6.2 includes/views_ticker_style_plugin.inc \views_ticker_style_plugin
  2. 7.2 includes/views_ticker_style_plugin.inc \views_ticker_style_plugin

Style plugin to render each item in an ordered or unordered list.

Hierarchy

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['hscroller_Options']['default'] = array(
      'hscroller_speed' => 30,
      'hscroller_direction' => 'left',
      'hscroller_mouseover' => 0,
      'hscroller_delay' => 0,
      'hscroller_bounce' => 0,
    );
    $options['vscroller_Options']['default'] = array(
      'vscroller_speed' => 30,
      'vscroller_direction' => 'up',
      'vscroller_mouseover' => 0,
      'vscroller_delay' => 0,
      'vscroller_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'),
        'vertical' => t('Vertical'),
        'fade' => t('Fade'),
        'bbc' => t('BBC'),
        'vTicker' => t('vTicker'),
      ),
    );

    //####### horizontal Options ########

    // horizontal
    $form['hscroller_Options'] = array(
      '#type' => 'fieldset',
      '#title' => t('Horizontal Options'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $form['hscroller_Options']['hscroller_speed'] = array(
      '#type' => 'select',
      '#title' => t('Horizontal scroller speed'),
      '#description' => t(''),
      '#default_value' => $this->options['hscroller_Options']['hscroller_speed'],
      '#options' => array(
        '10' => t('Very slow'),
        '20' => t('Slow'),
        '30' => t('Normal'),
        '40' => t('Fast'),
        '50' => t('Very fast'),
      ),
    );
    $form['hscroller_Options']['hscroller_direction'] = array(
      '#type' => 'select',
      '#title' => t('Horizontal scroller direction'),
      '#description' => t(''),
      '#default_value' => $this->options['hscroller_Options']['hscroller_direction'],
      '#options' => array(
        'left' => t('Left'),
        'right' => t('Right'),
      ),
    );
    $form['hscroller_Options']['hscroller_delay'] = array(
      '#type' => 'select',
      '#title' => t('Horizontal scroller delay'),
      '#description' => t(''),
      '#default_value' => $this->options['hscroller_Options']['hscroller_delay'],
      '#options' => array(
        '0' => t('None'),
        '1' => t('One second'),
        '2' => t('Two seconds'),
        '3' => t('Three seconds'),
        '4' => t('Four seconds'),
        '5' => t('Five seconds'),
        '10' => t('Ten seconds'),
      ),
    );
    $form['hscroller_Options']['hscroller_mouseover'] = array(
      '#type' => 'checkbox',
      '#title' => t('Horizontal scroller mouseover'),
      '#description' => t(''),
      '#default_value' => $this->options['hscroller_Options']['hscroller_mouseover'],
    );
    $form['hscroller_Options']['hscroller_bounce'] = array(
      '#type' => 'checkbox',
      '#title' => t('Horizontal scroller bounce'),
      '#description' => t(''),
      '#default_value' => $this->options['hscroller_Options']['hscroller_bounce'],
    );

    //####### vertical Options ########

    // vertical
    $form['vscroller_Options'] = array(
      '#type' => 'fieldset',
      '#title' => t('Vertical Options'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $form['vscroller_Options']['vscroller_speed'] = array(
      '#type' => 'select',
      '#title' => t('Vertical scroller speed'),
      '#description' => t(''),
      '#default_value' => $this->options['vscroller_Options']['vscroller_speed'],
      '#options' => array(
        '10' => t('Very slow'),
        '20' => t('Slow'),
        '30' => t('Normal'),
        '40' => t('Fast'),
        '50' => t('Very fast'),
      ),
    );
    $form['vscroller_Options']['vscroller_direction'] = array(
      '#type' => 'select',
      '#title' => t('Vertical scroller direction'),
      '#description' => t(''),
      '#default_value' => $this->options['vscroller_Options']['vscroller_direction'],
      '#options' => array(
        'up' => t('Up'),
        'down' => t('Down'),
      ),
    );
    $form['vscroller_Options']['vscroller_delay'] = array(
      '#type' => 'select',
      '#title' => t('Vertical scroller delay'),
      '#description' => t(''),
      '#default_value' => $this->options['vscroller_Options']['vscroller_delay'],
      '#options' => array(
        '0' => t('None'),
        '1' => t('One second'),
        '2' => t('Two seconds'),
        '3' => t('Three seconds'),
        '4' => t('Four seconds'),
        '5' => t('Five seconds'),
        '10' => t('Ten seconds'),
      ),
    );
    $form['vscroller_Options']['vscroller_mouseover'] = array(
      '#type' => 'checkbox',
      '#title' => t('Vertical scroller mouseover'),
      '#description' => t(''),
      '#default_value' => $this->options['vscroller_Options']['vscroller_mouseover'],
    );
    $form['vscroller_Options']['vscroller_bounce'] = array(
      '#type' => 'checkbox',
      '#title' => t('Vertical scroller bounce'),
      '#description' => t(''),
      '#default_value' => $this->options['vscroller_Options']['vscroller_bounce'],
    );

    //####### vTicker Options ########
    $form['vTicker_Options'] = array(
      '#type' => 'fieldset',
      '#title' => t('vTicker Options'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $form['vTicker_Options']['vTicker_items'] = array(
      '#type' => 'textfield',
      '#title' => t('vTicker 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('vTicker scroller mouseover'),
      '#description' => t(''),
      '#default_value' => $this->options['vTicker_Options']['vTicker_mouseover'],
    );
    $form['vTicker_Options']['vTicker_pause'] = array(
      '#type' => 'select',
      '#title' => t('vTicker 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('vTicker 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('vTicker 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

Namesort descending Modifiers Type Description Overrides
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::options_submit public function Handle any special handling on the validate form. 9
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin public property The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens public property Store all available tokens row rows.
views_plugin_style::build_sort 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::build_sort_post 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::destroy public function Destructor. Overrides views_object::destroy
views_plugin_style::even_empty public function Should the output of the style plugin be rendered even if it's empty. 1
views_plugin_style::get_field public function Get a rendered field.
views_plugin_style::get_field_value public function Get the raw field value.
views_plugin_style::get_row_class public function Return the token replaced row class for the specified row.
views_plugin_style::init public function Initialize a style plugin.
views_plugin_style::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::pre_render public function Allow the style to do stuff before each row is rendered.
views_plugin_style::query public function Add anything to the query that we might need to. Overrides views_plugin::query 2
views_plugin_style::render public function Render the display in this style. 5
views_plugin_style::render_fields public function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping public function Group records as needed for rendering.
views_plugin_style::render_grouping_sets public function Render the grouping sets.
views_plugin_style::tokenize_value public function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields public function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens public function Return TRUE if this style uses tokens.
views_ticker_style_plugin::options_form function Provide a form to edit options for this plugin. Overrides views_plugin_style::options_form
views_ticker_style_plugin::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition
views_ticker_style_plugin::validate function Validate that the plugin is correct and can be saved. Overrides views_plugin_style::validate