Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • escape
    • invoked when the Esc key is pressed
    • the function should return true if the event was "consumed", false otherwise
    • typically the function in the business logic will maintain state as to whether there is anything to "clear" / "reset", and use that to decide whether Esc should be consumed or not
    • Some example code:
      • Code Block
        languagejs
        collapsetrue
        // Sample code in the Business Logic
         
        // "constants"
        var startDisplay = 'sampleDemoStartDisplay',
            stopDisplay = 'sampleDemoStopDisplay';
         
        // internal state
        var active = false;
         
        ...
         
        function startDisplay() {
            if (!active) {
                active = true;
                wss.sendEvent(startDisplay);
            }
        }
         
        // returns true if display was stopped; false if already stopped
        function stopDisplay() {
            if (!active) {
                return false;
            }
            active = false;
            wss.sendEvent('stopDisplay');
            return true;
        }
  • empty: invoked when the topology node selection changes to "nothing selected"
  • single: invoked when the topology node selection changes to "a single node selected" (either a device or a host)
    • the data parameter is the data model for the selected device
  • multi: invoked when the topology node selection changes to "more than one node selected" (may be a combination of devices and hosts)
    • the selectOrder parameter is an array of node IDs in the order that they were selected by the user

...