This is documentation of an archived release.
For documentation on the current version, please check Knowledge Base.

Sample : Capturing Events

This example documents how you can capture events.

What basically happens is we :

  • Wait for startup
  • Attach event listeners
  • Handle the events

Sample Setup

You need to upgrade your Flash Player.
set pan

Events:

Overview

Startup

    this.publicInterfaceLoaded = function()
    {
        // ...
    }

We wait for the flash component to start, so we know when the public interface is ready.

Add Event Listeners

When the flash component has started (in the publicInterfaceLoaded() function) we add some event listeners :

    this.publicInterfaceLoaded = function()
    {
        var ofm = document.getElementById("ofm");
        ofm.addEventListener("loadedNewView", "newView");
        ofm.addEventListener("activeModeChanged", "newMode");
    }
Event Function to notify
loadNewView “newView”
activeModeChanged “newMode”

A listing of all available modes can be found here.

A listing of all events van be found FIXME.

We specify the name (string value!!) of the associated function and don't pass the function itself as an argument!

We don't add the measure listener yet. When the publicInterfaceLoaded() function is called, the component itself is ready, but the overlays (ex.: measure overlay) are not, so we cannot add a listener here. The measure listener is added when the measure mode is first activated.

Event Handling

    var ofm;
 
    this.newView = function() {
        addToListing("[view] loaded");
    }
 
    this.newMeasure = function() {
        addToListing("[measure] : "+ ofm.getMeasurementsCount() +" measurements");
    }
 
    this.newMode = function(mode) {
        addToListing("[mode] "+ mode);
        if (mode=="measure" && listeningToMeasure==false) {
            ofm.addEventListener("measurementsChanged", "newMeasure");
            listeningToMeasure = true;
        }
    }
 
    this.addToListing = function(message)
    {
        var events  = document.getElementById("eventListing");
        events.innerHTML += message +"<br/>";
    }

These functions are the event handlers for the events we specified (view, mode and measure).

The measure listener is only associated when the measure mode is actually activated.
 
Last modified:: 2019/03/25 11:36