diff -r 5e0dece09f96 -r 97dcd250e5be OSCON/WRTKit/UI/ListView.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OSCON/WRTKit/UI/ListView.js Fri Jul 17 15:52:45 2009 -0700 @@ -0,0 +1,186 @@ +/* +� Copyright 2008 Nokia Corporation. All rights reserved. + +IMPORTANT: The Nokia software ("WRTKit and Example Widget files") is supplied to you by Nokia +Corporation (�Nokia�) in consideration of your agreement to the following terms. Your use, installation +and/or redistribution of the WRTKit and Example Widget files constitutes acceptance of these terms. If +you do not agree with these terms, please do not use, install, or redistribute the WRTKit and Example +Widget files. + +In consideration of your agreement to abide by the following terms, and subject to these terms, Nokia +grants you a personal, non-exclusive license, under Nokia�s copyrights in the WRTKit and Example +Widget files, to use, reproduce, and redistribute the WRTKit and Example files, in text form (for HTML, +CSS, or JavaScript files) or binary form (for associated images), for the sole purpose of creating S60 +Widgets. + +If you redistribute the WRTKit and Example files, you must retain this entire notice in all such +redistributions of the WRTKit and Example files. + +You may not use the name, trademarks, service marks or logos of Nokia to endorse or promote products +that include the WRTKit and Example files without the prior written explicit agreement with Nokia. +Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by +Nokia herein, including but not limited to any patent rights that may be infringed by your products that +incorporate the WRTKit and Example files or by other works in which the WRTKit and Example files +may be incorporated. + +The WRTKit and Example files are provided on an "AS IS" basis. NOKIA MAKES NO +WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED +WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A +PARTICULAR PURPOSE, REGARDING THE EXAMPLES OR ITS USE AND OPERATION +ALONE OR IN COMBINATION WITH YOUR PRODUCTS. + +IN NO EVENT SHALL NOKIA BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, AND/OR +DISTRIBUTION OF THE EXAMPLES, HOWEVER CAUSED AND WHETHER UNDER THEORY +OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, +EVEN IF NOKIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +*/ + +/////////////////////////////////////////////////////////////////////////////// +// The ListView class implements a vertical list view that hosts controls +// as child components. + +// Constructor. +function ListView(id, caption) { + if (id != UI_NO_INIT_ID) { + this.init(id, caption); + } +} + +// ListView inherits from View. +ListView.prototype = new View(UI_NO_INIT_ID); + +// The caption of this view; null if none. +ListView.prototype.caption = null; + +// The caption element of this view. +ListView.prototype.captionElement = null; + +// The caption text element of this view. +ListView.prototype.captionTextElement = null; + +// Root HTML element for controls. +ListView.prototype.listElement = null; + +// List of controls in the view. +ListView.prototype.controls = null; + +// Initializer for ListView. +ListView.prototype.init = function(id, caption) { + uiLogger.debug("ListView.init(" + id + ", " + caption + ")"); + + // call superclass initializer + View.prototype.init.call(this, id); + + // init control array + this.controls = []; + + // set style class name for root element + this.rootElement.className = "ListView"; + + // create caption and caption text elements + this.captionElement = document.createElement("div"); + this.captionElement.className = "ListViewCaptionText"; + this.rootElement.appendChild(this.captionElement); + + // create root element for controls and add to the view root element + this.listElement = document.createElement("div"); + this.listElement.className = "ListViewControlList"; + this.rootElement.appendChild(this.listElement); + + // set the caption + this.setCaption(caption); +} + +// Returns the caption; null if none. +ListView.prototype.getCaption = function() { + return this.caption; +} + +// Sets the caption; null if none. +ListView.prototype.setCaption = function(caption) { + uiLogger.debug("ListView.setCaption(" + caption + ")"); + + // set the display style + this.captionElement.style.display = (caption == null) ? "none" : "block"; + + // set the caption + this.caption = caption; + this.captionElement.innerHTML = (caption == null) ? "" : caption; +} + +// Returns an array of controls in the view. +ListView.prototype.getControls = function() { + return this.controls; +} + +// Adds a control to the view. +ListView.prototype.addControl = function(control) { + uiLogger.debug("ListView.addControl(" + control + ")"); + + // add the control to the controls array and attach it to the list element + this.controls.push(control); + this.listElement.appendChild(control.rootElement); + control.view = this; +} + +// Inserts a control to the view before the specified control. +ListView.prototype.insertControl = function(control, beforeControl) { + uiLogger.debug("ListView.insertControl(" + control + ", " + beforeControl + ")"); + + // iterate through current controls + for (var i = 0; i < this.controls.length; i++) { + // is this the control we should insert before? + if (this.controls[i] == beforeControl) { + // we found the control to insert before - insert here and connect to list element + this.controls.splice(i, 0, control); + this.listElement.insertBefore(control.rootElement, beforeControl.rootElement); + control.view = this; + return; + } + } + + // the control wasn't found so we'll add it last + this.addControl(control); +} + +// Removes a control from the view. +ListView.prototype.removeControl = function(control) { + uiLogger.debug("ListView.removeControl(" + control + ")"); + + // iterate through current controls + for (var i = 0; i < this.controls.length; i++) { + // is this the control we should remove? + if (this.controls[i] == control) { + // we found the control to remove - remove it from the list element + this.controls.splice(i, 1); + this.listElement.removeChild(control.rootElement); + control.view = null; + } + } +} + +// Attempts to focus the first focusable control. +ListView.prototype.focusFirstControl = function() { + uiLogger.debug("ListView.focusFirstControl()"); + for (var i = 0; i < this.controls.length; i++) { + // is this control focusable? + var control = this.controls[i]; + if (control.isFocusable()) { + control.setFocused(true); + break; + } + } +} + +// Attempts to reset all control focus states. +// Override in subclasses as required. +ListView.prototype.resetControlFocusStates = function() { + uiLogger.debug("ListView.resetControlFocusStates()"); + for (var i = 0; i < this.controls.length; i++) { + this.controls[i].resetFocusState(); + } +}