You are here

Home » API reference » Views Horizontal Slider 7 » views_horizontal_slider_style_plugin.inc

class views_horizontal_slider_style_plugin in Views Horizontal Slider 7

@file Views settings, output and data validation

Hierarchy

Expanded class hierarchy of views_horizontal_slider_style_plugin

1 string reference to 'views_horizontal_slider_style_plugin'
views_horizontal_slider_views_plugins in ./views_horizontal_slider.views.inc

File

./views_horizontal_slider_style_plugin.inc, line 10
Views settings, output and data validation

View source 
class views_horizontal_slider_style_plugin extends views_plugin_style {

  //default options
  function option_definition() {
    $options = parent::option_definition();
    $options['animate_in'] = array(
      'default' => 400,
    );
    $options['animate_out'] = array(
      'default' => 400,
    );
    $options['min_width'] = array(
      'default' => 100,
    );
    $options['max_width'] = array(
      'default' => 300,
    );
    $options['activated_item'] = array(
      'default' => 2,
    );
    $options['caption_field_name'] = array(
      'default' => '',
    );
    $options['caption_field_fadein'] = array(
      'default' => 500,
    );
    $options['caption_field_fadeout'] = array(
      'default' => 500,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    unset($form['grouping']);

    //unset($form['type']);
    $form['animate_in'] = array(
      '#type' => 'textfield',
      '#title' => t('Animate In'),
      '#required' => TRUE,
      '#description' => t('Specify the Animation In Speed'),
      '#default_value' => $this->options['animate_in'],
    );
    $form['animate_out'] = array(
      '#type' => 'textfield',
      '#title' => t('Animate Out'),
      '#required' => TRUE,
      '#description' => t('Specify the Animation Out Speed'),
      '#default_value' => $this->options['animate_out'],
    );
    $form['min_width'] = array(
      '#type' => 'textfield',
      '#title' => t('Min Width'),
      '#required' => TRUE,
      '#description' => t('Minimum width of an image/item'),
      '#default_value' => $this->options['min_width'],
    );
    $form['max_width'] = array(
      '#type' => 'textfield',
      '#title' => t('Max Width'),
      '#required' => TRUE,
      '#description' => t('Maximum width of an image/item'),
      '#default_value' => $this->options['max_width'],
    );
    $form['activated_item'] = array(
      '#type' => 'textfield',
      '#title' => t('Active Item'),
      '#required' => FALSE,
      '#description' => t('The item that is active on page load. Start: 1 to the number of images/items you have. '),
      '#default_value' => $this->options['activated_item'],
    );
    $form['caption_field_name'] = array(
      '#type' => 'textfield',
      '#title' => t('Caption field name'),
      '#required' => FALSE,
      '#description' => t('Name of the field that will be used as caption. You only need that if you want to fade in a caption on hover. You can get the field name out of the html code (for "example views-field-title"). Leave empty if not used.'),
      '#default_value' => $this->options['caption_field_name'],
    );
    $form['caption_field_fadein'] = array(
      '#type' => 'textfield',
      '#title' => t('Caption field Fade in speed'),
      '#required' => FALSE,
      '#description' => t('Fade in speed '),
      '#default_value' => $this->options['caption_field_fadein'],
    );
    $form['caption_field_fadeout'] = array(
      '#type' => 'textfield',
      '#title' => t('Caption field Fade out speed'),
      '#required' => FALSE,
      '#description' => t('Fade out speed '),
      '#default_value' => $this->options['caption_field_fadeout'],
    );
  }

  //Validating the inputs

  //@TODO validation

  //seems to be a bug?
  function options_validate(&$form, &$form_state) {
    parent::options_validate($form, $form_state);
    $options =& $form_state['values']['style_options'];
    if (!is_numeric($options['max_width'])) {
      form_error($form['max_width'], t('Please specify a numerical value for Max Width'));
    }
    if (!is_numeric($options['min_width'])) {
      form_error($form['min_width'], t('Please specify a numerical value for Min Width'));
    }
    if (!is_numeric($options['animate_in'])) {
      form_error($form['animate_in'], t('Please specify a numerical value for Animate In'));
    }
    if (!is_numeric($options['animate_out'])) {
      form_error($form['animate_out'], t('Please specify a numerical value for Animate Out'));
    }
    if (!is_numeric($options['activated_item'])) {
      form_error($form['activated_item'], t('Please specify a numerical value for Activated Item'));
    }
    if (!is_numeric($options['caption_field_fadein'])) {
      form_error($form['activated_item'], t('Please specify a numerical value for fade in'));
    }
    if (!is_numeric($options['caption_field_fadeout'])) {
      form_error($form['activated_item'], t('Please specify a numerical value for fade out'));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_horizontal_slider_style_plugin::options_form function Provide a form to edit options for this plugin. Overrides views_plugin_style::options_form
views_horizontal_slider_style_plugin::options_validate function Validate the options form. Overrides views_plugin_style::options_validate
views_horizontal_slider_style_plugin::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition
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::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_plugin_style::validate public function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate