class UIkitViewsPluginStyleAccordion in UIkit Components 7.3
Same name and namespace in other branches
- 7.2 uikit_views/plugins/UIkitViewsPluginStyleAccordion.inc \UIkitViewsPluginStyleAccordion
Style plugin to render each item in UIkit accordion.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_style
- class \views_plugin
Expanded class hierarchy of UIkitViewsPluginStyleAccordion
1 string reference to 'UIkitViewsPluginStyleAccordion'
- uikit_views_views_plugins in uikit_views/
uikit_views.views.inc - Implements hook_views_plugins().
File
- uikit_views/
plugins/ UIkitViewsPluginStyleAccordion.inc, line 13 - Contains the accordion style plugin.
View source
class UIkitViewsPluginStyleAccordion extends views_plugin_style {
/**
* Set default options
*/
function option_definition() {
$options = parent::option_definition();
$options['title_field'] = array(
'default' => NULL,
);
$options['targets'] = array(
'default' => '> *',
);
$options['active'] = array(
'default' => 0,
);
$options['collapsible'] = array(
'default' => TRUE,
);
$options['multiple'] = array(
'default' => FALSE,
);
$options['animation'] = array(
'default' => TRUE,
);
$options['transition'] = array(
'default' => 'ease',
);
$options['duration'] = array(
'default' => 200,
);
return $options;
}
/**
* Render the given style.
*/
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
if (isset($form['grouping'])) {
$title_field_options = array();
foreach (element_children($form['grouping']) as $key => $value) {
if (!empty($form['grouping'][$key]['field']['#options']) && is_array($form['grouping'][$key]['field']['#options'])) {
$title_field_options = array_merge($title_field_options, $form['grouping'][$key]['field']['#options']);
}
}
$form['title_field'] = array(
'#type' => 'select',
'#title' => t('Title field'),
'#options' => $title_field_options,
'#required' => TRUE,
'#default_value' => $this->options['title_field'],
'#description' => t('Select the field to use as the accordian title to create a toggle for the accordion items.'),
);
$form['targets'] = array(
'#type' => 'textfield',
'#title' => t('CSS selector of the element(s) to toggle.'),
'#default_value' => $this->options['targets'],
);
$form['active'] = array(
'#type' => 'numberfield',
'#title' => t('Index of the element to open initially.'),
'#default_value' => $this->options['active'],
);
$form['collapsible'] = array(
'#type' => 'checkbox',
'#title' => t('Allow all items to be closed.'),
'#default_value' => $this->options['collapsible'],
);
$form['multiple'] = array(
'#type' => 'checkbox',
'#title' => t('Allow multiple open items.'),
'#default_value' => $this->options['multiple'],
);
$form['animation'] = array(
'#type' => 'checkbox',
'#title' => t('Reveal item directly (unchecked) or with a transition (checked).'),
'#default_value' => $this->options['animation'],
);
$form['transition'] = array(
'#type' => 'select',
'#title' => t('The transition to use when revealing items.'),
'#required' => TRUE,
'#default_value' => $this->options['transition'],
'#description' => t('Uses a keyword from <a href="@transition" target="_blank">easing functions</a>.', array(
'@transition' => 'https://developer.mozilla.org/en-US/docs/Web/CSS/single-transition-timing-function#Keywords_for_common_timing-functions',
)),
'#options' => array(
'linear' => 'linear',
'ease' => 'ease',
'ease-in' => 'ease-in',
'ease-in-out' => 'ease-in-out',
'ease-out' => 'ease-out',
'step-start' => 'step-start',
'step-end' => 'step-end',
),
);
$form['duration'] = array(
'#type' => 'numberfield',
'#title' => t('Animation duration in milliseconds.'),
'#default_value' => $this->options['duration'],
);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
UIkitViewsPluginStyleAccordion:: |
function |
Render the given style. Overrides views_plugin_style:: |
||
UIkitViewsPluginStyleAccordion:: |
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:: |