Item1156: Create Release01x00 branch

git-svn-id: http://svn.foswiki.org/branches/Release01x00@2736 0b4bb1d4-4e5a-0410-9cc4-b2b747904278

TwistyPlugin/lib/Foswiki/Plugins/TwistyPlugin/DEPENDENCIES

@@ -0,0 +1,3 @@
+Foswiki::Contrib::BehaviourContrib,>=0,perl,Required if using default Foswiki twisties.
+TWiki::Plugins::JQueryPlugin,>=0.5,perl,Required if using jquery twisties.
+TWiki::Plugins::DojoToolkitContrib,>=0,perl,Required if using dojo twisties.

TwistyPlugin/lib/Foswiki/Plugins/TwistyPlugin/MANIFEST

@@ -0,0 +1,11 @@
+data/System/TwistyPlugin.txt 0644
+lib/Foswiki/Plugins/TwistyPlugin.pm 0444
+pub/System/TwistyPlugin/twisty.js 0644
+pub/System/TwistyPlugin/twisty.css 0644
+pub/System/TwistyPlugin/twisty.dojo.js 0644
+pub/System/TwistyPlugin/twisty.jquery.css 0644
+pub/System/TwistyPlugin/twisty.jquery.js 0644
+templates/twistyplugin.tmpl 0444
+templates/twistyplugin.dojo.tmpl 0444 Template for DojoToolkitContrib twisties
+templates/twistyplugin.jquery.tmpl 0444 Template for JQueryPlugin twisties
+templates/twistyplugin.pattern.tmpl 0444 Template for default twisties with PatternSkin

TwistyPlugin/lib/Foswiki/Plugins/TwistyPlugin/build.pl

@@ -0,0 +1,18 @@
+#!/usr/bin/perl -w
+#
+# Build for TwistyPlugin
+#
+BEGIN {
+  foreach my $pc (split(/:/, $ENV{FOSWIKI_LIBS})) {
+    unshift @INC, $pc;
+  }
+}
+
+use Foswiki::Contrib::Build;
+
+# Create the build object
+$build = new Foswiki::Contrib::Build( 'TwistyPlugin' );
+
+# Build the target on the command line, or the default target
+$build->build($build->{target});
+

TwistyPlugin/pub/System/TwistyPlugin/twisty.css

@@ -0,0 +1,20 @@
+.twistyHidden { display:none; }
+.twistyMakeHidden {} /* reserved */
+.twistyMakeVisible { display:none; }
+
+.twistyTrigger {}
+.twistyContent {}
+.twistyPlaceholder { /* color to be implemented by skin */ }
+.twistyRememberSetting { /* behavior class */ }
+.twistyForgetSetting { /* behavior class */ }
+.twistyStartHide { /* behavior class */ }
+.twistyStartShow { /* behavior class */ }
+.twistyInited1 { /* behavior class: state is set to shown */ }
+.twistyInited0 { /* behavior class: state is set to hidden */ }
+
+/* These styles are available in Foswiki, but provided here for older TWiki versions: */
+.foswikiMakeVisible,
+.foswikiMakeVisibleInline,
+.foswikiMakeVisibleBlock {
+	display:none; /* will be made visible with javascript */
+}

TwistyPlugin/pub/System/TwistyPlugin/twisty.dojo.js

