2015-10-07 18:49:40 -07:00
|
|
|
<!--
|
|
|
|
@license
|
|
|
|
Copyright (c) 2015 The Polymer Project Authors. All rights reserved.
|
|
|
|
This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
|
|
|
|
The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
|
|
|
|
The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
|
|
|
|
Code distributed by Google as part of the polymer project is also
|
|
|
|
subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
|
|
|
|
-->
|
|
|
|
|
|
|
|
<link rel="import" href="../polymer/polymer.html">
|
|
|
|
<link rel="import" href="../paper-ripple/paper-ripple.html">
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
2015-12-14 08:43:03 -07:00
|
|
|
/**
|
|
|
|
* `Polymer.PaperRippleBehavior` dynamically implements a ripple
|
2015-10-07 18:49:40 -07:00
|
|
|
* when the element has focus via pointer or keyboard.
|
|
|
|
*
|
|
|
|
* NOTE: This behavior is intended to be used in conjunction with and after
|
|
|
|
* `Polymer.IronButtonState` and `Polymer.IronControlState`.
|
|
|
|
*
|
2015-12-14 08:43:03 -07:00
|
|
|
* @polymerBehavior Polymer.PaperRippleBehavior
|
2015-10-07 18:49:40 -07:00
|
|
|
*/
|
|
|
|
Polymer.PaperRippleBehavior = {
|
|
|
|
|
|
|
|
properties: {
|
|
|
|
/**
|
|
|
|
* If true, the element will not produce a ripple effect when interacted
|
|
|
|
* with via the pointer.
|
|
|
|
*/
|
|
|
|
noink: {
|
|
|
|
type: Boolean,
|
|
|
|
observer: '_noinkChanged'
|
2015-12-14 08:43:03 -07:00
|
|
|
},
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @type {Element|undefined}
|
|
|
|
*/
|
|
|
|
_rippleContainer: {
|
|
|
|
type: Object,
|
2015-10-07 18:49:40 -07:00
|
|
|
}
|
|
|
|
},
|
|
|
|
|
|
|
|
/**
|
2015-12-14 08:43:03 -07:00
|
|
|
* Ensures a `<paper-ripple>` element is available when the element is
|
2015-10-07 18:49:40 -07:00
|
|
|
* focused.
|
|
|
|
*/
|
|
|
|
_buttonStateChanged: function() {
|
|
|
|
if (this.focused) {
|
|
|
|
this.ensureRipple();
|
|
|
|
}
|
|
|
|
},
|
|
|
|
|
2015-12-14 08:43:03 -07:00
|
|
|
/**
|
2015-10-07 18:49:40 -07:00
|
|
|
* In addition to the functionality provided in `IronButtonState`, ensures
|
|
|
|
* a ripple effect is created when the element is in a `pressed` state.
|
|
|
|
*/
|
|
|
|
_downHandler: function(event) {
|
|
|
|
Polymer.IronButtonStateImpl._downHandler.call(this, event);
|
|
|
|
if (this.pressed) {
|
|
|
|
this.ensureRipple(event);
|
|
|
|
}
|
|
|
|
},
|
|
|
|
|
|
|
|
/**
|
2015-12-14 08:43:03 -07:00
|
|
|
* Ensures this element contains a ripple effect. For startup efficiency
|
2015-10-07 18:49:40 -07:00
|
|
|
* the ripple effect is dynamically on demand when needed.
|
2015-12-14 08:43:03 -07:00
|
|
|
* @param {!Event=} optTriggeringEvent (optional) event that triggered the
|
2015-10-07 18:49:40 -07:00
|
|
|
* ripple.
|
|
|
|
*/
|
2015-12-14 08:43:03 -07:00
|
|
|
ensureRipple: function(optTriggeringEvent) {
|
2015-10-07 18:49:40 -07:00
|
|
|
if (!this.hasRipple()) {
|
|
|
|
this._ripple = this._createRipple();
|
|
|
|
this._ripple.noink = this.noink;
|
|
|
|
var rippleContainer = this._rippleContainer || this.root;
|
|
|
|
if (rippleContainer) {
|
|
|
|
Polymer.dom(rippleContainer).appendChild(this._ripple);
|
|
|
|
}
|
2015-12-14 08:43:03 -07:00
|
|
|
if (optTriggeringEvent) {
|
|
|
|
// Check if the event happened inside of the ripple container
|
|
|
|
// Fall back to host instead of the root because distributed text
|
|
|
|
// nodes are not valid event targets
|
|
|
|
var domContainer = Polymer.dom(this._rippleContainer || this);
|
|
|
|
var target = Polymer.dom(optTriggeringEvent).rootTarget;
|
|
|
|
if (domContainer.deepContains( /** @type {Node} */(target))) {
|
|
|
|
this._ripple.uiDownAction(optTriggeringEvent);
|
|
|
|
}
|
2015-10-07 18:49:40 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
},
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the `<paper-ripple>` element used by this element to create
|
|
|
|
* ripple effects. The element's ripple is created on demand, when
|
2015-12-14 08:43:03 -07:00
|
|
|
* necessary, and calling this method will force the
|
2015-10-07 18:49:40 -07:00
|
|
|
* ripple to be created.
|
|
|
|
*/
|
|
|
|
getRipple: function() {
|
|
|
|
this.ensureRipple();
|
|
|
|
return this._ripple;
|
|
|
|
},
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns true if this element currently contains a ripple effect.
|
|
|
|
* @return {boolean}
|
|
|
|
*/
|
|
|
|
hasRipple: function() {
|
|
|
|
return Boolean(this._ripple);
|
|
|
|
},
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create the element's ripple effect via creating a `<paper-ripple>`.
|
|
|
|
* Override this method to customize the ripple element.
|
2015-12-14 08:43:03 -07:00
|
|
|
* @return {!PaperRippleElement} Returns a `<paper-ripple>` element.
|
2015-10-07 18:49:40 -07:00
|
|
|
*/
|
|
|
|
_createRipple: function() {
|
2015-12-14 08:43:03 -07:00
|
|
|
return /** @type {!PaperRippleElement} */ (
|
|
|
|
document.createElement('paper-ripple'));
|
2015-10-07 18:49:40 -07:00
|
|
|
},
|
|
|
|
|
|
|
|
_noinkChanged: function(noink) {
|
|
|
|
if (this.hasRipple()) {
|
|
|
|
this._ripple.noink = noink;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
</script>
|