Changeset 1667

Timestamp:

08/09/08 23:30:28 (5 years ago)

Author:

evdlinden

Message:

SideBar? default properties can now be configured in sideBar.xml.cfm

Location:

coldbox/trunk/CodeDepot/projects/sidebar

Files:

• Application.cfc (modified) (1 diff)
• config/coldbox.xml.cfm (modified) (1 diff)
• includes/sidebar/sideBar.cfm (modified) (1 diff)
• includes/sidebar/sideBar.xml.cfm (added)
• interceptors/sideBar.cfc (modified) (3 diffs)
• views/home.cfm (modified) (1 diff)

coldbox/trunk/CodeDepot/projects/sidebar/Application.cfc

@@ -55 +55 @@
                 <cfsetting enablecfoutputonly="no">
                 
-                <!--- SideBar: Hack. Needs to be in the interceptor buffer --->
-                
                 <cfreturn true>
         </cffunction>

coldbox/trunk/CodeDepot/projects/sidebar/config/coldbox.xml.cfm

@@ -237 +237 @@
                  -->    
                 <Interceptor class="sidebar.interceptors.sideBar">
-                        <Property name="isEnabled">true</Property>
+                        <!-- Enabled true/false, else leave blank -->
+                        <Property name="isEnabled"></Property>
                         <!-- Y offset, else leave blank -->
                         <Property name="yOffset"></Property>
-                        <!-- Links (JSON array of objects), else leave blank -->
-                        <Property name="links">
+                        <!-- Links (JSON array of objects), else leave blank
+                        e.g. 
                                 [
                                 {"desc":"ColdBox Live Docs","href":"http:\/\/ortus.svnrepository.com\/coldbox\/trac.cgi"}
                                 ,{"desc":"ColdBox API","href":"http:\/\/www.coldboxframework.com\/api\/"}
                                 ,{"desc":"ColdBox Forums","href":"http:\/\/groups.google.com\/group\/coldbox"}
-                                ,{"desc":"Coldfusion Live Docs","href":"http:\/\/livedocs.adobe.com\/coldfusion\/8\/htmldocs\/help.html?content=Part_3_CFML_Ref_1.html"}
-                                ]
-                        </Property>
+                                ,{"desc":"My API","href":"http:\/\/localhost\/myApi/"}
+                                ,{"desc":"My Database Schema","href":"http:\/\/localhost\/myDatabaseSchema.pdf"}
+                                ,{"desc":"My Batch File","href":"C:\/\/Batch Files\/myBatch.bat"}
+                                ,{"desc":"My Program","href":"C:\/\/Program Files\/My Program.exe"}
+                                ]                       
+                         -->
+                        <Property name="links"></Property>
                         
                         <!-- Width of the sidebar including visible width, else leave blank -->

coldbox/trunk/CodeDepot/projects/sidebar/includes/sidebar/sideBar.cfm

@@ -68 +68 @@
         <cfset clearCacheHref = currentURL & "&clearCache=1">
 </cfif>
-
+                        
 <cfoutput>
 <div id="SideBarContainer" style="visibility:hidden;position:absolute;left:0px;top:#sideBar.yOffset#px;z-index:20;width:#sideBar.width#px">

coldbox/trunk/CodeDepot/projects/sidebar/interceptors/sideBar.cfc

@@ -5 +5 @@
                 
 Modification History:
-
-Todo: implement postRender, so we can discard the plugin
+08/08/2008 evdlinden : getRenderedSideBar(), onException()
+08/09/2008 evdlinden : postRender appendToBuffer, onException appendToBuffer, xmlParse of sideBar properties
 ----------------------------------------------------------------------->
 <cfcomponent name="sideBar" output="true" extends="coldbox.system.interceptor">
@@ -13 +13 @@
 
         <cffunction name="Configure" access="public" returntype="void" hint="This is the configuration method for your interceptors" output="false" >
+                
                 <cfscript>
+                        // Read SideBar XML
+                        readSideBarXML();
+                        
                         /* Start processing properties */
