RetroZilla/xpfe/global/resources/content/nsWidgetStateManager.js

479 lines
16 KiB
JavaScript
Raw Normal View History

2015-10-21 05:03:22 +02:00
/* -*- Mode: Java; tab-width: 2; c-basic-offset: 2; -*-
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org Code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Ben Goodger <ben@netscape.com> (Original Author)
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/** Presenting widgetStateManager the Third.
* a production of ye olde bard Ben Goodger and his Merry XUL Widget Crewe.
* =>> MODIFICATIONS MUST BE REVIEWED BY ben@netscape.com!!! <<=
**/
var wsm;
function nsWidgetStateManager ( aFrameID )
{
this.dataManager =
{
/** Persisted Data Hash Table
* Page_ID -> Element_ID -> Property -> Value
**/
pageData: [],
setPageData:
function ( aPageTag, aDataObject )
{
this.pageData[aPageTag] = aDataObject;
},
getPageData:
function ( aPageTag )
{
if( !(aPageTag in this.pageData) )
this.pageData[aPageTag] = [];
return this.pageData[aPageTag];
},
setItemData:
function ( aPageTag, aItemID, aDataObject )
{
if( !(aPageTag in this.pageData) )
this.pageData[aPageTag] = [];
this.pageData[aPageTag][aItemID] = aDataObject;
},
getItemData:
function ( aPageTag, aItemID )
{
if( !(aItemID in this.pageData[aPageTag]) )
this.pageData[aPageTag][aItemID] = [];
return this.pageData[aPageTag][aItemID];
}
}
this.contentID = aFrameID;
wsm = this;
/** Element Handlers
* Provides default get and set handler functions for supported
* widgets. Clients can override or add new widgets.
**/
this.handlers =
{
colorpicker:
{ get: wsm.get_Colorpicker, set: wsm.set_Colorpicker },
menulist:
{ get: wsm.get_Menulist, set: wsm.set_Menulist },
radiogroup:
{ get: wsm.get_Radiogroup, set: wsm.set_Radiogroup },
checkbox:
{ get: wsm.get_Checkbox, set: wsm.set_Checkbox },
textbox:
{ get: wsm.get_Textbox, set: wsm.set_Textbox },
listitem:
{ get: wsm.get_Listitem, set: wsm.set_Listitem },
data:
{ get: wsm.get_Data, set: wsm.set_Data },
default_handler:
{ get: wsm.get_Default, set: wsm.set_Default }
}
// extra attributes to scan and save.
this.attributes = [];
}
nsWidgetStateManager.prototype =
{
get contentArea()
{
return window.frames[ this.contentID ];
},
savePageData:
function ( aPageTag )
{
if (!(aPageTag in this.dataManager.pageData))
return;
// Automatic element retrieval. This is done in two ways.
// 1) if an element id array is present in the document, this is
// used to build a list of elements to persist. <-- performant
// 2) otherwise, all elements with 'wsm_persist' set to true
// are persisted <-- non-performant.
var elements;
if( '_elementIDs' in this.contentArea )
{
elements = [];
for( var i = 0; i < this.contentArea._elementIDs.length; i++ )
{
var elt = this.contentArea.document.getElementById( this.contentArea._elementIDs[i] );
if (elt) {
elements[elements.length] = elt;
} else {
// see bug #40329. People forget this too often, and it breaks Prefs
dump("*** FIX ME: '_elementIDs' in '" + this.contentArea.location.href.split('/').pop() +
"' contains a reference to a non-existent element ID '" +
this.contentArea._elementIDs[i] + "'.\n");
}
}
}
else
{
elements = this.contentArea.document.getElementsByAttribute( "wsm_persist", "true" );
}
for( var ii = 0; ii < elements.length; ii++ )
{
var elementID = elements[ii].id;
var elementType = elements[ii].localName;
if (!(aPageTag in this.dataManager.pageData) )
this.dataManager.pageData[aPageTag] = [];
this.dataManager.pageData[aPageTag][elementID] = [];
// persist attributes
var get_Func = (elementType in this.handlers) ?
this.handlers[elementType].get :
this.handlers.default_handler.get;
this.dataManager.setItemData( aPageTag, elementID, get_Func( elementID ) );
}
if( 'GetFields' in this.contentArea)
{
// save page data based on user supplied function in content area
var dataObject = this.dataManager.getPageData( aPageTag );
dataObject = this.contentArea.GetFields( dataObject );
if (dataObject)
this.dataManager.setPageData( aPageTag, dataObject );
}
},
setPageData:
function ( aPageTag )
{
var pageData = this.dataManager.getPageData( aPageTag );
if( 'SetFields' in this.contentArea )
{
if ( !this.contentArea.SetFields( pageData ) )
{
// If the function returns false (or null/undefined) then it
// doesn't want *us* to process the page data.
return;
}
}
for( var elementID in pageData )
{
var element = this.contentArea.document.getElementById( elementID );
if( element )
{
var elementType = element.localName;
var set_Func = (elementType in this.handlers) ?
this.handlers[elementType].set :
this.handlers.default_handler.set;
set_Func( elementID, pageData[elementID] );
}
}
},
/** Widget Get/Set Function Implementations
* These can be overridden by the client.
**/
generic_Set:
function ( aElement, aDataObject )
{
if( aElement )
{
for( var property in aDataObject )
{
if (property == "localname")
continue;
if ( !aDataObject[property] && typeof aDataObject[property] == "boolean")
aElement.removeAttribute( property );
else
aElement.setAttribute( property, aDataObject[property] );
}
if ( !aElement.getAttribute("disabled","true") )
aElement.removeAttribute("disabled");
}
},
generic_Get:
function ( aElement )
{
if( aElement )
{
var dataObject = [];
var wsmAttributes = aElement.getAttribute( "wsm_attributes" );
var attributes = wsm.attributes; // make a copy
if( wsmAttributes != "" )
{
attributes.push( wsmAttributes.split(" ") ); // modify the copy
}
for( var i = 0; i < attributes.length; i++ )
{
dataObject[attributes[i]] = aElement.getAttribute( attributes[i] );
}
dataObject.localname = aElement.localName;
return dataObject;
}
return null;
},
// <colorpicker>
set_Colorpicker:
function ( aElementID, aDataObject )
{
var element = wsm.contentArea.document.getElementById( aElementID );
// set all generic properties
wsm.generic_Set( element, aDataObject );
// set colorpicker specific properties
if( 'color' in aDataObject )
{
try {
element.color = aDataObject.color;
}
catch (ex) {
dump(aElementID +", ex: " + ex + "\n");
}
}
},
get_Colorpicker:
function ( aElementID )
{
var element = wsm.contentArea.document.getElementById( aElementID );
// retrieve all generic attributes
var dataObject = wsm.generic_Get( element );
// retrieve all colorpicker specific attributes
if( dataObject )
{
dataObject.color = element.color;
return dataObject;
}
return null;
},
// <menulist>
set_Menulist:
function ( aElementID, aDataObject )
{
var element = wsm.contentArea.document.getElementById( aElementID );
// set all generic properties
wsm.generic_Set( element, aDataObject );
// set menulist specific properties
if( 'value' in aDataObject )
{
try {
element.value = aDataObject.value;
}
catch (ex) {
dump(aElementID +", ex: " + ex + "\n");
}
}
},
get_Menulist:
function ( aElementID )
{
var element = wsm.contentArea.document.getElementById( aElementID );
// retrieve all generic attributes
var dataObject = wsm.generic_Get( element );
// retrieve all menulist specific attributes
if( dataObject )
{
dataObject.value = element.getAttribute( "value" );
return dataObject;
}
return null;
},
// <radiogroup>
set_Radiogroup:
function ( aElementID, aDataObject )
{
var element = wsm.contentArea.document.getElementById( aElementID );
wsm.generic_Set( element, aDataObject );
if( 'value' in aDataObject )
{
element.value = aDataObject.value;
}
if( 'disabled' in aDataObject )
{
element.disabled = aDataObject.disabled;
}
},
get_Radiogroup:
function ( aElementID )
{
var element = wsm.contentArea.document.getElementById( aElementID );
var dataObject = wsm.generic_Get( element );
if( dataObject )
{
dataObject.value = element.getAttribute( "value" );
return dataObject;
}
return null;
},
// <textbox>
set_Textbox:
function ( aElementID, aDataObject )
{
var element = wsm.contentArea.document.getElementById( aElementID );
wsm.generic_Set( element, aDataObject );
},
get_Textbox:
function ( aElementID )
{
var element = wsm.contentArea.document.getElementById( aElementID );
var dataObject = wsm.generic_Get( element );
if( dataObject )
{
dataObject.value = element.value;
return dataObject;
}
return null;
},
// <checkbox>
set_Checkbox:
function ( aElementID, aDataObject )
{
var element = wsm.contentArea.document.getElementById( aElementID );
// Set generic properites.
wsm.generic_Set( element, aDataObject );
// Handle reversed boolean values.
if ( "checked" in aDataObject && element.hasAttribute( "reversed" ) )
element.checked = !aDataObject.checked;
},
get_Checkbox:
function ( aElementID )
{
var element = wsm.contentArea.document.getElementById( aElementID );
var dataObject = wsm.generic_Get( element );
if( dataObject )
{
var checked = element.checked;
dataObject.checked = element.getAttribute("reversed") == "true" ? !checked : checked;
return dataObject;
}
return null;
},
// <listitem>
set_Listitem:
function ( aElementID, aDataObject )
{
var element = wsm.contentArea.document.getElementById( aElementID );
wsm.generic_Set( element, aDataObject );
// Handle reversed boolean values.
if ( "checked" in aDataObject && element.hasAttribute( "reversed" ) )
element.checked = !aDataObject.checked;
},
get_Listitem:
function ( aElementID )
{
var element = wsm.contentArea.document.getElementById( aElementID );
var dataObject = wsm.generic_Get( element );
if( dataObject )
{
if( element.getAttribute("type") == "checkbox" )
{
var checked = element.checked;
dataObject.checked = element.getAttribute("reversed") == "true" ? !checked : checked;
}
return dataObject;
}
return null;
},
// <data>
set_Data:
function ( aElementID, aDataObject )
{
var element = wsm.contentArea.document.getElementById( aElementID );
wsm.generic_Set( element, aDataObject );
if( 'value' in aDataObject )
{
element.setAttribute("value", aDataObject.value);
}
},
get_Data:
function ( aElementID )
{
var element = wsm.contentArea.document.getElementById( aElementID );
var dataObject = wsm.generic_Get( element );
if( dataObject )
{
dataObject.value = element.getAttribute( "value" );
return dataObject;
}
return null;
},
// <default>
set_Default:
function ( aElementID, aDataObject )
{
var element = wsm.contentArea.document.getElementById( aElementID );
wsm.generic_Set( element, aDataObject );
},
get_Default:
function ( aElementID )
{
var element = wsm.contentArea.document.getElementById( aElementID );
var dataObject = wsm.generic_Get( element );
return dataObject ? dataObject : null;
}
}
// M:tHoF Greatest Hits Section (Append one line per edit):
// it will be dark soon
// MANOS MADE ME PERMANENT!
// there is no way out of here
// [The Master] not dead as you know it. He is with us always.