accessibility-developer-tools
Version:
This is a library of accessibility-related testing and utility code.
99 lines (82 loc) • 3.22 kB
JavaScript
// Copyright 2007 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 Menu item observing the filter text in a
* {@link goog.ui.FilteredMenu}. The observer method is called when the filter
* text changes and allows the menu item to update its content and state based
* on the filter.
*
* @author eae@google.com (Emil A Eklund)
*/
goog.provide('goog.ui.FilterObservingMenuItem');
goog.require('goog.ui.FilterObservingMenuItemRenderer');
goog.require('goog.ui.MenuItem');
goog.require('goog.ui.registry');
/**
* Class representing a filter observing menu item.
*
* @param {goog.ui.ControlContent} content Text caption or DOM structure to
* display as the content of the item (use to add icons or styling to
* menus).
* @param {*=} opt_model Data/model associated with the menu item.
* @param {goog.dom.DomHelper=} opt_domHelper Optional DOM helper used for
* document interactions.
* @param {goog.ui.MenuItemRenderer=} opt_renderer Optional renderer.
* @constructor
* @extends {goog.ui.MenuItem}
*/
goog.ui.FilterObservingMenuItem = function(
content, opt_model, opt_domHelper, opt_renderer) {
goog.ui.MenuItem.call(
this, content, opt_model, opt_domHelper,
opt_renderer || new goog.ui.FilterObservingMenuItemRenderer());
};
goog.inherits(goog.ui.FilterObservingMenuItem, goog.ui.MenuItem);
goog.tagUnsealableClass(goog.ui.FilterObservingMenuItem);
/**
* Function called when the filter text changes.
* @type {Function} function(goog.ui.FilterObservingMenuItem, string)
* @private
*/
goog.ui.FilterObservingMenuItem.prototype.observer_ = null;
/** @override */
goog.ui.FilterObservingMenuItem.prototype.enterDocument = function() {
goog.ui.FilterObservingMenuItem.superClass_.enterDocument.call(this);
this.callObserver();
};
/**
* Sets the observer functions.
* @param {Function} f function(goog.ui.FilterObservingMenuItem, string).
*/
goog.ui.FilterObservingMenuItem.prototype.setObserver = function(f) {
this.observer_ = f;
this.callObserver();
};
/**
* Calls the observer function if one has been specified.
* @param {?string=} opt_str Filter string.
*/
goog.ui.FilterObservingMenuItem.prototype.callObserver = function(opt_str) {
if (this.observer_) {
this.observer_(this, opt_str || '');
}
};
// Register a decorator factory function for
// goog.ui.FilterObservingMenuItemRenderer.
goog.ui.registry.setDecoratorByClassName(
goog.ui.FilterObservingMenuItemRenderer.CSS_CLASS, function() {
// FilterObservingMenuItem defaults to using
// FilterObservingMenuItemRenderer.
return new goog.ui.FilterObservingMenuItem(null);
});