ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update wmts-hidpi, add nicer-api-docs

Browse Source
This commit is contained in:
Andreas Hocevar
2014-05-06 13:02:46 -05:00
parent b3ac1afd00
commit 1e25fc5585
2239 changed files with 3726515 additions and 37010 deletions
Download Patch File Download Diff File Expand all files Collapse all files

178
nicer-api-docs/closure-library/closure/goog/labs/style/pixeldensitymonitor.js Normal file
View File

@@ -0,0 +1,178 @@
// 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.
/**
* @fileoverview Utility class that monitors pixel density ratio changes.
*
* @see ../demos/pixeldensitymonitor.html
*/
goog.provide('goog.labs.style.PixelDensityMonitor');
goog.provide('goog.labs.style.PixelDensityMonitor.Density');
goog.provide('goog.labs.style.PixelDensityMonitor.EventType');
goog.require('goog.events');
goog.require('goog.events.EventTarget');
/**
* Monitors the window for changes to the ratio between device and screen
* pixels, e.g. when the user moves the window from a high density screen to a
* screen with normal density. Dispatches
* goog.labs.style.PixelDensityMonitor.EventType.CHANGE events when the density
* changes between the two predefined values NORMAL and HIGH.
*
* This class uses the window.devicePixelRatio value which is supported in
* WebKit and FF18. If the value does not exist, it will always return a
* NORMAL density. It requires support for MediaQueryList to detect changes to
* the devicePixelRatio.
*
* @param {!goog.dom.DomHelper=} opt_domHelper The DomHelper which contains the
* document associated with the window to listen to. Defaults to the one in
* which this code is executing.
* @constructor
* @extends {goog.events.EventTarget}
*/
goog.labs.style.PixelDensityMonitor = function(opt_domHelper) {
goog.base(this);
/**
* @type {Window}
* @private
*/
this.window_ = opt_domHelper ? opt_domHelper.getWindow() : window;
/**
* The last density that was reported so that changes can be detected.
* @type {goog.labs.style.PixelDensityMonitor.Density}
* @private
*/
this.lastDensity_ = this.getDensity();
/**
* @type {function (MediaQueryList)}
* @private
*/
this.listener_ = goog.bind(this.handleMediaQueryChange_, this);
/**
* The media query list for a query that detects high density, if supported
* by the browser. Because matchMedia returns a new object for every call, it
* needs to be saved here so the listener can be removed when disposing.
* @type {?MediaQueryList}
* @private
*/
this.mediaQueryList_ = this.window_.matchMedia ? this.window_.matchMedia(
goog.labs.style.PixelDensityMonitor.HIGH_DENSITY_QUERY_) : null;
};
goog.inherits(goog.labs.style.PixelDensityMonitor, goog.events.EventTarget);
/**
* The two different pixel density modes on which the various ratios between
* physical and device pixels are mapped.
* @enum {number}
*/
goog.labs.style.PixelDensityMonitor.Density = {
/**
* Mode for older portable devices and desktop screens, defined as having a
* device pixel ratio of less than 1.5.
*/
NORMAL: 1,
/**
* Mode for newer portable devices with a high resolution screen, defined as
* having a device pixel ratio of more than 1.5.
*/
HIGH: 2
};
/**
* The events fired by the PixelDensityMonitor.
* @enum {string}
*/
goog.labs.style.PixelDensityMonitor.EventType = {
/**
* Dispatched when density changes between NORMAL and HIGH.
*/
CHANGE: goog.events.getUniqueId('change')
};
/**
* Minimum ratio between device and screen pixel needed for high density mode.
* @type {number}
* @private
*/
goog.labs.style.PixelDensityMonitor.HIGH_DENSITY_RATIO_ = 1.5;
/**
* Media query that matches for high density.
* @type {string}
* @private
*/
goog.labs.style.PixelDensityMonitor.HIGH_DENSITY_QUERY_ =
'(min-resolution: 1.5dppx), (-webkit-min-device-pixel-ratio: 1.5)';
/**
* Starts monitoring for changes in pixel density.
*/
goog.labs.style.PixelDensityMonitor.prototype.start = function() {
if (this.mediaQueryList_) {
this.mediaQueryList_.addListener(this.listener_);
}
};
/**
* @return {goog.labs.style.PixelDensityMonitor.Density} The density for the
* window.
*/
goog.labs.style.PixelDensityMonitor.prototype.getDensity = function() {
if (this.window_.devicePixelRatio >=
goog.labs.style.PixelDensityMonitor.HIGH_DENSITY_RATIO_) {
return goog.labs.style.PixelDensityMonitor.Density.HIGH;
} else {
return goog.labs.style.PixelDensityMonitor.Density.NORMAL;
}
};
/**
* Handles a change to the media query and checks whether the density has
* changed since the last call.
* @param {MediaQueryList} mql The list of changed media queries.
* @private
*/
goog.labs.style.PixelDensityMonitor.prototype.handleMediaQueryChange_ =
function(mql) {
var newDensity = this.getDensity();
if (this.lastDensity_ != newDensity) {
this.lastDensity_ = newDensity;
this.dispatchEvent(goog.labs.style.PixelDensityMonitor.EventType.CHANGE);
}
};
/** @override */
goog.labs.style.PixelDensityMonitor.prototype.disposeInternal = function() {
if (this.mediaQueryList_) {
this.mediaQueryList_.removeListener(this.listener_);
}
goog.base(this, 'disposeInternal');
};

