257 lines
8.2 KiB
JavaScript
257 lines
8.2 KiB
JavaScript
/*
|
|
Copyright (c) 2004-2011, The Dojo Foundation All Rights Reserved.
|
|
Available via Academic Free License >= 2.1 OR the modified BSD license.
|
|
see: http://dojotoolkit.org/license for details
|
|
*/
|
|
|
|
|
|
if(!dojo._hasResource["dijit.TitlePane"]){ //_hasResource checks added by build. Do not use _hasResource directly in your code.
|
|
dojo._hasResource["dijit.TitlePane"] = true;
|
|
dojo.provide("dijit.TitlePane");
|
|
dojo.require("dojo.fx");
|
|
dojo.require("dijit._Templated");
|
|
dojo.require("dijit.layout.ContentPane");
|
|
dojo.require("dijit._CssStateMixin");
|
|
|
|
|
|
dojo.declare(
|
|
"dijit.TitlePane",
|
|
[dijit.layout.ContentPane, dijit._Templated, dijit._CssStateMixin],
|
|
{
|
|
// summary:
|
|
// A pane with a title on top, that can be expanded or collapsed.
|
|
//
|
|
// description:
|
|
// An accessible container with a title Heading, and a content
|
|
// section that slides open and closed. TitlePane is an extension to
|
|
// `dijit.layout.ContentPane`, providing all the useful content-control aspects from it.
|
|
//
|
|
// example:
|
|
// | // load a TitlePane from remote file:
|
|
// | var foo = new dijit.TitlePane({ href: "foobar.html", title:"Title" });
|
|
// | foo.startup();
|
|
//
|
|
// example:
|
|
// | <!-- markup href example: -->
|
|
// | <div dojoType="dijit.TitlePane" href="foobar.html" title="Title"></div>
|
|
//
|
|
// example:
|
|
// | <!-- markup with inline data -->
|
|
// | <div dojoType="dijit.TitlePane" title="Title">
|
|
// | <p>I am content</p>
|
|
// | </div>
|
|
|
|
// title: String
|
|
// Title of the pane
|
|
title: "",
|
|
|
|
// open: Boolean
|
|
// Whether pane is opened or closed.
|
|
open: true,
|
|
|
|
// toggleable: Boolean
|
|
// Whether pane can be opened or closed by clicking the title bar.
|
|
toggleable: true,
|
|
|
|
// tabIndex: String
|
|
// Tabindex setting for the title (so users can tab to the title then
|
|
// use space/enter to open/close the title pane)
|
|
tabIndex: "0",
|
|
|
|
// duration: Integer
|
|
// Time in milliseconds to fade in/fade out
|
|
duration: dijit.defaultDuration,
|
|
|
|
// baseClass: [protected] String
|
|
// The root className to be placed on this widget's domNode.
|
|
baseClass: "dijitTitlePane",
|
|
|
|
templateString: dojo.cache("dijit", "templates/TitlePane.html", "<div>\n\t<div dojoAttachEvent=\"onclick:_onTitleClick, onkeypress:_onTitleKey\"\n\t\t\tclass=\"dijitTitlePaneTitle\" dojoAttachPoint=\"titleBarNode\">\n\t\t<div class=\"dijitTitlePaneTitleFocus\" dojoAttachPoint=\"focusNode\">\n\t\t\t<img src=\"${_blankGif}\" alt=\"\" dojoAttachPoint=\"arrowNode\" class=\"dijitArrowNode\" role=\"presentation\"\n\t\t\t/><span dojoAttachPoint=\"arrowNodeInner\" class=\"dijitArrowNodeInner\"></span\n\t\t\t><span dojoAttachPoint=\"titleNode\" class=\"dijitTitlePaneTextNode\"></span>\n\t\t</div>\n\t</div>\n\t<div class=\"dijitTitlePaneContentOuter\" dojoAttachPoint=\"hideNode\" role=\"presentation\">\n\t\t<div class=\"dijitReset\" dojoAttachPoint=\"wipeNode\" role=\"presentation\">\n\t\t\t<div class=\"dijitTitlePaneContentInner\" dojoAttachPoint=\"containerNode\" role=\"region\" id=\"${id}_pane\">\n\t\t\t\t<!-- nested divs because wipeIn()/wipeOut() doesn't work right on node w/padding etc. Put padding on inner div. -->\n\t\t\t</div>\n\t\t</div>\n\t</div>\n</div>\n"),
|
|
|
|
attributeMap: dojo.delegate(dijit.layout.ContentPane.prototype.attributeMap, {
|
|
title: { node: "titleNode", type: "innerHTML" },
|
|
tooltip: {node: "focusNode", type: "attribute", attribute: "title"}, // focusNode spans the entire width, titleNode doesn't
|
|
id:""
|
|
}),
|
|
|
|
buildRendering: function(){
|
|
this.inherited(arguments);
|
|
dojo.setSelectable(this.titleNode, false);
|
|
},
|
|
|
|
postCreate: function(){
|
|
this.inherited(arguments);
|
|
|
|
// Hover and focus effect on title bar, except for non-toggleable TitlePanes
|
|
// This should really be controlled from _setToggleableAttr() but _CssStateMixin
|
|
// doesn't provide a way to disconnect a previous _trackMouseState() call
|
|
if(this.toggleable){
|
|
this._trackMouseState(this.titleBarNode, "dijitTitlePaneTitle");
|
|
}
|
|
|
|
// setup open/close animations
|
|
var hideNode = this.hideNode, wipeNode = this.wipeNode;
|
|
this._wipeIn = dojo.fx.wipeIn({
|
|
node: this.wipeNode,
|
|
duration: this.duration,
|
|
beforeBegin: function(){
|
|
hideNode.style.display="";
|
|
}
|
|
});
|
|
this._wipeOut = dojo.fx.wipeOut({
|
|
node: this.wipeNode,
|
|
duration: this.duration,
|
|
onEnd: function(){
|
|
hideNode.style.display="none";
|
|
}
|
|
});
|
|
},
|
|
|
|
_setOpenAttr: function(/*Boolean*/ open, /*Boolean*/ animate){
|
|
// summary:
|
|
// Hook to make set("open", boolean) control the open/closed state of the pane.
|
|
// open: Boolean
|
|
// True if you want to open the pane, false if you want to close it.
|
|
|
|
dojo.forEach([this._wipeIn, this._wipeOut], function(animation){
|
|
if(animation && animation.status() == "playing"){
|
|
animation.stop();
|
|
}
|
|
});
|
|
|
|
if(animate){
|
|
var anim = this[open ? "_wipeIn" : "_wipeOut"];
|
|
anim.play();
|
|
}else{
|
|
this.hideNode.style.display = this.wipeNode.style.display = open ? "" : "none";
|
|
}
|
|
|
|
// load content (if this is the first time we are opening the TitlePane
|
|
// and content is specified as an href, or href was set when hidden)
|
|
if(this._started){
|
|
if(open){
|
|
this._onShow();
|
|
}else{
|
|
this.onHide();
|
|
}
|
|
}
|
|
|
|
this.arrowNodeInner.innerHTML = open ? "-" : "+";
|
|
|
|
dijit.setWaiState(this.containerNode,"hidden", open ? "false" : "true");
|
|
dijit.setWaiState(this.focusNode, "pressed", open ? "true" : "false");
|
|
|
|
this._set("open", open);
|
|
|
|
this._setCss();
|
|
},
|
|
|
|
_setToggleableAttr: function(/*Boolean*/ canToggle){
|
|
// summary:
|
|
// Hook to make set("toggleable", boolean) work.
|
|
// canToggle: Boolean
|
|
// True to allow user to open/close pane by clicking title bar.
|
|
|
|
dijit.setWaiRole(this.focusNode, canToggle ? "button" : "heading");
|
|
if(canToggle){
|
|
// TODO: if canToggle is switched from true to false shouldn't we remove this setting?
|
|
dijit.setWaiState(this.focusNode, "controls", this.id+"_pane");
|
|
dojo.attr(this.focusNode, "tabIndex", this.tabIndex);
|
|
}else{
|
|
dojo.removeAttr(this.focusNode, "tabIndex");
|
|
}
|
|
|
|
this._set("toggleable", canToggle);
|
|
|
|
this._setCss();
|
|
},
|
|
|
|
_setContentAttr: function(/*String|DomNode|Nodelist*/ content){
|
|
// summary:
|
|
// Hook to make set("content", ...) work.
|
|
// Typically called when an href is loaded. Our job is to make the animation smooth.
|
|
|
|
if(!this.open || !this._wipeOut || this._wipeOut.status() == "playing"){
|
|
// we are currently *closing* the pane (or the pane is closed), so just let that continue
|
|
this.inherited(arguments);
|
|
}else{
|
|
if(this._wipeIn && this._wipeIn.status() == "playing"){
|
|
this._wipeIn.stop();
|
|
}
|
|
|
|
// freeze container at current height so that adding new content doesn't make it jump
|
|
dojo.marginBox(this.wipeNode, { h: dojo.marginBox(this.wipeNode).h });
|
|
|
|
// add the new content (erasing the old content, if any)
|
|
this.inherited(arguments);
|
|
|
|
// call _wipeIn.play() to animate from current height to new height
|
|
if(this._wipeIn){
|
|
this._wipeIn.play();
|
|
}else{
|
|
this.hideNode.style.display = "";
|
|
}
|
|
}
|
|
},
|
|
|
|
toggle: function(){
|
|
// summary:
|
|
// Switches between opened and closed state
|
|
// tags:
|
|
// private
|
|
|
|
this._setOpenAttr(!this.open, true);
|
|
},
|
|
|
|
_setCss: function(){
|
|
// summary:
|
|
// Set the open/close css state for the TitlePane
|
|
// tags:
|
|
// private
|
|
|
|
var node = this.titleBarNode || this.focusNode;
|
|
var oldCls = this._titleBarClass;
|
|
this._titleBarClass = "dijit" + (this.toggleable ? "" : "Fixed") + (this.open ? "Open" : "Closed");
|
|
dojo.replaceClass(node, this._titleBarClass, oldCls || "");
|
|
|
|
this.arrowNodeInner.innerHTML = this.open ? "-" : "+";
|
|
},
|
|
|
|
_onTitleKey: function(/*Event*/ e){
|
|
// summary:
|
|
// Handler for when user hits a key
|
|
// tags:
|
|
// private
|
|
|
|
if(e.charOrCode == dojo.keys.ENTER || e.charOrCode == ' '){
|
|
if(this.toggleable){
|
|
this.toggle();
|
|
}
|
|
dojo.stopEvent(e);
|
|
}else if(e.charOrCode == dojo.keys.DOWN_ARROW && this.open){
|
|
this.containerNode.focus();
|
|
e.preventDefault();
|
|
}
|
|
},
|
|
|
|
_onTitleClick: function(){
|
|
// summary:
|
|
// Handler when user clicks the title bar
|
|
// tags:
|
|
// private
|
|
if(this.toggleable){
|
|
this.toggle();
|
|
}
|
|
},
|
|
|
|
setTitle: function(/*String*/ title){
|
|
// summary:
|
|
// Deprecated. Use set('title', ...) instead.
|
|
// tags:
|
|
// deprecated
|
|
dojo.deprecated("dijit.TitlePane.setTitle() is deprecated. Use set('title', ...) instead.", "", "2.0");
|
|
this.set("title", title);
|
|
}
|
|
});
|
|
|
|
}
|