See09/WRTKit/UI/View.js
changeset 19 f3521a11d878
equal deleted inserted replaced
18:b73e6caf0031 19:f3521a11d878
       
     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 // Allows going back to the same scroll position
       
    63 View.prototype.scrollTop = 0;
       
    64 
       
    65 // Initializer - called from constructor.
       
    66 View.prototype.init = function(id) {
       
    67     uiLogger.debug("View.init(" + id + ")");
       
    68     
       
    69     // call superclass initializer
       
    70     UIElement.prototype.init.call(this, id);
       
    71 }
       
    72 
       
    73 // Returns the currently focused control; null if none.
       
    74 View.prototype.getFocusedControl = function() {
       
    75     return this.focusedControl;
       
    76 }
       
    77 
       
    78 // Used to notify the view that the focused control has changed.
       
    79 View.prototype.focusedControlChanged = function(control) {
       
    80     uiLogger.debug("View.focusedControlChanged(" + control + ")");
       
    81     this.focusedControl = control;
       
    82     // notify event listeners
       
    83     this.fireEvent(this.createEvent("FocusedControlChanged", this.focusedControl));
       
    84 }
       
    85 
       
    86 // Attempts to focus the first focusable control.
       
    87 // Override in subclasses as required.
       
    88 View.prototype.focusFirstControl = function() {
       
    89     uiLogger.debug("View.focusFirstControl()");
       
    90 }
       
    91 
       
    92 // Attempts to reset all control focus states.
       
    93 // Override in subclasses as required.
       
    94 View.prototype.resetControlFocusStates = function() {
       
    95     uiLogger.debug("View.resetControlFocusStates()");
       
    96 }
       
    97 
       
    98 
       
    99 // ////////////////////////////////////////////////////////////////////
       
   100 // Added functions
       
   101 
       
   102 // set up soft keys. Default implementation sets right soft
       
   103 // key to Back if the previous view is set
       
   104 View.prototype.setupSoftKeys = function()  {
       
   105     if (window.widget) {
       
   106 		if (this.previousView != null) {
       
   107 			var self = this;
       
   108 			menu.setRightSoftkeyLabel("Back", function(){self.goBack();});
       
   109 		} else {
       
   110 			menu.setRightSoftkeyLabel("Exit", function(){window.close();});
       
   111 		}
       
   112     }
       
   113 }
       
   114 
       
   115 // show the view - sets up soft keys
       
   116 View.prototype.show = function () {
       
   117 	this.setupSoftKeys();
       
   118 	if (window.widget) {
       
   119 		widget.setNavigationEnabled(false);
       
   120 	}
       
   121 	this.update(false);
       
   122 	uiManager.setView(this);
       
   123 	//this.restoreScrollPos();
       
   124 }
       
   125 
       
   126 // abstract function for updating page content
       
   127 View.prototype.update = function(forceUpdate){
       
   128 }
       
   129 
       
   130 View.prototype.saveScrollPos = function() {
       
   131 	this.scrollTop = window.pageYOffset;
       
   132 //	alert("Saving scroll pos: " + this.scrollTop);
       
   133 }
       
   134 
       
   135 View.prototype.restoreScrollPos = function() {
       
   136 //	alert("Restoring scroll pos: " + this.scrollTop);
       
   137 	window.scrollTo(0, this.scrollTop);
       
   138 }
       
   139 
       
   140 // Default back button handler takes us to previous view
       
   141 // if one is set
       
   142 View.prototype.goBack = function()  {
       
   143 	if ( this.previousView != null ) {
       
   144 		// transition looks funky
       
   145 		if (window.widget) {
       
   146 			widget.prepareForTransition("fade");
       
   147 		}
       
   148 		this.previousView.show();
       
   149 		if (window.widget) {
       
   150 			widget.performTransition();
       
   151 		}
       
   152 	}
       
   153 }
       
   154