47 lines
1.3 KiB
JavaScript
47 lines
1.3 KiB
JavaScript
|
// Copyright 2013 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.
|
||
|
|
||
|
goog.provide('goog.events.EventId');
|
||
|
|
||
|
|
||
|
|
||
|
/**
|
||
|
* A templated class that is used when registering for events. Typical usage:
|
||
|
*
|
||
|
* /** @type {goog.events.EventId<MyEventObj>} *\
|
||
|
* var myEventId = new goog.events.EventId(
|
||
|
* goog.events.getUniqueId(('someEvent'));
|
||
|
*
|
||
|
* // No need to cast or declare here since the compiler knows the
|
||
|
* // correct type of 'evt' (MyEventObj).
|
||
|
* something.listen(myEventId, function(evt) {});
|
||
|
*
|
||
|
* @param {string} eventId
|
||
|
* @template T
|
||
|
* @constructor
|
||
|
* @struct
|
||
|
* @final
|
||
|
*/
|
||
|
goog.events.EventId = function(eventId) {
|
||
|
/** @const */ this.id = eventId;
|
||
|
};
|
||
|
|
||
|
|
||
|
/**
|
||
|
* @override
|
||
|
*/
|
||
|
goog.events.EventId.prototype.toString = function() {
|
||
|
return this.id;
|
||
|
};
|