2 * jQuery.splitter.js - two-pane splitter window plugin
4 * version 1.51 (2009/01/09)
6 * Dual licensed under the MIT and GPL licenses:
7 * http://www.opensource.org/licenses/mit-license.php
8 * http://www.gnu.org/licenses/gpl.html
12 * The splitter() plugin implements a two-pane resizable splitter window.
13 * The selected elements in the jQuery object are converted to a splitter;
14 * each selected element should have two child elements, used for the panes
15 * of the splitter. The plugin adds a third child element for the splitbar.
17 * For more details see: http://methvin.com/splitter/
20 * @example $('#MySplitter').splitter();
21 * @desc Create a vertical splitter with default settings
23 * @example $('#MySplitter').splitter({type: 'h', accessKey: 'M'});
24 * @desc Create a horizontal splitter resizable via Alt+Shift+M
28 * @param Object options Options for the splitter (not required)
29 * @cat Plugins/Splitter
31 * @author Dave Methvin (dave.methvin@gmail.com)
35 $.fn.splitter = function(args){
37 return this.each(function() {
38 var zombie; // left-behind splitbar for outline resizes
39 function startSplitMouse(evt) {
41 zombie = zombie || bar.clone(false).insertAfter(A);
42 panes.css("-webkit-user-select", "none"); // Safari selects A/B text on a move
43 bar.addClass(opts.activeClass);
44 A._posSplit = A[0][opts.pxSplit] - evt[opts.eventPos];
46 .bind("mousemove", doSplitMouse)
47 .bind("mouseup", endSplitMouse);
49 function doSplitMouse(evt) {
50 var newPos = A._posSplit+evt[opts.eventPos];
52 newPos = Math.max(0, Math.min(newPos, splitter._DA - bar._DA));
53 bar.css(opts.origin, newPos);
57 function endSplitMouse(evt) {
58 bar.removeClass(opts.activeClass);
59 var newPos = A._posSplit+evt[opts.eventPos];
61 zombie.remove(); zombie = null;
64 panes.css("-webkit-user-select", "text"); // let Safari select text again
66 .unbind("mousemove", doSplitMouse)
67 .unbind("mouseup", endSplitMouse);
69 function resplit(newPos) {
70 // Constrain new splitbar position to fit pane size limits
71 newPos = Math.max(A._min, splitter._DA - B._max,
72 Math.min(newPos, A._max, splitter._DA - bar._DA - B._min));
73 // Resize/position the two panes
74 bar._DA = bar[0][opts.pxSplit]; // bar size may change during dock
75 bar.css(opts.origin, newPos).css(opts.fixed, splitter._DF);
76 A.css(opts.origin, 0).css(opts.split, newPos).css(opts.fixed, splitter._DF);
77 B.css(opts.origin, newPos+bar._DA)
78 .css(opts.split, splitter._DA-bar._DA-newPos).css(opts.fixed, splitter._DF);
79 // IE fires resize for us; all others pay cash
80 if ( !$.browser.msie )
81 panes.trigger("resize");
83 function dimSum(jq, dims) {
84 // Opera returns -1 for missing min/max width, turn into 0
86 for ( var i=1; i < arguments.length; i++ )
87 sum += Math.max(parseInt(jq.css(arguments[i])) || 0, 0);
91 // Determine settings based on incoming opts, element classes, and defaults
92 var vh = (args.splitHorizontal? 'h' : args.splitVertical? 'v' : args.type) || 'v';
94 activeClass: 'active', // class name for active splitter
95 pxPerKey: 8, // splitter px moved per keypress
96 tabIndex: 0, // tab order indicator
97 accessKey: '' // accessKey for splitbar
99 v: { // Vertical splitters:
100 keyLeft: 39, keyRight: 37, cursor: "e-resize",
101 splitbarClass: "vsplitbar", outlineClass: "voutline",
102 type: 'v', eventPos: "pageX", origin: "left",
103 split: "width", pxSplit: "offsetWidth", side1: "Left", side2: "Right",
104 fixed: "height", pxFixed: "offsetHeight", side3: "Top", side4: "Bottom"
106 h: { // Horizontal splitters:
107 keyTop: 40, keyBottom: 38, cursor: "n-resize",
108 splitbarClass: "hsplitbar", outlineClass: "houtline",
109 type: 'h', eventPos: "pageY", origin: "top",
110 split: "height", pxSplit: "offsetHeight", side1: "Top", side2: "Bottom",
111 fixed: "width", pxFixed: "offsetWidth", side3: "Left", side4: "Right"
115 // Create jQuery object closures for splitter and both panes
116 var splitter = $(this).css({position: "relative"});
117 var panes = $(">*", splitter[0]).css({
118 position: "absolute", // positioned inside splitter container
119 "z-index": "1", // splitbar is positioned above
120 "-moz-outline-style": "none" // don't show dotted outline
122 var A = $(panes[0]); // left or top
123 var B = $(panes[1]); // right or bottom
125 // Focuser element, provides keyboard support; title is shown by Opera accessKeys
126 var focuser = $('<a href="javascript:void(0)"></a>')
127 .attr({accessKey: opts.accessKey, tabIndex: opts.tabIndex, title: opts.splitbarClass})
128 .bind($.browser.opera?"click":"focus", function(){ this.focus(); bar.addClass(opts.activeClass) })
129 .bind("keydown", function(e){
130 var key = e.which || e.keyCode;
131 var dir = key==opts["key"+opts.side1]? 1 : key==opts["key"+opts.side2]? -1 : 0;
133 resplit(A[0][opts.pxSplit]+dir*opts.pxPerKey, false);
135 .bind("blur", function(){ bar.removeClass(opts.activeClass) });
137 // Splitbar element, can be already in the doc or we create one
138 var bar = $(panes[2] || '<div></div>')
139 .insertAfter(A).css("z-index", "100").append(focuser)
140 .attr({"class": opts.splitbarClass, unselectable: "on"})
141 .css({position: "absolute", "user-select": "none", "-webkit-user-select": "none",
142 "-khtml-user-select": "none", "-moz-user-select": "none"})
143 .bind("mousedown", startSplitMouse);
144 // Use our cursor unless the style specifies a non-default cursor
145 if ( /^(auto|default|)$/.test(bar.css("cursor")) )
146 bar.css("cursor", opts.cursor);
148 // Cache several dimensions for speed, rather than re-querying constantly
149 bar._DA = bar[0][opts.pxSplit];
150 splitter._PBF = $.boxModel? dimSum(splitter, "border"+opts.side3+"Width", "border"+opts.side4+"Width") : 0;
151 splitter._PBA = $.boxModel? dimSum(splitter, "border"+opts.side1+"Width", "border"+opts.side2+"Width") : 0;
152 A._pane = opts.side1;
153 B._pane = opts.side2;
154 $.each([A,B], function(){
155 this._min = opts["min"+this._pane] || dimSum(this, "min-"+opts.split);
156 this._max = opts["max"+this._pane] || dimSum(this, "max-"+opts.split) || 9999;
157 this._init = opts["size"+this._pane]===true ?
158 parseInt($.curCSS(this[0],opts.split)) : opts["size"+this._pane];
161 // Determine initial position, get from cookie if specified
162 var initPos = A._init;
163 if ( !isNaN(B._init) ) // recalc initial B size as an offset from the top or left side
164 initPos = splitter[0][opts.pxSplit] - splitter._PBA - B._init - bar._DA;
167 alert('jQuery.splitter(): jQuery cookie plugin required');
168 var ckpos = parseInt($.cookie(opts.cookie));
171 $(window).bind("unload", function(){
172 var state = String(bar.css(opts.origin)); // current location of splitbar
173 $.cookie(opts.cookie, state, {expires: opts.cookieExpires || 365,
174 path: opts.cookiePath || document.location.pathname});
177 if ( isNaN(initPos) ) // King Solomon's algorithm
178 initPos = Math.round((splitter[0][opts.pxSplit] - splitter._PBA - bar._DA)/2);
180 // Resize event propagation and splitter sizing
181 if ( opts.anchorToWindow ) {
182 // Account for margin or border on the splitter container and enforce min height
183 splitter._hadjust = dimSum(splitter, "borderTopWidth", "borderBottomWidth", "marginBottom");
184 splitter._hmin = Math.max(dimSum(splitter, "minHeight"), 20);
185 $(window).bind("resize", function(){
186 var top = splitter.offset().top;
187 var wh = $(window).height();
188 splitter.css("height", Math.max(wh-top-splitter._hadjust, splitter._hmin)+"px");
189 if ( !$.browser.msie ) splitter.trigger("resize");
190 }).trigger("resize");
192 else if ( opts.resizeToWidth && !$.browser.msie )
193 $(window).bind("resize", function(){
194 splitter.trigger("resize");
197 // Resize event handler; triggered immediately to set initial position
198 splitter.bind("resize", function(e, size){
199 // Custom events bubble in jQuery 1.3; don't Yo Dawg
200 if ( e.target != this ) return;
201 // Determine new width/height of splitter container
202 splitter._DF = splitter[0][opts.pxFixed] - splitter._PBF;
203 splitter._DA = splitter[0][opts.pxSplit] - splitter._PBA;
204 // Bail if splitter isn't visible or content isn't there yet
205 if ( splitter._DF <= 0 || splitter._DA <= 0 ) return;
206 // Re-divvy the adjustable dimension; maintain size of the preferred pane
207 resplit(!isNaN(size)? size : (!(opts.sizeRight||opts.sizeBottom)? A[0][opts.pxSplit] :
208 splitter._DA-B[0][opts.pxSplit]-bar._DA));
209 }).trigger("resize" , [initPos]);