class views_plugin_style_grid

  1. 3.x plugins/views_plugin_style_grid.inc views_plugin_style_grid
  2. 2.x plugins/views_plugin_style_grid.inc views_plugin_style_grid

Style plugin to render each item in a grid cell.

Hierarchy

Expanded class hierarchy of views_plugin_style_grid

Related topics

Views style plugins
Style plugins control how a view is rendered. For example, they can choose to display a collection of fields, node_view() output, table output, or any kind of crazy output they want.
1 string reference to 'views_plugin_style_grid'
views_views_plugins in includes/plugins.inc
Implements hook_views_plugins().

File

plugins/views_plugin_style_grid.inc, line 13
Contains the grid style plugin.

View source
class views_plugin_style_grid extends views_plugin_style {
  /**
   * Set default options
   */
  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.
   */
  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'],
    );
  }
}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
views_object::construct function Views handlers use a special construct function so that we can more easily construct them with variable arguments.
views_object::export_option function
views_object::export_options function
views_object::export_option_always function Always exports the option, regardless of the default value.
views_object::options Deprecated function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::set_default_options function Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::options_submit function Handle any special handling on the validate form.
views_plugin::plugin_title function Return the human readable name of the display.
views_plugin::summary_title function Returns the summary of the settings in the display.
views_plugin::theme_functions function Provide a full list of possible theme templates used by this style.
views_plugin_style::build_sort 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.
views_plugin_style::build_sort_post 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.
views_plugin_style::destroy function Overrides views_object::destroy
views_plugin_style::even_empty function Should the output of the style plugin be rendered even if it's a empty view.
views_plugin_style::get_field function Get a rendered field.
views_plugin_style::get_field_value function Get the raw field value.
views_plugin_style::get_row_class function Return the token replaced row class for the specified row.
views_plugin_style::init function Initialize a style plugin.
views_plugin_style::options_validate function Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::pre_render function Allow the style to do stuff before each row is rendered.
views_plugin_style::query function Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_style::render function Render the display in this style.
views_plugin_style::render_fields function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping function Group records as needed for rendering.
views_plugin_style::render_grouping_sets function Render the grouping sets.
views_plugin_style::tokenize_value function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens function Return TRUE if this style uses tokens.
views_plugin_style::validate function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate
views_plugin_style_grid::options_form function Render the given style. Overrides views_plugin_style::options_form
views_plugin_style_grid::option_definition function Set default options Overrides views_plugin_style::option_definition