146
nicer-api-docs/closure-library/closure/goog/labs/style/pixeldensitymonitor_test.js Normal file
View File

@@ -0,0 +1,146 @@
// 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.
/**
* @fileoverview Tests for goog.labs.style.PixelDensityMonitor.
*
*/
goog.provide('goog.labs.style.PixelDensityMonitorTest');
goog.setTestOnly('goog.labs.style.PixelDensityMonitorTest');
goog.require('goog.array');
goog.require('goog.dom.DomHelper');
goog.require('goog.events');
goog.require('goog.labs.style.PixelDensityMonitor');
goog.require('goog.testing.MockControl');
goog.require('goog.testing.jsunit');
goog.require('goog.testing.recordFunction');
var fakeWindow;
var recordFunction;
var monitor;
var mockControl;
var mediaQueryLists;
function setUp() {
recordFunction = goog.testing.recordFunction();
mediaQueryLists = [];
mockControl = new goog.testing.MockControl();
}
function tearDown() {
mockControl.$verifyAll();
goog.dispose(monitor);
goog.dispose(recordFunction);
}
function setUpMonitor(initialRatio, hasMatchMedia) {
fakeWindow = {
devicePixelRatio: initialRatio
};
if (hasMatchMedia) {
// Every call to matchMedia should return a new media query list with its
// own set of listeners.
fakeWindow.matchMedia = function(query) {
var listeners = [];
var newList = {
addListener: function(listener) {
listeners.push(listener);
},
removeListener: function(listener) {
goog.array.remove(listeners, listener);
},
callListeners: function() {
for (var i = 0; i < listeners.length; i++) {
listeners[i]();
}
},
getListenerCount: function() {
return listeners.length;
}
};
mediaQueryLists.push(newList);
return newList;
};
}
var domHelper = mockControl.createStrictMock(goog.dom.DomHelper);
domHelper.getWindow().$returns(fakeWindow);
mockControl.$replayAll();
monitor = new goog.labs.style.PixelDensityMonitor(domHelper);
goog.events.listen(monitor,
goog.labs.style.PixelDensityMonitor.EventType.CHANGE, recordFunction);
}
function setNewRatio(newRatio) {
fakeWindow.devicePixelRatio = newRatio;
for (var i = 0; i < mediaQueryLists.length; i++) {
mediaQueryLists[i].callListeners();
}
}
function testNormalDensity() {
setUpMonitor(1, false);
assertEquals(goog.labs.style.PixelDensityMonitor.Density.NORMAL,
monitor.getDensity());
}
function testHighDensity() {
setUpMonitor(1.5, false);
assertEquals(goog.labs.style.PixelDensityMonitor.Density.HIGH,
monitor.getDensity());
}
function testNormalDensityIfUndefined() {
setUpMonitor(undefined, false);
assertEquals(goog.labs.style.PixelDensityMonitor.Density.NORMAL,
monitor.getDensity());
}
function testChangeEvent() {
setUpMonitor(1, true);
assertEquals(goog.labs.style.PixelDensityMonitor.Density.NORMAL,
monitor.getDensity());
monitor.start();
setNewRatio(2);
var call = recordFunction.popLastCall();
assertEquals(goog.labs.style.PixelDensityMonitor.Density.HIGH,
call.getArgument(0).target.getDensity());
assertEquals(goog.labs.style.PixelDensityMonitor.Density.HIGH,
monitor.getDensity());
setNewRatio(1);
call = recordFunction.popLastCall();
assertEquals(goog.labs.style.PixelDensityMonitor.Density.NORMAL,
call.getArgument(0).target.getDensity());
assertEquals(goog.labs.style.PixelDensityMonitor.Density.NORMAL,
monitor.getDensity());
}
function testListenerIsDisposed() {
setUpMonitor(1, true);
monitor.start();
assertEquals(1, mediaQueryLists.length);
assertEquals(1, mediaQueryLists[0].getListenerCount());
goog.dispose(monitor);
assertEquals(1, mediaQueryLists.length);
assertEquals(0, mediaQueryLists[0].getListenerCount());
}