OSCON/WRTKit/UI/View.js
changeset 11 aaba47256eea
parent 7 97dcd250e5be
equal deleted inserted replaced
10:07ac2f6a36a9 11:aaba47256eea
       
     1 /*
       
     2 � Copyright 2008 Nokia Corporation. All rights reserved.
       
     3 
       
     4 IMPORTANT:  The Nokia software ("WRTKit and Example Widget files") is supplied to you by Nokia
       
     5 Corporation (�Nokia�) in consideration of your agreement to the following terms. Your use, installation
       
     6 and/or redistribution of the WRTKit and Example Widget files constitutes acceptance of these terms. If
       
     7 you do not agree with these terms, please do not use, install, or redistribute the WRTKit and Example
       
     8 Widget files.
       
     9 
       
    10 In consideration of your agreement to abide by the following terms, and subject to these terms, Nokia
       
    11 grants you a personal, non-exclusive license, under Nokia�s copyrights in the WRTKit and Example
       
    12 Widget files, to use, reproduce, and redistribute the WRTKit and Example files, in text form (for HTML,
       
    13 CSS, or JavaScript files) or binary form (for associated images), for the sole purpose of creating S60
       
    14 Widgets.
       
    15 
       
    16 If you redistribute the WRTKit and Example files, you must retain this entire notice in all such
       
    17 redistributions of the WRTKit and Example files.
       
    18 
       
    19 You may not use the name, trademarks, service marks or logos of Nokia to endorse or promote products
       
    20 that include the WRTKit and Example files without the prior written explicit agreement with Nokia.
       
    21 Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by
       
    22 Nokia herein, including but not limited to any patent rights that may be infringed by your products that
       
    23 incorporate the WRTKit and Example files or by other works in which the WRTKit and Example files
       
    24 may be incorporated.
       
    25 
       
    26 The WRTKit and Example files are provided on an "AS IS" basis.  NOKIA MAKES NO
       
    27 WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
       
    28 WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
       
    29 PARTICULAR PURPOSE, REGARDING THE EXAMPLES OR ITS USE AND OPERATION
       
    30 ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
       
    31 
       
    32 IN NO EVENT SHALL NOKIA BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
       
    33 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
       
    34 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
       
    35 INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, AND/OR
       
    36 DISTRIBUTION OF THE EXAMPLES, HOWEVER CAUSED AND WHETHER UNDER THEORY
       
    37 OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE,
       
    38 EVEN IF NOKIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
       
    39 
       
    40 */
       
    41 
       
    42 ///////////////////////////////////////////////////////////////////////////////
       
    43 // The View class is an abstract base class for views in the UI toolkit.
       
    44 // Don't use the View directly - instead use a concrete subclass like ListView.
       
    45 
       
    46 // Constructor.
       
    47 function View(id) {
       
    48     if (id != UI_NO_INIT_ID) {
       
    49         this.init(id);
       
    50     }
       
    51 }
       
    52 
       
    53 // View inherits from UIElement.
       
    54 View.prototype = new UIElement(UI_NO_INIT_ID);
       
    55 
       
    56 // Currently focused control.
       
    57 View.prototype.focusedControl = null;
       
    58 
       
    59 // Allows going back from every view
       
    60 View.prototype.previousView = null;
       
    61 
       
    62 // Initializer - called from constructor.
       
    63 View.prototype.init = function(id) {
       
    64     uiLogger.debug("View.init(" + id + ")");
       
    65     
       
    66     // call superclass initializer
       
    67     UIElement.prototype.init.call(this, id);
       
    68 }
       
    69 
       
    70 // Returns the currently focused control; null if none.
       
    71 View.prototype.getFocusedControl = function() {
       
    72     return this.focusedControl;
       
    73 }
       
    74 
       
    75 // Used to notify the view that the focused control has changed.
       
    76 View.prototype.focusedControlChanged = function(control) {
       
    77     uiLogger.debug("View.focusedControlChanged(" + control + ")");
       
    78     this.focusedControl = control;
       
    79     // notify event listeners
       
    80     this.fireEvent(this.createEvent("FocusedControlChanged", this.focusedControl));
       
    81 }
       
    82 
       
    83 // Attempts to focus the first focusable control.
       
    84 // Override in subclasses as required.
       
    85 View.prototype.focusFirstControl = function() {
       
    86     uiLogger.debug("View.focusFirstControl()");
       
    87 }
       
    88 
       
    89 // Attempts to reset all control focus states.
       
    90 // Override in subclasses as required.
       
    91 View.prototype.resetControlFocusStates = function() {
       
    92     uiLogger.debug("View.resetControlFocusStates()");
       
    93 }
       
    94 
       
    95 
       
    96 // ////////////////////////////////////////////////////////////////////
       
    97 // Added functions
       
    98 
       
    99 // set up soft keys. Default implementation sets right soft
       
   100 // key to Back if the previous view is set
       
   101 View.prototype.setupSoftKeys = function()  {
       
   102     if (window.widget) {
       
   103 		if (this.previousView != null) {
       
   104 			var self = this;
       
   105 			menu.setRightSoftkeyLabel("Back", function(){self.goBack();});
       
   106 		} else {
       
   107 			menu.setRightSoftkeyLabel("Exit", function(){window.close();});
       
   108 		}
       
   109     }
       
   110 }
       
   111 
       
   112 // show the view - sets up soft keys
       
   113 View.prototype.show = function () {
       
   114 	this.setupSoftKeys();
       
   115 	this.update(false);
       
   116 	uiManager.setView(this);
       
   117 }
       
   118 
       
   119 // abstract function for updating page content
       
   120 View.prototype.update = function(forceUpdate){
       
   121 }
       
   122 
       
   123 
       
   124 // Default back button handler takes us to previous view
       
   125 // if one is set
       
   126 View.prototype.goBack = function()  {
       
   127 	if ( this.previousView != null ) {
       
   128 		this.previousView.show();
       
   129 	}
       
   130 }
       
   131