class openlayers_behavior_popup in Openlayers 7.2

Popup Behavior

Hierarchy

• class \openlayers_behavior
  • class \openlayers_behavior_popup

File

plugins/behaviors/openlayers_behavior_popup.inc, line 10

Implementation of OpenLayers behavior.

class openlayers_behavior_popup extends openlayers_behavior {

  /**
   * Provide initial values for options.
   */
  function options_init() {
    return array(
      'layers' => array(),
      'panMapIfOutOfView' => FALSE,
      'keepInMap' => TRUE,
      'popupAtPosition' => 'mouse',
    );
  }

  /**
   * Form defintion for per map customizations.
   */
  function options_form($defaults = array()) {

    // Only prompt for vector layers
    $vector_layers = array();
    foreach ($this->map['layers'] as $id => $name) {
      $layer = openlayers_layer_load($id);
      if (isset($layer->data['vector']) && $layer->data['vector'] == TRUE) {
        $vector_layers[$id] = $name;
      }
    }
    return array(
      'layers' => array(
        '#title' => t('Layers'),
        '#type' => 'checkboxes',
        '#options' => $vector_layers,
        '#description' => t('Select layer to apply popups to.'),
        '#default_value' => isset($defaults['layers']) ? $defaults['layers'] : array(),
      ),
      'popupAtPosition' => array(
        '#type' => 'select',
        '#title' => t('Select where the popup should pop up'),
        '#description' => t('When selecting a feature, should the popup appear at the mouse position or in the center of the feature ?'),
        '#default_value' => isset($defaults['popupAtPosition']) ? $defaults['popupAtPosition'] : 'mouse',
        '#options' => array(
          'mouse' => 'At the mouse position',
          'computed' => 'Computed from the center of the feature',
        ),
      ),
      'panMapIfOutOfView' => array(
        '#type' => 'checkbox',
        '#title' => t('Pan map if popup out of view'),
        '#description' => t('When drawn, pan map such that the entire popup is visible in the current viewport (if necessary).'),
        '#default_value' => isset($defaults['panMapIfOutOfView']) ? $defaults['panMapIfOutOfView'] : FALSE,
      ),
      'keepInMap' => array(
        '#type' => 'checkbox',
        '#title' => t('Keep in map'),
        '#description' => t('If panMapIfOutOfView is false, and this property is true, contrain the popup such that it always fits in the available map space.'),
        '#default_value' => isset($defaults['keepInMap']) ? $defaults['keepInMap'] : TRUE,
      ),
    );
  }

  /**
   * Render.
   */
  function render(&$map) {

    // Put weight on JS so that we know navigation is included already as this
    // will affect touch devices.
    drupal_add_js(drupal_get_path('module', 'openlayers') . '/plugins/behaviors/openlayers_behavior_popup.js', array(
      'weight' => 10,
    ));
    return $this->options;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
openlayers_behavior::$options		property
openlayers_behavior::js_dependency		function		17
openlayers_behavior::__construct		function
openlayers_behavior_popup::options_form		function	Form defintion for per map customizations. Overrides openlayers_behavior::options_form
openlayers_behavior_popup::options_init		function	Provide initial values for options. Overrides openlayers_behavior::options_init
openlayers_behavior_popup::render		function	Render. Overrides openlayers_behavior::render