Class FeatureSelectHandler

Object
   |
   +--ToolBase
         |
         +--FeatureSelectHandler

class FeatureSelectHandler

extends ToolBase

Defined in FeatureSelectHandler.js

Author: Andreas Hocevar andreas.hocevarATgmail.com

Field Detail

map

Object map

Map for this FeatureSelectHandler. We keep a reference to the map we created the control for, to prevent ourselves from removing the control from a map that does not exist anymore.

selectStyle

Object selectStyle

sourceModels

Object sourceModels

FeatureSelectHandler

FeatureSelectHandler(toolNode, model)

Manages mouseover and clicks on vector features in the map. This tool works with models that are linked to a OL vector layer, using eg. the GmlRendererOL widget. Models have to fire the 'gmlRendererLayer' event, which will activate the tool for the layer. This tool also fires "mouseoverFeature" and "mouseoutFeature" events, setting the fid of the feature below the mouse cursor as param of the model.

Parameters:
toolNode - The tool node from the config XML file.
model - The model containing this tool.

Author: Andreas Hocevar andreas.hocevarATgmail.com

configInit

void configInit(objRef)

Tool Initialisation - Step 1 of 3. This is called when the config finished loading, so we know our context (targetModel).

Parameters:
objRef - This object

contextInit

void contextInit(objRef)

Tool Initialisation - Step 2 of 3. This is called when the context model finished loading, so we know that we have a map available.

Parameters:
objRef - This object

dehighlight

void dehighlight(objRef, fid)

Dehighlights the specified feature. This method is usually triggered by setting the 'dehighlightFeature' param to the fid of a feature to be highlighted.

Parameters:
objRef - reference to this tool object
fid - GML feature id of the feature to highlight. If not specified, this is taken from the dehighlightFeature model param.

highlight

void highlight(objRef, fid)

Highlights the specified feature. This method is usually triggered by setting the 'highlightFeature' param to the fid of a feature to be highlighted.

Parameters:
objRef - reference to this tool object
fid - GML feature id of the feature to highlight. If not specified, this is taken from the highlightFeature model param.

init

Object init(objRef)

Tool Initialisation - Step 3 of 3. Turns on feature select when the gmlRendererLayer event is fired.

Parameters:
objRef - reference to this object.

Returns:
{OpenLayers.Control} class of the OL control.

onClick

void onClick(evt)

This method is triggered when a user clicks on a feature. It is called by OpenLayers event handling in the context of a feature. This means that 'this' in this method refers to an {OpenLayers.Feature}. Widgets listening to the olFeatureSelect have access to the event, because setParam is used to set the reference to the event.

Parameters:
evt - OpenLayers event

onHover

void onHover(evt)

This method is triggered when the mouse is over a feature. It is called by OpenLayers event handling in the context of a feature. This means that 'this' in this method refers to an {OpenLayers.Feature}. Widgets listening to the olFeatureHover have access to the event, because setParam is used to set the reference to the event.

Parameters:
evt - OpenLayers event

onSelect

void onSelect(feature)

This method is triggered when the mouse is over a vector feature. It registers priority events mousedown and mousemove, which will call this widget's onClick/onHover method in the context of a feature. This way we address two problems with the OpenLayers SelectFeature control:

      - for the info popup, we need the screen coordinates
        which we do not get from the handler directly.
      - when the active tool changes, something in the
        priority of OL event handlers changes, so the
        click event on the feature gets lost. By registering
        our priority handler and calling Event.stop() in
        the target method, we make sure that our event is
        handled and no other event handlers are triggered.
 

Parameters:
feature - OpenLayers feature

onUnselect

void onUnselect(feature)

This method is triggered when the mouse is moving out of a vector feature. It removes the event handler we registered in this widget's onSelect method.

Parameters:
feature - OpenLayers feature