class views_column_class_style_plugin in Views Column Class 7
@file Demonstrate the actual plugin options.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_style
- class \views_plugin
Expanded class hierarchy of views_column_class_style_plugin
1 string reference to 'views_column_class_style_plugin'
- views_column_class_views_plugins in ./
views_column_class.views.inc - Implements hook_views_plugins().
File
- ./
views_column_class_style_plugin.inc, line 7 - Demonstrate the actual plugin options.
View source
class views_column_class_style_plugin extends views_plugin_style {
/**
* Set default options.
*/
function option_definition() {
$options = parent::option_definition();
$options['type'] = array(
'default' => 'ul',
);
$options['columns'] = array(
'default' => '4',
);
$options['column_class_prefix'] = array(
'default' => 'column-',
);
$options['row_class_prefix'] = array(
'default' => 'row-',
);
$options['offset'] = array(
'default' => '0',
);
$options['column_row_class_prefix'] = array(
'default' => '',
);
$options['class_column_left'] = array(
'default' => 'alpha',
);
$options['class_column_right'] = array(
'default' => 'omega',
);
$options['class'] = array(
'default' => '',
);
$options['wrapper_class'] = array(
'default' => '',
);
$options['advanced_classes'] = array(
'default' => '',
);
return $options;
}
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'],
);
$form['offset'] = array(
'#type' => 'textfield',
'#title' => t('Offset'),
'#description' => t('Set offset so that you can expose a few odd results before the regular columns kick in.'),
'#default_value' => $this->options['offset'],
);
$form['column_class_prefix'] = array(
'#type' => 'textfield',
'#description' => t('(e.g. Set to column- to add class column-1, column-2, column-3, column-1 etc to relevant items).'),
'#title' => t('Column class prefix'),
'#default_value' => $this->options['column_class_prefix'],
);
$form['row_class_prefix'] = array(
'#type' => 'textfield',
'#description' => t('(e.g. Set to row- to add class row-1, row-2, row-3 etc to relevant items).'),
'#title' => t('Row class prefix'),
'#default_value' => $this->options['row_class_prefix'],
);
$form['column_row_class_prefix'] = array(
'#type' => 'textfield',
'#description' => t('(e.g. Set to column-{c}-row-{r} to add class column-1-row-1, column-2-row-1, ... column-1-row-2 etc to relevant items).'),
'#title' => t('Column & Row class prefix'),
'#default_value' => $this->options['column_row_class_prefix'],
);
$form['class_column_left'] = array(
'#type' => 'textfield',
'#title' => t('Class for left column'),
'#default_value' => $this->options['class_column_left'],
);
$form['class_column_right'] = array(
'#type' => 'textfield',
'#title' => t('Class for right column'),
'#default_value' => $this->options['class_column_right'],
);
$form['type'] = array(
'#type' => 'radios',
'#title' => t('List type'),
'#options' => array(
'ul' => t('Unordered list'),
'ol' => t('Ordered list'),
),
'#default_value' => $this->options['type'],
);
$form['wrapper_class'] = array(
'#title' => t('Wrapper class'),
'#description' => t('The class to provide on the wrapper, outside the list.'),
'#type' => 'textfield',
'#size' => '30',
'#default_value' => $this->options['wrapper_class'],
);
$form['class'] = array(
'#title' => t('List class'),
'#description' => t('The class to provide on the list element itself.'),
'#type' => 'textfield',
'#size' => '30',
'#default_value' => $this->options['class'],
);
$form['advanced_classes'] = array(
'#title' => t('Advanced classes'),
'#description' => t('Entries one per line and in the format <em>columns|offset|class_column_left|class_column_right|column_class_prefix|row_class_prefix|column_row_class_prefix</em>.'),
'#type' => 'textarea',
'#rows' => 5,
'#default_value' => $this->options['advanced_classes'],
);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_column_class_style_plugin:: |
function |
Provide a form to edit options for this plugin. Overrides views_plugin_style:: |
||
views_column_class_style_plugin:: |
function |
Set default options. Overrides views_plugin_style:: |
||
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_plugin_style:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides views_plugin:: |