public function Icon::buildConfigurationForm in Openlayers 8.4

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides PluginFormInterface::buildConfigurationForm

File

src/Plugin/OpenlayersStyle/Icon.php, line 62

Class

Icon

Defines the Icon style for Openlayers features.

Namespace

Drupal\openlayers\Plugin\OpenlayersStyle

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['anchor'] = [
    '#type' => 'textfield',
    '#default_value' => $this->configuration['anchor'],
    '#title' => t('Anchor'),
    '#description' => t("Anchor. Enter this in the form 'x, y'. Default value is the icon center '0, 0'."),
    //  "Anchor. Default value is the icon center."
    //  . Enter this in the form 'x, y'.
    '#size' => 10,
    '#maxlength' => 10,
    '#required' => FALSE,
  ];
  $form['anchorOrigin'] = [
    '#type' => 'select',
    '#default_value' => $this->configuration['anchorOrigin'],
    '#title' => t('Anchor origin'),
    '#description' => t("Origin of the anchor. Defaults to 'top-left'"),
    '#options' => [
      'top-left' => 'Top left',
      'top-right' => 'Top right',
      'bottom-left' => 'Bottom left',
      'bottom-right' => 'Bottom right',
    ],
    //      '#size' => 20,
    //      '#maxlength' => 20,
    '#required' => TRUE,
  ];
  $form['anchorXUnits'] = [
    '#type' => 'select',
    '#default_value' => $this->configuration['anchorXUnits'],
    '#title' => t('Anchor X units'),
    '#description' => t("Units in which the anchor x value is specified. Defaults to 'fraction'"),
    '#options' => [
      'fraction' => 'Fraction',
      'pixels' => 'Pixels',
    ],
    '#required' => TRUE,
  ];
  $form['anchorYUnits'] = [
    '#type' => 'select',
    '#default_value' => $this->configuration['anchorYUnits'],
    '#title' => t('Anchor Y units'),
    '#description' => t("Units in which the anchor y value is specified. Defaults to 'fraction'"),
    '#options' => [
      'fraction' => 'Fraction',
      'pixels' => 'Pixels',
    ],
    '#required' => TRUE,
  ];
  $form['color'] = [
    '#type' => 'textfield',
    '#default_value' => $this->configuration['color'],
    '#title' => t('Color'),
    //  TODO - improve description to recognise other valid color formats.
    '#description' => t('The color to be used for icon markers on the map. Use web-style hex colors (#FFFFFF for white, #000000 for black).'),
    '#size' => 20,
    '#maxlength' => 20,
    '#required' => FALSE,
  ];
  $form['crossOrigin'] = [
    '#type' => 'textfield',
    '#default_value' => $this->configuration['crossOrigin'],
    '#title' => t('Cross origin'),
    '#description' => t('The crossOrigin attribute for loaded images.'),
    '#size' => 20,
    '#maxlength' => 20,
    '#required' => FALSE,
  ];
  $form['img'] = [
    '#type' => 'textfield',
    '#default_value' => $this->configuration['img'],
    '#title' => t('img'),
    '#description' => t('Image object for the icon. If the src option is not provided then the provided image must already be loaded. And in that case,' . ' it is required to provide the size of the image, with the imgSize option.'),
    '#size' => 20,
    '#maxlength' => 20,
    '#required' => FALSE,
  ];
  $form['offset'] = [
    '#type' => 'textfield',
    '#default_value' => $this->configuration['offset'],
    '#title' => t('Offset'),
    '#description' => t("Offset, together with the size and the offset origin, defines the sub-rectangle to use from the original icon image." . " Enter this in the form 'x, y'. Defaults to '0,0'."),
    '#size' => 10,
    '#maxlength' => 10,
    '#required' => FALSE,
  ];
  $form['displacement'] = [
    '#type' => 'textfield',
    '#default_value' => $this->configuration['displacement'],
    '#title' => t('Displacement'),
    '#description' => t("Displacement of the icon. Enter this in the form 'x, y'. Defaults to '0,0'."),
    '#size' => 10,
    '#maxlength' => 10,
    '#required' => FALSE,
  ];
  $form['offsetOrigin'] = [
    '#type' => 'select',
    '#default_value' => $this->configuration['offsetOrigin'],
    '#title' => t('Offset origin'),
    '#description' => t("Origin of the offset. Defaults to 'top-left'"),
    '#options' => [
      'top-left' => 'Top left',
      'top-right' => 'Top right',
      'bottom-left' => 'Bottom left',
      'bottom-right' => 'Bottom right',
    ],
    '#required' => TRUE,
  ];
  $form['opacity'] = [
    '#type' => 'number',
    '#step' => 0.1,
    '#max' => 1,
    '#min' => 0,
    '#default_value' => $this->configuration['opacity'],
    '#title' => t('Opacity'),
    '#description' => t('The opacity to be used for icon markers on the map. Defaults to 1.'),
    '#required' => TRUE,
  ];
  $form['scale'] = [
    '#type' => 'number',
    '#step' => 1,
    '#max' => 10,
    '#min' => 1,
    '#default_value' => $this->configuration['scale'],
    '#title' => t('Scale'),
    '#description' => t('The scale to be used for icon markers on the map. Defaults to 1.'),
    '#required' => TRUE,
  ];
  $form['size'] = [
    '#type' => 'number',
    '#default_value' => $this->configuration['size'],
    '#title' => t('Icon size in pixels'),
    '#description' => t('The icon size (in pixels) to be used for icon markers on the map.'),
    '#required' => FALSE,
  ];
  $form['imgSize'] = [
    '#type' => 'number',
    '#default_value' => $this->configuration['imgSize'],
    '#title' => t('Image size in pixels'),
    '#description' => t('The image size (in pixels) to be used for icon markers on the map.'),
    '#required' => FALSE,
  ];
  $form['src'] = [
    '#type' => 'textfield',
    '#default_value' => $this->configuration['src'],
    '#title' => t('Source URI'),
    '#description' => t('Image source URI.'),
    '#size' => 150,
    '#maxlength' => 255,
    '#required' => FALSE,
  ];
  return $form;
}