You are here

Home » API reference » Openlayers 8.4 » Stroke.php

class Stroke in Openlayers 8.4

Defines the Line style for Openlayers features.

Plugin annotation


@OpenlayersStyle(
  id = "ol_style_stroke",
  label = @Translation("Stroke"),
  description = @Translation("Define the line style for map features."),
  type = "style",
  ol_id = "Stroke"
)

Hierarchy

Expanded class hierarchy of Stroke

File

src/Plugin/OpenlayersStyle/Stroke.php, line 21

Namespace

Drupal\openlayers\Plugin\OpenlayersStyle
View source 
class Stroke extends OpenlayersConfigurablePluginBase {

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $summary = [
      '#theme' => 'openlayers_style_stroke_summary',
      //  TODO - ???
      '#data' => $this->configuration,
    ];
    $summary += parent::getSummary();
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'color' => NULL,
      'lineDash' => NULL,
      'width' => 1,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['color'] = [
      '#type' => 'textfield',
      '#default_value' => $this->configuration['color'],
      '#title' => t('Stroke color'),
      //  TODO - improve description to recognise other valid color formats.
      '#description' => t('The color to be used for line features on the map. Use web-style hex colors (#FFFFFF for white, #000000 for black).'),
      '#size' => 20,
      '#maxlength' => 20,
      '#required' => FALSE,
    ];
    $form['lineDash'] = [
      '#type' => 'number',
      '#default_value' => $this->configuration['lineDash'],
      '#title' => t('Line dash pattern'),
      '#description' => t('The dash pattern to use for line features on the map. Leave blank for no dash.'),
      '#required' => FALSE,
    ];
    $form['width'] = [
      '#type' => 'number',
      '#default_value' => $this->configuration['width'],
      '#title' => t('Stroke width'),
      '#description' => t('The width to be used for line features on the map. Defaults to 1.'),
      '#field_suffix' => 'pixels',
      '#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');
    $this->configuration['lineDash'] = $form_state
      ->getValue('lineDash');
    $this->configuration['width'] = $form_state
      ->getValue('width');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OpenlayersPluginBase::$logger protected property A logger instance.
OpenlayersPluginBase::$uuid protected property The image effect ID.
OpenlayersPluginBase::$weight protected property The weight of the image effect.
OpenlayersPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
OpenlayersPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
OpenlayersPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
OpenlayersPluginBase::getDerivativeExtension public function Returns the extension of the derivative after applying this image effect. Overrides OpenlayersPluginInterface::getDerivativeExtension
OpenlayersPluginBase::getUuid public function Returns the unique ID representing the image effect. Overrides OpenlayersPluginInterface::getUuid
OpenlayersPluginBase::getWeight public function Returns the weight of the image effect. Overrides OpenlayersPluginInterface::getWeight
OpenlayersPluginBase::label public function Returns the image effect label. Overrides OpenlayersPluginInterface::label
OpenlayersPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
OpenlayersPluginBase::setWeight public function Sets the weight for this image effect. Overrides OpenlayersPluginInterface::setWeight
OpenlayersPluginBase::transformDimensions public function Determines the dimensions of the styled image. Overrides OpenlayersPluginInterface::transformDimensions
OpenlayersPluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
Stroke::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
Stroke::defaultConfiguration public function Gets default configuration for this plugin. Overrides OpenlayersPluginBase::defaultConfiguration
Stroke::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides OpenlayersPluginBase::getSummary
Stroke::submitConfigurationForm public function Form submission handler. Overrides OpenlayersConfigurablePluginBase::submitConfigurationForm
Stroke::validateConfigurationForm public function Form validation handler. Overrides OpenlayersConfigurablePluginBase::validateConfigurationForm