-                        if( not propertyExists('isEnabled') or not isBoolean(getproperty('isEnabled')) ){
-                                setProperty('isEnabled',true);
+                        if( not propertyExists( 'isEnabled') or not isBoolean(getproperty('isEnabled') ) ){
+                                setProperty('isEnabled', getPropertyDefault('isEnabled') );
                         }
-                        if( not propertyExists('yOffset') or not isNumeric(getproperty('yOffset')) ){
-                                setProperty('yOffset',100);
+                        if( not propertyExists( 'yOffset') or not isNumeric(getproperty('yOffset') ) ){
+                                setProperty('yOffset', getPropertyDefault('yOffset'));
                         }
-                        if( not propertyExists('links') or not isArray(getproperty('links')) ){
-                                setProperty('links',ArrayNew(1));
+                        if( not propertyExists( 'links') or not isArray(getproperty('links') ) ){
+                                setProperty('links', getPropertyDefault('links') );
                         }
                         if( not propertyExists('width') or not isNumeric(getproperty('width')) ){
-                                setProperty('width',200);
+                                setProperty('width', getPropertyDefault('width') );
                         }
                         if( not propertyExists('visibleWidth') or not isNumeric(getproperty('visibleWidth')) ){
-                                setProperty('visibleWidth',12);
+                                setProperty( 'visibleWidth', getPropertyDefault('visibleWidth') );
                         }
                         if( not propertyExists('imagePath') or not REFindNoCase("[A-Z]",getproperty('imagePath')) ){
-                                setProperty('imagePath',"includes/sideBar/sideBar.png");
+                                setProperty( 'imagePath', getPropertyDefault('imagePath') );
                         }
                         if( not propertyExists('cssPath') or not REFindNoCase("[A-Z]",getproperty('cssPath')) ){
-                                setProperty('cssPath',"includes/sidebar/sideBar.css");
+                                setProperty( 'cssPath', getPropertyDefault('cssPath') );
                         }
                         if( not propertyExists('imageVAlign') or not ListFindNoCase('top,middle,bottom', getproperty('imageVAlign') ) ){
-                                setProperty('imageVAlign',"middle");
+                                setProperty( 'imageVAlign', getPropertyDefault('imageVAlign') );
                         }
                 </cfscript>
@@ -86 +90 @@
         </cffunction>
                 
+        <cffunction name="setPropertyDefault" access="private" returntype="void">
+                <cfargument name="propertyName" required="true" type="string">
+                <cfargument name="propertyValue" required="true" type="any">
+                <cfset StructInsert(getSideBarDefaults(), arguments.propertyName, arguments.propertyValue)>       
+        </cffunction>
+
+        <cffunction name="getPropertyDefault" access="private" returntype="any">
+                <cfargument name="propertyName" required="true" type="string">
+                <cfreturn StructFind(getSideBarDefaults(), arguments.propertyName)>   
+        </cffunction>
+        
+        <cffunction name="getSideBarDefaults" access="private" returntype="struct">
+                <!--- SideBarDefaults exists ? --->
+                <cfif not propertyExists('sideBarDefaults')>
+                        <cfset setProperty('sideBarDefaults',StructNew())>
+                </cfif> 
+                <cfreturn getproperty('sideBarDefaults')>       
+        </cffunction>
+                
+        <cffunction name="readSideBarXML" access="private" returntype="void">
+                <cfset var i = 0>
+                <cfset var k = 0>
+                <cfset var sideBarXMLDoc = ''>
+                <cfset var sideBarXML = ''>
+                <cfset var properties = ''>
+                <cfset var property = StructNew()>
+                
+                <cftry>
+                        <!--- Read SideBar XML --->
+                        <cffile action="read" file="#ExpandPath('includes/sidebar/sideBar.xml.cfm')#" variable="sideBarXMLDoc">
+                        <!--- Parse XML --->
+                        <cfset sideBarXML = XmlParse(sideBarXMLDoc)>
+                        <!--- Set xml properties array --->
+                        <cfset properties = sideBarXML['Sidebar']['Properties']['Property']>
+                
+                        <!--- Loop properties --->
+                         <cfloop index="i" from="1" to="#ArrayLen(properties)#">
+                                 <!--- Property has properties? --->
+                                 <cfif properties[i].xmlAttributes['name'] EQ "links">
+                                        <!--- Decode JSON --->
+                                        <cfset property.value = getPlugin('JSON').decode( properties[i].xmlText )>
+                                <cfelse>
+                                        <cfset property.value = properties[i].xmlText>
+                                </cfif>
+                                <cfset setPropertyDefault(properties[i].xmlAttributes['name'],property.value)>
+                        </cfloop>
+                        
+                        <cfcatch type="any">
+                                <cfthrow message="SideBar: xml file default properties read error. Check default SideBar.xml file ." detail="#cfcatch.message#"> 
+                        </cfcatch>
+                </cftry>        
+        </cffunction>           
 </cfcomponent>

coldbox/trunk/CodeDepot/projects/sidebar/views/home.cfm

@@ -2 +2 @@
 <h1>#Event.getValue("welcomeMessage")#</h1>
 <h5>You are running #getSetting("codename",1)# #getSetting("version",1)# (#getsetting("suffix",1)#)</h5>
+
+
+
+
 </cfoutput>
+
+
+