@@ -0,0 +1,266 @@
+/*
+To compress this file you can use Dojo ShrinkSafe compressor at
+http://alex.dojotoolkit.org/shrinksafe/
+*/
+
+/**
+Singleton class.
+*/
+var foswiki; if (!foswiki) foswiki = {};
+foswiki.TwistyPlugin = new function () {
+
+	var self = this;
+
+	/**
+	Retrieves the name of the twisty from an HTML element id. For example 'demotoggle' will return 'demo'.
+	@param inId : (String) HTML element id
+	@return String
+	@privileged
+	*/
+	this._getName = function (e) {
+		var re = new RegExp("(.*)(hide|show|toggle)", "g");
+        var inId = dojo.attr(e, 'id');
+		var m = re.exec(inId);
+		var name = (m && m[1]) ? m[1] : "";
+    	return name;
+	}
+
+	/**
+	Retrieves the type of the twisty from an HTML element id. For example 'demotoggle' will return 'toggle'.
+	@param inId : (String) HTML element id
+	@return String
+	@privileged
+	*/
+	this._getType = function (inId) {
+		var re = new RegExp("(.*)(hide|show|toggle)", "g");
+		var m = re.exec(inId);
+    	var type = (m && m[2]) ? m[2] : "";
+    	return type;
+	}
+
+	/**
+	Toggles the collapsed state. Calls _update().
+	@privileged
+	*/
+	this._toggleTwisty = function (ref) {
+		if (!ref) return;
+		ref.state = (ref.state == foswiki.TwistyPlugin.CONTENT_HIDDEN) ? foswiki.TwistyPlugin.CONTENT_SHOWN : foswiki.TwistyPlugin.CONTENT_HIDDEN;
+		self._update(ref, true);
+	}
+
+	/**
+	Updates the states of UI trinity 'show', 'hide' and 'content'.
+	Saves new state in a cookie if one of the elements has CSS class 'twistyRememberSetting'.
+	@param ref : (Object) foswiki.TwistyPlugin.Storage object
+	@privileged
+	*/
+	this._update = function (ref, inMaySave) {
+		var showControl = ref.show;
+
+		var hideControl = ref.hide;
+
+		var contentElem = ref.toggle;
+
+		//can implement Micha's animation using
+		//dojo.anim("thinger", { width: 500, height: 500 }, 500);
+
+
+		if (ref.state == foswiki.TwistyPlugin.CONTENT_SHOWN) {
+
+			// show content
+
+			dojo.addClass(showControl, 'twistyHidden');	// hide 'show'
+
+			dojo.removeClass(hideControl, 'twistyHidden'); // show 'hide'
+
+			dojo.removeClass(contentElem, 'twistyHidden'); // show content
+
+		} else {
+
+			// hide content
+
+			dojo.removeClass(showControl, 'twistyHidden'); // show 'show'	
+
+			dojo.addClass(hideControl, 'twistyHidden'); // hide 'hide'
+
+			dojo.addClass(contentElem, 'twistyHidden'); // hide content
+
+		}
+
+		if (inMaySave && ref.saveSetting) {
+
+	        foswiki.Pref.setPref(foswiki.TwistyPlugin.COOKIE_PREFIX + ref.name, ref.state);
+
+		}
+
+		if (ref.clearSetting) {
+
+	        foswiki.Pref.setPref(foswiki.TwistyPlugin.COOKIE_PREFIX + ref.name, "");
+
+		}
+	}
+
+	/**
+	Stores a twisty HTML element (either show control, hide control or content 'toggle').
+	@param e : (Object) HTMLElement
+	@privileged
+	*/
+	this._register = function (e) {
+		if (!e) return;
+		var name = self._getName(e);
+		var ref = self._storage[name];
+		if (!ref) {
+			ref = new foswiki.TwistyPlugin.Storage();
+		}
+        var classValue = dojo.attr(e, 'class');             //TODO: replace with dojo.hasClass
+        ref.saveSetting = dojo.hasClass(e, 'twistyRememberSetting');
+        ref.clearSetting = dojo.hasClass(e, 'twistyForgetSetting');
+        ref.startShown = dojo.hasClass(e, 'twistyStartShow');
+        ref.startHidden = dojo.hasClass(e, 'twistyStartHide');
+        ref.firstStartShown = dojo.hasClass(e, 'twistyFirstStartShow');
+        ref.firstStartHidden = dojo.hasClass(e, 'twistyFirstStartHide');
+
+		ref.name = name;
+		var type = self._getType(e.id);
+		ref[type] = e;
+		self._storage[name] = ref;
+		switch (type) {
+			case 'show': // fall through
+			case 'hide':
+				e.onclick = function() {
+					self._toggleTwisty(ref);
+					return false;
+				}
+				break;
+		}
+		return ref;
+	}
+
+	/**
+	Key-value set of foswiki.TwistyPlugin.Storage objects. The value is accessed by twisty id identifier name.
+	@example var ref = self._storage["demo"];
+	@privileged
+	*/
+	this._storage = {};
+};
+
+/**
+Public constants.
+*/
+foswiki.TwistyPlugin.CONTENT_HIDDEN = 0;
+foswiki.TwistyPlugin.CONTENT_SHOWN = 1;
+foswiki.TwistyPlugin.COOKIE_PREFIX = "TwistyPlugin_";
+
+/**
+The cached full Foswiki preference cookie string so the data has to be read only once during init.
+*/
+foswiki.TwistyPlugin.prefList;
+
+/**
+Initializes a twisty HTML element (either show control, hide control or content 'toggle') by registering and setting the visible state.
+Calls _register() and _update().
+@public
+@param inId : (String) id of HTMLElement
+@return The stored foswiki.TwistyPlugin.Storage object.
+*/
+foswiki.TwistyPlugin.init = function(e) {
+	if (!e) return;
+
+	// check if already inited
+        var name = this._getName(e);
+	var ref = this._storage[name];
+	if (ref && ref.show && ref.hide && ref.toggle) return ref;
+
+	// else register
+	ref = this._register(e);
+
+	//foswiki.CSS.replaceClass(e, "twistyMakeHidden", "twistyHidden");
+
+	dojo.removeClass(e, "foswikiMakeVisible");
+
+	dojo.removeClass(e, "foswikiMakeVisibleBlock");
+
+	dojo.removeClass(e, "foswikiMakeVisibleInline");
+
+	dojo.removeClass(e, "foswikiMakeHidden");
+
+
+
+	if (ref.show && ref.hide && ref.toggle) {
+		// all Twisty elements present
+
+		if (dojo.hasClass(e, 'twistyInited1')) {
+			ref.state = foswiki.TwistyPlugin.CONTENT_SHOWN
+			this._update(ref, false);
+			return ref;
+		}
+		if (dojo.hasClass(e, 'twistyInited0')) {
+			ref.state = foswiki.TwistyPlugin.CONTENT_HIDDEN
+			this._update(ref, false);
+			return ref;
+		}
+
+		if (foswiki.TwistyPlugin.prefList == null) {
+			// cache complete cookie string
+			foswiki.TwistyPlugin.prefList = foswiki.Pref.getPrefList();
+		}
+		var cookie = foswiki.Pref.getPrefValueFromPrefList(foswiki.TwistyPlugin.COOKIE_PREFIX + ref.name, foswiki.TwistyPlugin.prefList);
+		if (ref.firstStartHidden) ref.state = foswiki.TwistyPlugin.CONTENT_HIDDEN;
+		if (ref.firstStartShown) ref.state = foswiki.TwistyPlugin.CONTENT_SHOWN;
+		// cookie setting may override  firstStartHidden and firstStartShown
+		if (cookie && cookie == "0") ref.state = foswiki.TwistyPlugin.CONTENT_HIDDEN;
+		if (cookie && cookie == "1") ref.state = foswiki.TwistyPlugin.CONTENT_SHOWN;
+		// startHidden and startShown may override cookie
+		if (ref.startHidden) ref.state = foswiki.TwistyPlugin.CONTENT_HIDDEN;
+		if (ref.startShown) ref.state = foswiki.TwistyPlugin.CONTENT_SHOWN;
+
+		this._update(ref, false);
+	}
+	return ref;	
+}
+
+foswiki.TwistyPlugin.toggleAll = function(inState) {
+	var i;
+	for (var i in this._storage) {
+		var e = this._storage[i];
+		e.state = inState;
+		this._update(e, true);
+	}
+}
+foswiki.TwistyPlugin.toggleAll_Show = function() {
+    foswiki.TwistyPlugin.toggleAll(foswiki.TwistyPlugin.CONTENT_SHOWN);
+}
+foswiki.TwistyPlugin.toggleAll_Hide = function() {
+    foswiki.TwistyPlugin.toggleAll(foswiki.TwistyPlugin.CONTENT_HIDDEN);
+}
+
+/**
+Storage container for properties of a twisty HTML element: show control, hide control or toggle content.
+*/
+foswiki.TwistyPlugin.Storage = function () {
+	this.name;										// String
+	this.state = foswiki.TwistyPlugin.CONTENT_HIDDEN;	// Number
+	this.hide;										// HTMLElement
+	this.show;										// HTMLElement
+	this.toggle;									// HTMLElement (content element)
+	this.saveSetting = false;						// Boolean; default not saved
+	this.clearSetting = false;						// Boolean; default not cleared
+	this.startShown;								// Boolean
+	this.startHidden;								// Boolean
+	this.firstStartShown;							// Boolean
+	this.firstStartHidden;							// Boolean
+}
+
+/**
+ * dojo init 
+ */
+foswiki.TwistyPlugin.onLoad = function() {
+  dojo.query(".twistyTrigger").forEach("foswiki.TwistyPlugin.init(item);");
+  dojo.query(".twistyContent").forEach("foswiki.TwistyPlugin.init(item);");
+
+  dojo.query(".twistyExpandAll").onclick(foswiki.TwistyPlugin.toggleAll_Show);
+  dojo.query(".twistyCollapseAll").onclick(foswiki.TwistyPlugin.toggleAll_Hide);
+}
+
+dojo.addOnLoad(foswiki.TwistyPlugin.onLoad);
+

TwistyPlugin/pub/System/TwistyPlugin/twisty.jquery.css

@@ -0,0 +1,20 @@
+.twistyHidden { display:none; }
+.twistyMakeHidden {} /* reserved */
+.twistyMakeVisible { display:none; }
+
+.twistyTrigger {}
+span.twistyContent {}
+.twistyPlaceholder { /* color to be implemented by skin */ }
+.twistyRememberSetting { /* behavior class */ }
+.twistyForgetSetting { /* behavior class */ }
+.twistyStartHide { /* behavior class */ }
+.twistyStartShow { /* behavior class */ }
+.twistyInited1 { /* behavior class: state is set to shown */ }
+.twistyInited0 { /* behavior class: state is set to hidden */ }
+
+/* These styles are available in Foswiki, but provided here for older TWiki versions: */
+.foswikiMakeVisible,
+.foswikiMakeVisibleInline,
+.foswikiMakeVisibleBlock {
+	display:none; /* will be made visible with javascript */
+}