/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is VisKort.
*
* The Initial Developer of the Original Code is
* IT- og Telestyrelsen / Danish National IT and Telecom Agency.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):

* Lars Klindt Mogensen
* Morten Bødtkjer
* Niels Kinnerup
* Thomas Bergstedt
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */

/**
* Class: VisKort.Component
* 
* Base class for components.
* A component contains the client side functionality related to one tab in the tab control.
* One sub class to this base class must exists for all the tabs.
*
* All components (sub classes) to visible tabs must be initialized and added to the VisKort.Application 
* using the addComponent method.
*
* Components are initialized when a page is requested in popup or iframe-mode.
*/
VisKort.Component = OpenLayers.Class({

    /** 
    * Property: application
    * {<VisKort.Application>} The application
    */
    application: null,

    /** 
    * Property: map
    * {<VisStedet.Map>} The map
    */
    map: null,

    /** 
    * Property: pagemode
    * {<String>} pagemode can either be "popup" or "iframe"
    */
    pagemode: null,

    /** 
    * Constructor: VisKort.Component
    */
    initialize: function() {
    },

    /** 
    * Method: startup
    * Invoked after the component has been added to the map. 
    * May be used in sub class for initialization purposes when access to local properties 
    * (application and map) is needed.
    */
    startup: function() {
    },

    /** 
    * Method: activate
    * Invoked when the component/tab gets active. 
    * E.g. the user clicks on the tab
    */
    activate: function() {
    },

    /** 
    * Method: activate
    * Invoked when the component/tab gets inactive. 
    */    
    deActivate: function() {
    },

    /** 
    * Method: setContext
    * To setup the values of the properties of the class
    *
    * Parameters:
    * application - <VisKort.Application>
    * map - <VisStedet.Map>
    * pagemode - <String>
    */
    setContext: function(application, map, pagemode) {
        this.application = application;
        this.map = map;
        this.pagemode = pagemode;
    },

    CLASS_NAME: "VisKort.Component"
});