org.symbian.tools.wrttools/projecttemplates/WRTKit/UI/View.js
author Eugene Ostroukhov <eugeneo@symbian.org>
Fri, 05 Feb 2010 11:54:28 -0800
changeset 102 30e0796f3ebb
parent 73 c56c874eef47
child 210 0f7abfd6ae62
permissions -rw-r--r--
Warnings in new projects were fixed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     1
/*
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     2
© Copyright 2008 Nokia Corporation. All rights reserved.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     3
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     4
IMPORTANT:  The Nokia software ("WRTKit and Example Widget files") is supplied to you by Nokia
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     5
Corporation (“Nokia”) in consideration of your agreement to the following terms. Your use, installation
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     6
and/or redistribution of the WRTKit and Example Widget files constitutes acceptance of these terms. If
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     7
you do not agree with these terms, please do not use, install, or redistribute the WRTKit and Example
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     8
Widget files.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     9
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    10
In consideration of your agreement to abide by the following terms, and subject to these terms, Nokia
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    11
grants you a personal, non-exclusive license, under Nokia’s copyrights in the WRTKit and Example
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    12
Widget files, to use, reproduce, and redistribute the WRTKit and Example files, in text form (for HTML,
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    13
CSS, or JavaScript files) or binary form (for associated images), for the sole purpose of creating S60
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    14
Widgets.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    15
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    16
If you redistribute the WRTKit and Example files, you must retain this entire notice in all such
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    17
redistributions of the WRTKit and Example files.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    18
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    19
You may not use the name, trademarks, service marks or logos of Nokia to endorse or promote products
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    20
that include the WRTKit and Example files without the prior written explicit agreement with Nokia.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    21
Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    22
Nokia herein, including but not limited to any patent rights that may be infringed by your products that
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    23
incorporate the WRTKit and Example files or by other works in which the WRTKit and Example files
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    24
may be incorporated.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    25
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    26
The WRTKit and Example files are provided on an "AS IS" basis.  NOKIA MAKES NO
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    27
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    28
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    29
PARTICULAR PURPOSE, REGARDING THE EXAMPLES OR ITS USE AND OPERATION
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    30
ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    31
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    32
IN NO EVENT SHALL NOKIA BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    33
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    34
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    35
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, AND/OR
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    36
DISTRIBUTION OF THE EXAMPLES, HOWEVER CAUSED AND WHETHER UNDER THEORY
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    37
OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE,
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    38
EVEN IF NOKIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    39
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    40
*/
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    41
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    42
///////////////////////////////////////////////////////////////////////////////
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    43
// The View class is an abstract base class for views in the UI toolkit.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    44
// Don't use the View directly - instead use a concrete subclass like ListView.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    45
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    46
// Constructor.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    47
function View(id) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    48
    if (id != UI_NO_INIT_ID) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    49
        this.init(id);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    50
    }
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    51
}
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    52
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    53
// View inherits from UIElement.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    54
View.prototype = new UIElement(UI_NO_INIT_ID);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    55
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    56
// Currently focused control.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    57
View.prototype.focusedControl = null;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    58
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    59
// Initializer - called from constructor.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    60
View.prototype.init = function(id) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    61
    uiLogger.debug("View.init(" + id + ")");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    62
    
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    63
    // call superclass initializer
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    64
    UIElement.prototype.init.call(this, id);
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    65
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    66
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    67
// Returns the currently focused control; null if none.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    68
View.prototype.getFocusedControl = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    69
    return this.focusedControl;
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    70
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    71
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    72
// Used to notify the view that the focused control has changed.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    73
View.prototype.focusedControlChanged = function(control) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    74
    uiLogger.debug("View.focusedControlChanged(" + control + ")");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    75
    this.focusedControl = control;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    76
    // notify event listeners
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    77
    this.fireEvent(this.createEvent("FocusedControlChanged", this.focusedControl));
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    78
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    79
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    80
// Attempts to focus the first focusable control.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    81
// Override in subclasses as required.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    82
View.prototype.focusFirstControl = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    83
    uiLogger.debug("View.focusFirstControl()");
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    84
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    85
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    86
// Attempts to reset all control focus states.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    87
// Override in subclasses as required.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    88
View.prototype.resetControlFocusStates = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    89
    uiLogger.debug("View.resetControlFocusStates()");
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    90
};