livecodingspace-app/support/client/lib/vwf/api/view.js

"use strict";

// Copyright 2012 United States Government, as represented by the Secretary of Defense, Under
// Secretary of Defense (Personnel & Readiness).
// 
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
// in compliance with the License. You may obtain a copy of the License at
// 
//   http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software distributed under the License
// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
// or implied. See the License for the specific language governing permissions and limitations under
// the License.

/// View API.
/// 
/// @module vwf/api/view

define( function() {

    var exports = {

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {ID} childID
        /// @param {String} childExtendsID
        /// @param {String[]} childImplementsIDs
        /// @param {String} childSource
        /// @param {String} childType
        /// @param {String} childIndex
        ///   When `nodeID` is falsy, the URI of the component, or `undefined` if the component
        ///   wasn't loaded from a URI. When `nodeID` is truthy, the numerical index of the child's
        ///   position in the parent's array, starting at `0`. When child order is significant to
        ///   the driver, the child should be placed at the given position in the parent's array.
        ///   Nodes won't necessarily arrive in numerical order since varying dependencies cause
        ///   nodes to become ready at indeterminate times.
        /// @param {String} childName
        /// @param {module:vwf/api/view~readyCallback} callback
        /// 
        /// @returns {}

        createdNode: [ /* nodeID, childID, childExtendsID, childImplementsIDs, childSource, childType,
            childIndex, childName, callback( ready ) */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {ID} childID
        /// @param {String} childExtendsID
        /// @param {String[]} childImplementsIDs
        /// @param {String} childSource
        /// @param {String} childType
        /// @param {String} childIndex
        ///   When `nodeID` is falsy, the URI of the component, or `undefined` if the component
        ///   wasn't loaded from a URI. When `nodeID` is truthy, the numerical index of the child's
        ///   position in the parent's array, starting at `0`. When child order is significant to
        ///   the driver, the child should be placed at the given position in the parent's array.
        ///   Nodes won't necessarily arrive in numerical order since varying dependencies cause
        ///   nodes to become ready at indeterminate times.
        /// @param {String} childName
        /// 
        /// @returns {}

        initializedNode: [ /* nodeID, childID, childExtendsID, childImplementsIDs, childSource, childType,
            childIndex, childName */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// 
        /// @returns {}

        deletedNode: [ /* nodeID */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {ID} childID
        /// @param {String} childName
        /// 
        /// @returns {}

        addedChild: [ /* nodeID, childID, childName */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {ID} childID
        /// 
        /// @returns {}

        removedChild: [ /* nodeID, childID */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} propertyName
        /// @param {Value} propertyValue
        /// 
        /// @returns {}

        createdProperty: [ /* nodeID, propertyName, propertyValue */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} propertyName
        /// @param {Value} propertyValue
        /// 
        /// @returns {}

        initializedProperty: [ /* nodeID, propertyName, propertyValue */ ],

        // TODO: deletedProperty

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} propertyName
        /// @param {Value} propertyValue
        ///   The internal value of the property set in the model driver (which 
        ///   may differ from the value originally passed in to the model driver).
        /// 
        /// @returns {}

        satProperty: [ /* nodeID, propertyName, propertyValue */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} propertyName
        /// @param {Value} propertyValue
        /// 
        /// @returns {}

        gotProperty: [ /* nodeID, propertyName, propertyValue */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} methodName
        /// @param {String[]} methodParameters
        /// @param {String} methodBody
        /// 
        /// @returns {}

        createdMethod: [ /* nodeID, methodName, methodParameters, methodBody */ ],

        // TODO: deletedMethod

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} methodName
        /// @param {Handler} methodHandler
        /// 
        /// @returns {}

        satMethod: [ /* nodeID, methodName, methodHandler */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} methodName
        /// @param {Handler} methodHandler
        /// 
        /// @returns {}

        gotMethod: [ /* nodeID, methodName, methodHandler */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} methodName
        /// @param {String[]} methodParameters
        /// @param {Value} methodValue
        /// 
        /// @returns {}

        calledMethod: [ /* nodeID, methodName, methodParameters, methodValue */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} eventName
        /// @param {String[]} eventParameters
        /// 
        /// @returns {}

        createdEvent: [ /* nodeID, eventName, eventParameters */ ],

        // TODO: deletedEvent

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} eventName
        /// @param {ListenerID} eventListenerID
        /// @param {Handler} eventHandler
        /// @param {ID} eventContextID
        /// @param {String[]} eventPhases
        /// 
        /// @returns {}

        addedEventListener: [ /* nodeID, eventName, eventListenerID, eventHandler, eventContextID, eventPhases */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} eventName
        /// @param {ListenerID} eventListenerID
        /// 
        /// @returns {}

        removedEventListener: [ /* nodeID, eventName, eventListenerID */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} eventName
        /// @param {ListenerID} eventListenerID
        /// @param {Listener} eventListener
        /// 
        /// @returns {}

        satEventListener: [ /* nodeID, eventName, eventListenerID, eventListener */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} eventName
        /// @param {ListenerID} eventListenerID
        /// @param {Listener} eventListener
        /// 
        /// @returns {}

        gotEventListener: [ /* nodeID, eventName, eventListenerID, eventListener */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} eventName
        /// @param {ID} eventContextID
        /// 
        /// @returns {}

        flushedEventListeners: [ /* nodeID, eventName, eventContextID */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} eventName
        /// @param {String[]} eventParameters
        /// 
        /// @returns {}

        firedEvent: [ /* nodeID, eventName, eventParameters */ ],

        /// Description.
        /// 
        /// @function
        /// 
        /// @param {ID} nodeID
        /// @param {String} scriptText
        /// @param {String} scriptType
        /// 
        /// @returns {}

        executed: [ /* nodeID, scriptText, scriptType */ ],

        /// Time has changed, probably by about the same amount as last time.
        /// 
        /// `ticked` notifications are sent periodically as time moves forward. They are sent at
        /// roughly consistent intervals in real time while the application is running. However,
        /// application processing delays and network jitter will affect the specific interval.
        /// 
        /// Don't rely on `ticked` notifications to arrive at any particular rate. `ticked` is
        /// currently derived from reflector idle messages. Future versions of the reflector may
        /// vary the idle message interval based on network conditions and the application state.
        /// 
        /// Use {@link external:Window#requestAnimationFrame window.requestAnimationFrame} or
        /// {@link external:WindowTimers#setInterval window.setInterval} for real-time
        /// notifications. To receive notifications following application state changes, but not
        /// necessarily periodically, listen for {@link module:vwf/api/view.tocked view.tocked}.
        /// 
        /// @function
        /// 
        /// @param {Number} time
        /// 
        /// @returns {}

        ticked: [ /* time */ ],

        /// Time has changed.
        /// 
        /// Unlike {@link module:vwf/api/view.ticked view.ticked}, `tocked` notifications are sent
        /// each time that time moves forward. Time changes may occur when previously scheduled
        /// actions are executed or as regular idle progress. Since the application state only
        /// changes when simulation time changes, `tocked` notifications may be used as an
        /// application-wide change notification.
        /// 
        /// @function
        /// 
        /// @param {Number} time
        /// 
        /// @returns {}

        tocked: [ /* time */ ],

        /// Description.
        /// 
        /// @callback module:vwf/api/view~readyCallback
        /// 
        /// @param {Boolean} ready

    };

    return exports;

} );