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