Source: vclsd/view/WKcView.js

/*jslint plusplus: true, white: true, indent: 2, maxlen: 90 */
/*global window,$wk$ */
/**
 *  @author    Wolfgang Kowarschick
 *  @copyright 2012-2013, Wolfgang Kowarschick
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted under the terms of the 
 *  Creative Commons License Attribution-NonCommercial-ShareAlike 3.0 Unported    
 *  (CC BY-NC-SA 3.0: http://creativecommons.org/licenses/by-nc-sa/3.0/). 
 */

 
////////////////////////////////////////////////////////////////////////////////
// Class "$wk$.vclsd.view.WKcView"
////////////////////////////////////////////////////////////////////////////////

$wk$("$wk$.WKcClass", 
function($)
{ "use strict";

  /** 
   * The purpose of <code>WKcView</code> objects is to visualize data.
   * Usually data is "visualized" by displying it on a scrren.
   * However, playing sound, doing force feedback etc. is also
   * supposed to be a proper kind of "visualization".
   * <p>
   * If a user interacts with a visualization (i.e. by clicking
   * on a button), a controller may be informed about that interaction.
   * </p>
   * 
   * @class
   * @name $wk$.vclsd.view.WKcView
   * @returns {Object} A new logic object.
   */
  var WKcView =
  new $.WKcClass
  ({fullName: "$wk$.vclsd.view.WKcView",
    
    private: 
    { v_data:    null,
      v_controller: null,
    },
    
    methods: 
    { /**
       * Sets the data object that is to be visualized.
       * 
       * @method
       * @name $wk$.vclsd.view.WKcView#data
       * @writeonly
       * 
       * @param {$wk$.vclsd.data.WKcData} p_data  A data object.
       */
      set data(p_data) { this.v_data = p_data; },
      
      /**
       * Sets the controller object that can be accessed by the logic object.
       * 
       * @method
       * @name $wk$.vclsd.view.WKcView#controller
       * @writeonly
       * 
       * @param {$wk$.vclsd.controller.WKcController} 
       *        p_controller  A controller object.
       */
      set controller(p_controller) { this.v_controller = p_controller; },
    }    

  });

  $.moduleAdd({ name:   "$wk$.vclsd.view.WKcView",
                module: { WKcView: WKcView }
             });
});

////////////////////////////////////////////////////////////////////////////////
// End of Class "$wk$.ldvcs.view.WKcView"
////////////////////////////////////////////////////////////////////////////////
W. Kowarschick © 2013 (CC BY-NC-SA 3.0: http://creativecommons.org/licenses/by-nc-sa/3.0/)
Documentation generated by JSDoc 3.3.0-dev on Sat Oct 05 2013 15:14:39 GMT+0200 (MESZ) using the DocStrap template.