org.symbian.tools.wrttools/projecttemplates/WRTKit/UI/Label.js
author tasneems@symbian.org
Mon, 01 Feb 2010 13:47:20 -0800
changeset 73 c56c874eef47
child 102 30e0796f3ebb
permissions -rw-r--r--
Added WRTKit
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 Label class implements a control that displays textual content.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    44
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    45
// Constructor.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    46
function Label(id, caption, text) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    47
    if (id != UI_NO_INIT_ID) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    48
        this.init(id, caption, text);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    49
    }
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
// Label inherits from Control.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    53
Label.prototype = new Control(UI_NO_INIT_ID);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    54
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    55
// Content element for label text.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    56
Label.prototype.contentElement = null;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    57
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    58
// Initializer - called from constructor.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    59
Label.prototype.init = function(id, caption, text) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    60
    uiLogger.debug("Label.init(" + id + ", " + caption + ", " + text + ")");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    61
    
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    62
    // call superclass initializer
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    63
    Control.prototype.init.call(this, id, caption);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    64
    
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    65
    // create content element
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    66
    this.contentElement = document.createElement("div");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    67
    this.controlElement.appendChild(this.contentElement);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    68
    
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    69
    // set the text
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    70
    this.setText(text);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    71
}
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    72
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    73
// Returns the enabled state for the control.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    74
Label.prototype.isEnabled = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    75
    return true;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    76
}
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    77
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    78
// Returns the focusable state for the control.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    79
Label.prototype.isFocusable = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    80
    return false;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    81
}
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    82
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    83
// Returns the control text.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    84
Label.prototype.getText = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    85
    return this.contentElement.innerHTML;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    86
}
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    87
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    88
// Sets the text for the control.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    89
Label.prototype.setText = function(text) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    90
    uiLogger.debug("Label.setText(" + text + ")");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    91
    this.contentElement.innerHTML = (text == null) ? "" : text;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    92
    this.updateStyleFromState();
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    93
}
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    94
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    95
// Updates the style of the control to reflects the state of the control.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    96
Label.prototype.updateStyleFromState = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    97
    uiLogger.debug("Label.updateStyleFromState()");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    98
    
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    99
    // set element class names
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   100
    this.setClassName(this.rootElement, "Control");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   101
    this.setClassName(this.assemblyElement, "ControlAssembly ControlAssemblyNormal");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   102
    this.setClassName(this.captionElement, "ControlCaption ControlCaptionNormal");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   103
    this.setClassName(this.controlElement, "ControlElement");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   104
    this.setClassName(this.contentElement, "LabelText");
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   105
}