1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
|
// Copyright 2006 The Closure Library Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/**
* @fileoverview Definition of the MenuBase class.
*
*/
goog.provide('goog.ui.MenuBase');
goog.require('goog.events.EventHandler');
goog.require('goog.events.EventType');
goog.require('goog.events.KeyHandler');
goog.require('goog.ui.Popup');
/**
* The MenuBase class provides an abstract base class for different
* implementations of menu controls.
*
* @param {Element=} opt_element A DOM element for the popup.
* @deprecated Use goog.ui.Menu.
* @constructor
* @extends {goog.ui.Popup}
*/
goog.ui.MenuBase = function(opt_element) {
goog.ui.Popup.call(this, opt_element);
/**
* Event handler for simplifiying adding/removing listeners.
* @type {goog.events.EventHandler<!goog.ui.MenuBase>}
* @private
*/
this.eventHandler_ = new goog.events.EventHandler(this);
/**
* KeyHandler to cope with the vagaries of cross-browser key events.
* @type {goog.events.KeyHandler}
* @private
*/
this.keyHandler_ = new goog.events.KeyHandler(this.getElement());
};
goog.inherits(goog.ui.MenuBase, goog.ui.Popup);
/**
* Events fired by the Menu
* @const
*/
goog.ui.MenuBase.Events = {};
/**
* Event fired by the Menu when an item is "clicked".
*/
goog.ui.MenuBase.Events.ITEM_ACTION = 'itemaction';
/** @override */
goog.ui.MenuBase.prototype.disposeInternal = function() {
goog.ui.MenuBase.superClass_.disposeInternal.call(this);
this.eventHandler_.dispose();
this.keyHandler_.dispose();
};
/**
* Called after the menu is shown. Derived classes can override to hook this
* event but should make sure to call the parent class method.
*
* @protected
* @override
*/
goog.ui.MenuBase.prototype.onShow = function() {
goog.ui.MenuBase.superClass_.onShow.call(this);
// register common event handlers for derived classes
var el = this.getElement();
this.eventHandler_.listen(
el, goog.events.EventType.MOUSEOVER, this.onMouseOver);
this.eventHandler_.listen(
el, goog.events.EventType.MOUSEOUT, this.onMouseOut);
this.eventHandler_.listen(
el, goog.events.EventType.MOUSEDOWN, this.onMouseDown);
this.eventHandler_.listen(el, goog.events.EventType.MOUSEUP, this.onMouseUp);
this.eventHandler_.listen(
this.keyHandler_, goog.events.KeyHandler.EventType.KEY, this.onKeyDown);
};
/**
* Called after the menu is hidden. Derived classes can override to hook this
* event but should make sure to call the parent class method.
* @param {?Node=} opt_target Target of the event causing the hide.
* @protected
* @override
*/
goog.ui.MenuBase.prototype.onHide = function(opt_target) {
goog.ui.MenuBase.superClass_.onHide.call(this, opt_target);
// remove listeners when hidden
this.eventHandler_.removeAll();
};
/**
* Returns the selected item
*
* @return {Object} The item selected or null if no item is selected.
*/
goog.ui.MenuBase.prototype.getSelectedItem = function() {
return null;
};
/**
* Sets the selected item
*
* @param {Object} item The item to select. The type of this item is specific
* to the menu class.
*/
goog.ui.MenuBase.prototype.setSelectedItem = function(item) {};
/**
* Mouse over handler for the menu. Derived classes should override.
*
* @param {goog.events.Event} e The event object.
* @protected
*/
goog.ui.MenuBase.prototype.onMouseOver = function(e) {};
/**
* Mouse out handler for the menu. Derived classes should override.
*
* @param {goog.events.Event} e The event object.
* @protected
*/
goog.ui.MenuBase.prototype.onMouseOut = function(e) {};
/**
* Mouse down handler for the menu. Derived classes should override.
*
* @param {!goog.events.Event} e The event object.
* @protected
*/
goog.ui.MenuBase.prototype.onMouseDown = function(e) {};
/**
* Mouse up handler for the menu. Derived classes should override.
*
* @param {goog.events.Event} e The event object.
* @protected
*/
goog.ui.MenuBase.prototype.onMouseUp = function(e) {};
/**
* Key down handler for the menu. Derived classes should override.
*
* @param {goog.events.KeyEvent} e The event object.
* @protected
*/
goog.ui.MenuBase.prototype.onKeyDown = function(e) {};
|