views_plugin_style_grid.inc

Same filename in other branches
  1. 6.x-3.x plugins/views_plugin_style_grid.inc

Definition of views_plugin_style_grid.

File

plugins/views_plugin_style_grid.inc

View source
<?php


/**
 * @file
 * Definition of views_plugin_style_grid.
 */

/**
 * Style plugin to render each item in a grid cell.
 *
 * @ingroup views_style_plugins
 */
class views_plugin_style_grid extends views_plugin_style {
    
    /**
     * Set default options.
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['columns'] = array(
            'default' => '4',
        );
        $options['alignment'] = array(
            'default' => 'horizontal',
        );
        $options['fill_single_line'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        $options['summary'] = array(
            'default' => '',
        );
        $options['caption'] = array(
            'default' => '',
        );
        return $options;
    }
    
    /**
     * Render the given style.
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $form['columns'] = array(
            '#type' => 'textfield',
            '#title' => t('Number of columns'),
            '#default_value' => $this->options['columns'],
            '#required' => TRUE,
            '#element_validate' => array(
                'views_element_validate_integer',
            ),
        );
        $form['alignment'] = array(
            '#type' => 'radios',
            '#title' => t('Alignment'),
            '#options' => array(
                'horizontal' => t('Horizontal'),
                'vertical' => t('Vertical'),
            ),
            '#default_value' => $this->options['alignment'],
            '#description' => t('Horizontal alignment will place items starting in the upper left and moving right. Vertical alignment will place items starting in the upper left and moving down.'),
        );
        $form['fill_single_line'] = array(
            '#type' => 'checkbox',
            '#title' => t('Fill up single line'),
            '#description' => t('If you disable this option, a grid with only one row will have the same number of table cells (<TD>) as items. Disabling it can cause problems with your CSS.'),
            '#default_value' => !empty($this->options['fill_single_line']),
        );
        $form['caption'] = array(
            '#type' => 'textfield',
            '#title' => t('Short description of table'),
            '#description' => t('Include a caption for better accessibility of your table.'),
            '#default_value' => $this->options['caption'],
        );
        $form['summary'] = array(
            '#type' => 'textfield',
            '#title' => t('Table summary'),
            '#description' => t('This value will be displayed as table-summary attribute in the html. Use this to give a summary of complex tables.'),
            '#default_value' => $this->options['summary'],
        );
    }

}

Classes

Title Deprecated Summary
views_plugin_style_grid Style plugin to render each item in a grid cell.