blob: 00d1c867e9d3257afdc7ba30e1122faf3d9996d8 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
/**
* @fileoverview This implements a splitter element which can be used to resize
* elements in split panes.
*
* The parent of the splitter should be an hbox (display: -webkit-box) with at
* least one previous element sibling. The splitter controls the width of the
* element before it.
*
* <div class=split-pane>
* <div class=left>...</div>
* <div class=splitter></div>
* ...
* </div>
*
*/
cr.define('cr.ui', function() {
// TODO(arv): Currently this only supports horizontal layout.
// TODO(arv): This ignores min-width and max-width of the elements to the
// right of the splitter.
/**
* Returns the computed style width of an element.
* @param {!Element} el The element to get the width of.
* @return {number} The width in pixels.
*/
function getComputedWidth(el) {
return parseFloat(el.ownerDocument.defaultView.getComputedStyle(el).width) /
getZoomFactor(el.ownerDocument);
}
/**
* This uses a WebKit bug to work around the same bug. getComputedStyle does
* not take the page zoom into account so it returns the physical pixels
* instead of the logical pixel size.
* @param {!Document} doc The document to get the page zoom factor for.
* @return {number} The zoom factor of the document.
*/
function getZoomFactor(doc) {
const dummyElement = doc.createElement('div');
dummyElement.style.cssText = 'position:absolute;width:100px;height:100px;' +
'top:-1000px;overflow:hidden';
doc.body.appendChild(dummyElement);
const cs = doc.defaultView.getComputedStyle(dummyElement);
const rect = dummyElement.getBoundingClientRect();
const zoomFactor = parseFloat(cs.width) / 100;
doc.body.removeChild(dummyElement);
return zoomFactor;
}
/**
* Creates a new splitter element.
* @param {Object=} opt_propertyBag Optional properties.
* @constructor
* @extends {HTMLDivElement}
*/
const Splitter = cr.ui.define('div');
Splitter.prototype = {
__proto__: HTMLDivElement.prototype,
/**
* Initializes the element.
*/
decorate: function() {
this.addEventListener(
'mousedown', this.handleMouseDown_.bind(this), true);
this.addEventListener(
'touchstart', this.handleTouchStart_.bind(this), true);
this.resizeNextElement_ = false;
},
/**
* @param {boolean} resizeNext True if resize the next element.
* By default, splitter resizes previous (left) element.
*/
set resizeNextElement(resizeNext) {
this.resizeNextElement_ = resizeNext;
},
/**
* Starts the dragging of the splitter. Adds listeners for mouse or touch
* events and calls splitter drag start handler.
* @param {number} clientX X position of the mouse or touch event that
* started the drag.
* @param {boolean} isTouchEvent True if the drag started by touch event.
*/
startDrag: function(clientX, isTouchEvent) {
if (this.handlers_) {
console.log('Concurent drags');
this.endDrag_();
}
if (isTouchEvent) {
const endDragBound = this.endDrag_.bind(this);
this.handlers_ = {
'touchmove': this.handleTouchMove_.bind(this),
'touchend': endDragBound,
'touchcancel': endDragBound,
// Another touch start (we somehow missed touchend or touchcancel).
'touchstart': endDragBound,
};
} else {
this.handlers_ = {
'mousemove': this.handleMouseMove_.bind(this),
'mouseup': this.handleMouseUp_.bind(this),
};
}
const doc = this.ownerDocument;
// Use capturing events on the document to get events when the mouse
// leaves the document.
for (const eventType in this.handlers_) {
doc.addEventListener(eventType, this.handlers_[eventType], true);
}
this.startX_ = clientX;
this.handleSplitterDragStart();
},
/**
* Ends the dragging of the splitter. Removes listeners set in startDrag
* and calls splitter drag end handler.
* @private
*/
endDrag_: function() {
const doc = this.ownerDocument;
for (const eventType in this.handlers_) {
doc.removeEventListener(eventType, this.handlers_[eventType], true);
}
this.handlers_ = null;
this.handleSplitterDragEnd();
},
/**
* @return {Element}
* @private
*/
getResizeTarget_: function() {
return this.resizeNextElement_ ? this.nextElementSibling :
this.previousElementSibling;
},
/**
* Calculate width to resize target element.
* @param {number} deltaX horizontal drag amount
* @return {number}
* @private
*/
calcDeltaX_: function(deltaX) {
return this.resizeNextElement_ ? -deltaX : deltaX;
},
/**
* Handles the mousedown event which starts the dragging of the splitter.
* @param {!Event} e The mouse event.
* @private
*/
handleMouseDown_: function(e) {
e = /** @type {!MouseEvent} */ (e);
if (e.button) {
return;
}
this.startDrag(e.clientX, false);
// Default action is to start selection and to move focus.
e.preventDefault();
},
/**
* Handles the touchstart event which starts the dragging of the splitter.
* @param {!Event} e The touch event.
* @private
*/
handleTouchStart_: function(e) {
e = /** @type {!TouchEvent} */ (e);
if (e.touches.length == 1) {
this.startDrag(e.touches[0].clientX, true);
e.preventDefault();
}
},
/**
* Handles the mousemove event which moves the splitter as the user moves
* the mouse.
* @param {!MouseEvent} e The mouse event.
* @private
*/
handleMouseMove_: function(e) {
this.handleMove_(e.clientX);
},
/**
* Handles the touch move event.
* @param {!TouchEvent} e The touch event.
*/
handleTouchMove_: function(e) {
if (e.touches.length == 1) {
this.handleMove_(e.touches[0].clientX);
}
},
/**
* Common part of handling mousemove and touchmove. Calls splitter drag
* move handler.
* @param {number} clientX X position of the mouse or touch event.
* @private
*/
handleMove_: function(clientX) {
const rtl =
this.ownerDocument.defaultView.getComputedStyle(this).direction ==
'rtl';
const dirMultiplier = rtl ? -1 : 1;
const deltaX = dirMultiplier * (clientX - this.startX_);
this.handleSplitterDragMove(deltaX);
},
/**
* Handles the mouse up event which ends the dragging of the splitter.
* @param {!MouseEvent} e The mouse event.
* @private
*/
handleMouseUp_: function(e) {
this.endDrag_();
},
/**
* Handles start of the splitter dragging. Saves current width of the
* element being resized.
*/
handleSplitterDragStart: function() {
// Use the computed width style as the base so that we can ignore what
// box sizing the element has. Add the difference between offset and
// client widths to account for any scrollbars.
const targetElement = this.getResizeTarget_();
const doc = targetElement.ownerDocument;
this.startWidth_ =
parseFloat(doc.defaultView.getComputedStyle(targetElement).width) +
targetElement.offsetWidth - targetElement.clientWidth;
this.classList.add('splitter-active');
},
/**
* Handles splitter moves. Updates width of the element being resized.
* @param {number} deltaX The change of splitter horizontal position.
*/
handleSplitterDragMove: function(deltaX) {
const targetElement = this.getResizeTarget_();
const newWidth = this.startWidth_ + this.calcDeltaX_(deltaX);
targetElement.style.width = newWidth + 'px';
cr.dispatchSimpleEvent(this, 'dragmove');
},
/**
* Handles end of the splitter dragging. This fires a 'resize' event if the
* size changed.
*/
handleSplitterDragEnd: function() {
// Check if the size changed.
const targetElement = this.getResizeTarget_();
const doc = targetElement.ownerDocument;
const computedWidth =
parseFloat(doc.defaultView.getComputedStyle(targetElement).width);
if (this.startWidth_ != computedWidth) {
cr.dispatchSimpleEvent(this, 'resize');
}
this.classList.remove('splitter-active');
},
};
return {Splitter: Splitter};
});