org.symbian.tools.wrttools/projecttemplates/WRTKit/UI/TextEntryControl.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 TextEntryControl class is an abstract base class for the single and multi-
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    44
// line text entry controls TextField and TextArea. Don't use TextEntryControl
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    45
// directly.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    46
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    47
// Constructor.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    48
function TextEntryControl(id, caption) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    49
    if (id != UI_NO_INIT_ID) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    50
        this.init(id, caption);
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
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    54
// TextEntryControl inherits from Control.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    55
TextEntryControl.prototype = new Control(UI_NO_INIT_ID);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    56
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    57
// Reference to the peer HTML element.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    58
TextEntryControl.prototype.peerElement = null;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    59
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    60
// Initializer - called from constructor.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    61
TextEntryControl.prototype.init = function(id, caption) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    62
    uiLogger.debug("TextEntryControl.init(" + id + ", " + caption + ")");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    63
    
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    64
    // call superclass initializer
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    65
    Control.prototype.init.call(this, id, caption);
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    66
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    67
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    68
// Common event listeners hookup function called from subclasses.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    69
TextEntryControl.prototype.bindTextEntryControlListeners = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    70
    var self = this;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    71
    this.peerElement.addEventListener("focus", function() { self.focusStateChanged(true); }, false);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    72
    this.peerElement.addEventListener("blur", function() { self.focusStateChanged(false); }, false);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    73
    this.peerElement.addEventListener("mouseover", function() { self.hoverStateChanged(true); }, false);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    74
    this.peerElement.addEventListener("mouseout", function() { self.hoverStateChanged(false); }, false);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    75
    this.peerElement.addEventListener("change", function() { self.valueChanged(); }, false);
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    76
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    77
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    78
// Returns the enabled state.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    79
// Override this in subclasses as required to implement the state change.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    80
TextEntryControl.prototype.isEnabled = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    81
    return !this.peerElement.readOnly;
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    82
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    83
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    84
// Sets the enabled state.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    85
// Override this in subclasses as required to implement the state change.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    86
TextEntryControl.prototype.setEnabled = function(enabled) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    87
    uiLogger.debug("TextEntryControl.setEnabled(" + enabled + ")");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    88
    this.peerElement.readOnly = !enabled;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    89
    // update the style
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    90
    this.updateStyleFromState();
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    91
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    92
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    93
// Returns the control text.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    94
TextEntryControl.prototype.getText = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    95
    return this.peerElement.value;
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    96
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    97
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    98
// Sets the text for the control.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    99
TextEntryControl.prototype.setText = function(text) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   100
    this.peerElement.value = text;
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
   101
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   102
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   103
// Returns the focusable state for the control.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   104
TextEntryControl.prototype.isFocusable = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   105
    // text entry controls are always focusable
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   106
    return true;
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
   107
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   108
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   109
// Sets the focused state for the control.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   110
// Note: This may not always succeed.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   111
TextEntryControl.prototype.setFocused = function(focused) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   112
    uiLogger.debug("TextEntryControl.setFocused(" + focused + ")");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   113
    if (focused) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   114
        this.peerElement.focus();
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   115
    } else {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   116
        this.peerElement.blur();
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   117
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
   118
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   119
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   120
// Callback for value change events.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   121
TextEntryControl.prototype.valueChanged = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   122
    uiLogger.debug("TextEntryControl.valueChanged()");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   123
    // notify event listeners
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   124
    this.fireEvent(this.createEvent("ValueChanged", this.peerElement.value));
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
   125
};