mypackage_wrt/WRTKit/UI/FormButton.js
author nithyar
Mon, 20 Sep 2010 13:47:38 +0100
changeset 61 3c5e0637d4d3
parent 42 20be4dd42b12
permissions -rwxr-xr-x
Integration plan updates, week37
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
42
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
     1
/*
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
     2
© Copyright 2008 Nokia Corporation. All rights reserved.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
     3
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
     4
IMPORTANT:  The Nokia software ("WRTKit and Example Widget files") is supplied to you by Nokia
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
     5
Corporation (“Nokia”) in consideration of your agreement to the following terms. Your use, installation
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
     6
and/or redistribution of the WRTKit and Example Widget files constitutes acceptance of these terms. If
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
     7
you do not agree with these terms, please do not use, install, or redistribute the WRTKit and Example
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
     8
Widget files.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
     9
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    10
In consideration of your agreement to abide by the following terms, and subject to these terms, Nokia
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    11
grants you a personal, non-exclusive license, under Nokia’s copyrights in the WRTKit and Example
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    12
Widget files, to use, reproduce, and redistribute the WRTKit and Example files, in text form (for HTML,
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    13
CSS, or JavaScript files) or binary form (for associated images), for the sole purpose of creating S60
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    14
Widgets.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    15
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    16
If you redistribute the WRTKit and Example files, you must retain this entire notice in all such
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    17
redistributions of the WRTKit and Example files.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    18
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    19
You may not use the name, trademarks, service marks or logos of Nokia to endorse or promote products
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    20
that include the WRTKit and Example files without the prior written explicit agreement with Nokia.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    21
Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    22
Nokia herein, including but not limited to any patent rights that may be infringed by your products that
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    23
incorporate the WRTKit and Example files or by other works in which the WRTKit and Example files
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    24
may be incorporated.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    25
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    26
The WRTKit and Example files are provided on an "AS IS" basis.  NOKIA MAKES NO
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    27
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    28
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    29
PARTICULAR PURPOSE, REGARDING THE EXAMPLES OR ITS USE AND OPERATION
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    30
ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    31
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    32
IN NO EVENT SHALL NOKIA BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    33
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    34
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    35
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, AND/OR
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    36
DISTRIBUTION OF THE EXAMPLES, HOWEVER CAUSED AND WHETHER UNDER THEORY
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    37
OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE,
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    38
EVEN IF NOKIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    39
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    40
*/
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    41
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    42
///////////////////////////////////////////////////////////////////////////////
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    43
// The FormButton class implements a button control for use in form-style UIs.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    44
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    45
// Constructor.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    46
function FormButton(id, text) {
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    47
    if (id != UI_NO_INIT_ID) {
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    48
        this.init(id, text);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    49
    }
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    50
}
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    51
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    52
// FormButton inherits from ActionControl.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    53
FormButton.prototype = new ActionControl(UI_NO_INIT_ID);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    54
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    55
// Button table element.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    56
FormButton.prototype.tableElement = null;
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    57
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    58
// Button table row element.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    59
FormButton.prototype.tableRowElement = null;
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    60
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    61
// Button table left cell element.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    62
FormButton.prototype.tableLeftCellElement = null;
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    63
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    64
// Button table center cell element.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    65
FormButton.prototype.tableCenterCellElement = null;
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    66
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    67
// Button text element.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    68
FormButton.prototype.textElement = null;
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    69
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    70
// Button table right cell element.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    71
FormButton.prototype.tableRightCellElement = null;
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    72
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    73
// Initializer - called from constructor.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    74
FormButton.prototype.init = function(id, text) {
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    75
    uiLogger.debug("FormButton.init(" + id + ", " + text + ")");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    76
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    77
    // call superclass initializer
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    78
    ActionControl.prototype.init.call(this, id, null);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    79
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    80
    // remove caption element
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    81
    this.assemblyElement.removeChild(this.captionElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    82
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    83
    // construct the button
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    84
    this.buttonElement = document.createElement("div");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    85
    this.tableElement = document.createElement("table");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    86
    this.tableRowElement = document.createElement("tr");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    87
    this.tableLeftCellElement = document.createElement("td");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    88
    this.tableCenterCellElement = document.createElement("td");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    89
    this.linkElement = document.createElement("a");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    90
    this.linkElement.href = "JavaScript:void(0)";
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    91
    this.textElement = document.createElement("span");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    92
    this.tableRightCellElement = document.createElement("td");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    93
    this.tableElement.appendChild(this.tableRowElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    94
    this.tableRowElement.appendChild(this.tableLeftCellElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    95
    this.tableRowElement.appendChild(this.tableCenterCellElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    96
    this.tableCenterCellElement.appendChild(this.linkElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    97
    this.linkElement.appendChild(this.textElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    98
    this.tableRowElement.appendChild(this.tableRightCellElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
    99
    this.buttonElement.appendChild(this.tableElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   100
    this.controlElement.appendChild(this.buttonElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   101
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   102
    // set the text
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   103
    this.setText(text);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   104
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   105
    // bind event listeners
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   106
    this.bindActionControlListeners();
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   107
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   108
    // update the style
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   109
    this.updateStyleFromState();
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   110
}
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   111
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   112
// Sets the enabled state.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   113
FormButton.prototype.setEnabled = function(enabled) {
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   114
    uiLogger.debug("FormButton.setEnabled(" + enabled + ")");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   115
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   116
    // bail out early if there is no change in state
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   117
    if (this.enabled == enabled) {
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   118
        return;
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   119
    }
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   120
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   121
    // set the enabled state
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   122
    this.enabled = enabled;
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   123
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   124
    if (this.enabled) {
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   125
        // diabled -> enabled
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   126
        this.tableCenterCellElement.removeChild(this.textElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   127
        this.tableCenterCellElement.appendChild(this.linkElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   128
        this.linkElement.appendChild(this.textElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   129
    } else {
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   130
        // enabled -> diabled
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   131
        this.linkElement.removeChild(this.textElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   132
        this.tableCenterCellElement.removeChild(this.linkElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   133
        this.tableCenterCellElement.appendChild(this.textElement);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   134
    }
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   135
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   136
    // update the style
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   137
    this.updateStyleFromState();
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   138
}
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   139
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   140
// Returns the button text.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   141
FormButton.prototype.getText = function() {
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   142
    return this.textElement.innerHTML;
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   143
}
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   144
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   145
// Sets the button text.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   146
FormButton.prototype.setText = function(text) {
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   147
    uiLogger.debug("FormButton.setText(" + text + ")");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   148
    this.textElement.innerHTML = (text == null) ? "" : text;;
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   149
}
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   150
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   151
// Updates the style of the control to reflects the state of the control.
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   152
FormButton.prototype.updateStyleFromState = function() {
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   153
    uiLogger.debug("FormButton.updateStyleFromState()");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   154
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   155
    // determine the state name
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   156
    var stateName = this.getStyleStateName();
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   157
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   158
    // set root element class name
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   159
    this.setClassName(this.rootElement, "Control");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   160
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   161
    // set the control assembly class names
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   162
    this.setClassName(this.assemblyElement, "ControlAssembly ControlAssemblyNormal");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   163
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   164
    // control element
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   165
    this.setClassName(this.controlElement, "ControlElement FormButtonControlElement");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   166
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   167
    // set the button table class names
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   168
    this.setClassName(this.buttonElement, "FormButton");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   169
    this.setClassName(this.tableElement, "FormButtonTable");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   170
    this.setClassName(this.tableRowElement, "FormButtonRow");
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   171
    this.setClassName(this.tableLeftCellElement, "FormButtonLeftCell FormButtonLeftCell" + stateName);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   172
    this.setClassName(this.tableCenterCellElement, "FormButtonCenterCell FormButtonLeftCell" + stateName);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   173
    this.setClassName(this.tableRightCellElement, "FormButtonRightCell FormButtonLeftCell" + stateName);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   174
    
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   175
    // set the button text class name
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   176
    this.setClassName(this.textElement, "FormButtonText FormButtonText" + stateName);
20be4dd42b12 My package widget code
victorp@symbian.org
parents:
diff changeset
   177
}