class Fill in Openlayers 8.4
Defines the Fill style for Openlayers features.
Plugin annotation
@OpenlayersStyle(
id = "ol_style_fill",
label = @Translation("Fill"),
description = @Translation("Define the fill style for map features."),
type = "style",
ol_id = "Fill"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\openlayers\OpenlayersPluginBase implements ContainerFactoryPluginInterface, OpenlayersPluginInterface
- class \Drupal\openlayers\OpenlayersConfigurablePluginBase implements OpenlayersConfigurablePluginInterface
- class \Drupal\openlayers\Plugin\OpenlayersStyle\Fill
- class \Drupal\openlayers\OpenlayersConfigurablePluginBase implements OpenlayersConfigurablePluginInterface
- class \Drupal\openlayers\OpenlayersPluginBase implements ContainerFactoryPluginInterface, OpenlayersPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Fill
1 string reference to 'Fill'
- openlayers.style.ol_style_fill.yml in config/
install/ openlayers.style.ol_style_fill.yml - config/install/openlayers.style.ol_style_fill.yml
File
- src/
Plugin/ OpenlayersStyle/ Fill.php, line 21
Namespace
Drupal\openlayers\Plugin\OpenlayersStyleView source
class Fill extends OpenlayersConfigurablePluginBase {
/**
* {@inheritdoc}
*/
public function getSummary() {
$summary = [
'#theme' => 'openlayers_style_summary',
'#data' => $this->configuration,
];
$summary += parent::getSummary();
return $summary;
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
'color' => NULL,
];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form['color'] = [
'#type' => 'textfield',
'#default_value' => $this->configuration['color'],
'#title' => t('Fill color'),
// TODO - improve description to recognise other valid color formats.
'#description' => t('The color to be used for filling polygon features on the map. Use web-style hex colors (#FFFFFF for white, #000000 for black).'),
'#size' => 20,
'#maxlength' => 20,
'#required' => FALSE,
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
/*
if (!$form_state->isValueEmpty('color') && !Color::validateHex($form_state->getValue('color'))) {
$form_state->setErrorByName('color', $this->t('Color must be a hexadecimal color value.'));
}
*/
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
parent::submitConfigurationForm($form, $form_state);
$this->configuration['color'] = $form_state
->getValue('color');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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 | |
Fill:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
|
Fill:: |
public | function |
Gets default configuration for this plugin. Overrides OpenlayersPluginBase:: |
|
Fill:: |
public | function |
Returns a render array summarizing the configuration of the image effect. Overrides OpenlayersPluginBase:: |
|
Fill:: |
public | function |
Form submission handler. Overrides OpenlayersConfigurablePluginBase:: |
|
Fill:: |
public | function |
Form validation handler. Overrides OpenlayersConfigurablePluginBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
OpenlayersPluginBase:: |
protected | property | A logger instance. | |
OpenlayersPluginBase:: |
protected | property | The image effect ID. | |
OpenlayersPluginBase:: |
protected | property | The weight of the image effect. | |
OpenlayersPluginBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
OpenlayersPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
OpenlayersPluginBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
OpenlayersPluginBase:: |
public | function |
Returns the extension of the derivative after applying this image effect. Overrides OpenlayersPluginInterface:: |
|
OpenlayersPluginBase:: |
public | function |
Returns the unique ID representing the image effect. Overrides OpenlayersPluginInterface:: |
|
OpenlayersPluginBase:: |
public | function |
Returns the weight of the image effect. Overrides OpenlayersPluginInterface:: |
|
OpenlayersPluginBase:: |
public | function |
Returns the image effect label. Overrides OpenlayersPluginInterface:: |
|
OpenlayersPluginBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
OpenlayersPluginBase:: |
public | function |
Sets the weight for this image effect. Overrides OpenlayersPluginInterface:: |
|
OpenlayersPluginBase:: |
public | function |
Determines the dimensions of the styled image. Overrides OpenlayersPluginInterface:: |
|
OpenlayersPluginBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
|
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. | |
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. |