class ColorFieldWidgetGrid in Color Field 8.2
Plugin implementation of the 'color_field_default' widget.
Plugin annotation
@FieldWidget(
id = "color_field_widget_grid",
module = "color_field",
label = @Translation("Color grid"),
field_types = {
"color_field_type"
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\color_field\Plugin\Field\FieldWidget\ColorFieldWidgetBase
- class \Drupal\color_field\Plugin\Field\FieldWidget\ColorFieldWidgetGrid
- class \Drupal\color_field\Plugin\Field\FieldWidget\ColorFieldWidgetBase
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ColorFieldWidgetGrid
File
- src/
Plugin/ Field/ FieldWidget/ ColorFieldWidgetGrid.php, line 20
Namespace
Drupal\color_field\Plugin\Field\FieldWidgetView source
class ColorFieldWidgetGrid extends ColorFieldWidgetBase {
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'cell_width' => 10,
'cell_height' => 10,
'cell_margin' => 1,
'box_width' => 115,
'box_height' => 20,
'columns' => 16,
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element = [];
$element['cell_width'] = [
'#type' => 'textfield',
'#title' => $this
->t('Cell width'),
'#default_value' => $this
->getSetting('cell_width'),
'#required' => TRUE,
'#description' => $this
->t('Width of each individual color cell.'),
];
$element['cell_height'] = [
'#type' => 'textfield',
'#title' => $this
->t('Height width'),
'#default_value' => $this
->getSetting('cell_height'),
'#required' => TRUE,
'#description' => $this
->t('Height of each individual color cell.'),
];
$element['cell_margin'] = [
'#type' => 'textfield',
'#title' => $this
->t('Cell margin'),
'#default_value' => $this
->getSetting('cell_margin'),
'#required' => TRUE,
'#description' => $this
->t('Margin of each individual color cell.'),
];
$element['box_width'] = [
'#type' => 'textfield',
'#title' => $this
->t('Box width'),
'#default_value' => $this
->getSetting('box_width'),
'#required' => TRUE,
'#description' => $this
->t('Width of the color display box.'),
];
$element['box_height'] = [
'#type' => 'textfield',
'#title' => $this
->t('Box height'),
'#default_value' => $this
->getSetting('box_height'),
'#required' => TRUE,
'#description' => $this
->t('Height of the color display box.'),
];
$element['columns'] = [
'#type' => 'textfield',
'#title' => $this
->t('Columns number'),
'#default_value' => $this
->getSetting('columns'),
'#required' => TRUE,
'#description' => $this
->t('Number of columns to display. Color order may look strange if this is altered.'),
];
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = [];
$cell_width = $this
->getSetting('cell_width');
$cell_height = $this
->getSetting('cell_height');
$cell_margin = $this
->getSetting('cell_margin');
$box_width = $this
->getSetting('box_width');
$box_height = $this
->getSetting('box_height');
$columns = $this
->getSetting('columns');
if (!empty($cell_width)) {
$summary[] = $this
->t('Cell width: @cell_width', [
'@cell_width' => $cell_width,
]);
}
if (!empty($cell_height)) {
$summary[] = $this
->t('Cell height: @cell_height', [
'@cell_height' => $cell_height,
]);
}
if (!empty($cell_margin)) {
$summary[] = $this
->t('Cell margin: @cell_margin', [
'@cell_margin' => $cell_margin,
]);
}
if (!empty($box_width)) {
$summary[] = $this
->t('Box width: @box_width', [
'@box_width' => $box_width,
]);
}
if (!empty($box_height)) {
$summary[] = $this
->t('Box height: @box_height', [
'@box_height' => $box_height,
]);
}
if (!empty($columns)) {
$summary[] = $this
->t('Columns: @columns', [
'@columns' => $columns,
]);
}
if (empty($summary)) {
$summary[] = $this
->t('No placeholder');
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$element = parent::formElement($items, $delta, $element, $form, $form_state);
// We are nesting some sub-elements inside the parent, so we need a wrapper.
// We also need to add another #title attribute at the top level for ease in
// identifying this item in error messages. We do not want to display this
// title because the actual title display is handled at a higher level by
// the Field module.
// $element['#theme_wrappers'] = array('color_field_widget_grid');.
$element['#attached']['library'][] = 'color_field/color-field-widget-grid';
// Set Drupal settings.
$settings = $this
->getSettings();
$element['#attached']['drupalSettings']['color_field']['color_field_widget_grid'][$element['#uid']] = $settings;
$element['color']['#attributes']['class'][] = 'js-color-field-widget-grid__color';
$element['color']['#attributes']['id'] = $element['#uid'];
$element['color']['#wrapper_attributes']['class'][] = 'clearfix';
return $element;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AllowedTagsXssTrait:: |
public | function | Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss(). | |
AllowedTagsXssTrait:: |
public | function | Returns a human-readable list of allowed tags for display in help texts. | |
AllowedTagsXssTrait:: |
public | function | Filters an HTML string to prevent XSS vulnerabilities. | |
ColorFieldWidgetGrid:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
ColorFieldWidgetGrid:: |
public | function |
Returns the form for a single field widget. Overrides ColorFieldWidgetBase:: |
|
ColorFieldWidgetGrid:: |
public | function |
Returns a form to configure settings for the widget. Overrides WidgetBase:: |
|
ColorFieldWidgetGrid:: |
public | function |
Returns a short summary for the current widget settings. Overrides WidgetBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
WidgetBase:: |
protected | property | The field definition. | |
WidgetBase:: |
protected | property |
The widget settings. Overrides PluginSettingsBase:: |
|
WidgetBase:: |
public static | function | Ajax callback for the "Add another item" button. | |
WidgetBase:: |
public static | function | Submission handler for the "Add another item" button. | |
WidgetBase:: |
public static | function | After-build handler for field elements in a form. | |
WidgetBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
5 |
WidgetBase:: |
public | function |
Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface:: |
8 |
WidgetBase:: |
public | function |
Extracts field values from submitted form values. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Creates a form element for a field. Overrides WidgetBaseInterface:: |
3 |
WidgetBase:: |
protected | function | Special handling to create form elements for multiple values. | 1 |
WidgetBase:: |
protected | function | Generates the form element for a single copy of the widget. | |
WidgetBase:: |
protected | function | Returns the value of a field setting. | |
WidgetBase:: |
protected | function | Returns the array of field settings. | |
WidgetBase:: |
protected | function | Returns the filtered field description. | |
WidgetBase:: |
public static | function |
Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
protected static | function | Returns the location of processing information within $form_state. | |
WidgetBase:: |
protected | function | Returns whether the widget handles multiple values. | |
WidgetBase:: |
public static | function |
Returns if the widget can be used for the provided field. Overrides WidgetInterface:: |
4 |
WidgetBase:: |
protected | function | Returns whether the widget used for default value form. | |
WidgetBase:: |
public | function |
Massages the form values into the format expected for field values. Overrides WidgetInterface:: |
7 |
WidgetBase:: |
public static | function |
Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
public | function |
Constructs a WidgetBase object. Overrides PluginBase:: |
5 |