Custom Application ADF Library Overrides - Revision history

Mcarroll: /* Steps to override */

2010-04-08T18:15:26Z

‎Steps to override

Mcarroll: /* Steps to override */

2010-04-08T18:14:46Z

‎Steps to override

Mcarroll: /* Steps to override */

2010-04-08T18:12:26Z

‎Steps to override

Mcarroll: /* Steps to override */

2010-04-08T18:11:56Z

‎Steps to override

Mcarroll: /* Steps to override */

2010-04-08T18:10:20Z

‎Steps to override

Rwest at 02:18, 30 March 2010

2010-03-30T02:18:18Z

Rwest at 00:55, 8 March 2010

2010-03-08T00:55:04Z

Renee.mckechnie: /* Overview */

2009-12-19T23:20:44Z

‎Overview

Renee.mckechnie: Created page with '== Overview == The ADF application can override a component in the ADF library. The ''components'' directory can contain a sub directory named ''lib''. In here, any library com…'

2009-11-22T03:24:08Z

Created page with '== Overview == The ADF application can override a component in the ADF library. The ''components'' directory can contain a sub directory named ''lib''. In here, any library com…'

New page

== Overview ==
The ADF application can override a component in the ADF library. The ''components'' directory can contain a sub directory named ''lib''. In here, any library components can be placed in this directory to override the matching ADF library component.

The [[App Bean Config|App Bean Config]] looks in this directory to find if any ADF library components are to be replaced with the ADF application level component.

'''Developers Tip:''' Have the override component in your application extend the ADF library component. This enables you to use all the same functions in the library component, but override or add some functions.

@@ Line 19: / Line 19: @@
 # Update the application appBeanConfig.cfm to create a singleton for this component.  The second parameter must be a unique bean name for the component.  Add a dependency for this new bean into the application.
 <source lang="java">
-// Load the customized CEData for the application
+// Load the customized CSData for the application
 addSingleton("ADF.apps.myApp.lib.csData_1_0", "myApp_csData");
 addConstructorDependency(appBeanName, "myApp_csData", "csdata");

@@ Line 17: / Line 17: @@
 </source>
-# Update the application appBeanConfig.cfm to create a singleton for the component and inject the dependency into the application.
+# Update the application appBeanConfig.cfm to create a singleton for this component.  The second parameter must be a unique bean name for the component.  Add a dependency for this new bean into the application.
 <source lang="java">
 // Load the customized CEData for the application
-addSingleton("ADF.apps.myApp.lib.ceData_1_0", "myApp_ceData");
+addSingleton("ADF.apps.myApp.lib.csData_1_0", "myApp_csData");
-addConstructorDependency(appBeanName, "myApp_ceData", "cedata");
+addConstructorDependency(appBeanName, "myApp_csData", "csdata");
 </source>

@@ Line 9: / Line 9: @@
 # Copy your ADF Library Component from its directory and place it int your /myApp/lib/ directory
 # Modify the <cfcomponent> tag to extend the original ADF Library Component.  For example, if you wanted to modify data_1_0.cfc in your application the <cfomponent> tag would be changed from this:
+<source lang="cfm">
- <cfcomponent extends="ADF.core.Base">
+<cfcomponent extends="ADF.core.Base">
+</source>
 to:
+<source lang="cfm">
- <cfcomponent extends="ADF.lib.csData.csData_1_0">
+<cfcomponent extends="ADF.lib.csData.csData_1_0">
 # Update the application appBeanConfig.cfm to create a singleton for the component and inject the dependency into the application.

← Older revision		Revision as of 18:11, 8 April 2010
Line 15:		Line 15:

	<cfcomponent extends="ADF.lib.csData.csData_1_0">		<cfcomponent extends="ADF.lib.csData.csData_1_0">
		+
		+	# Update the application appBeanConfig.cfm to create a singleton for the component and inject the dependency into the application.
		+	<source lang="java">
		+	// Load the customized CEData for the application
		+	addSingleton("ADF.apps.myApp.lib.ceData_1_0", "myApp_ceData");
		+	addConstructorDependency(appBeanName, "myApp_ceData", "cedata");
		+	</source>

	== Best practices ==		== Best practices ==

@@ Line 6: / Line 6: @@
 == Steps to override ==
-# Create a directory called "lib" in your applications "components" directory (e.g. /myApp/components/lib)
+# Create a directory called "lib" in your applications directory (e.g. /myApp/lib)
-# Copy your ADF Library Component from its directory and place it int your /myApp/components/lib/ directory
+# Copy your ADF Library Component from its directory and place it int your /myApp/lib/ directory
 # Modify the <cfcomponent> tag to extend the original ADF Library Component.  For example, if you wanted to modify data_1_0.cfc in your application the <cfomponent> tag would be changed from this:

@@ Line 1: / Line 1: @@
 == Overview ==
-You should have learned that you can "inject" ADF Library Components into your application.  However, you can also override ADF Library Components and deliver that override with your application.
+You should have learned that you can "inject" ADF Library Components ([[App Bean Config]]) into your application.  However, you can also override ADF Library Components and deliver that override with your application.
 == Why would you override an ADF Library Component ==
@@ Line 19: / Line 19: @@
 You don't have to override the entire component, you can add new methods and override existing methods pretty easily.  Using the above example, lets say you wanted to modify <em>just</em> the "getStandardMetadata()" function so it would return more data than it does now.  A sample of your csData_1_0 (located in the /myApp/components/lib/ directory) would look like this:
-<pre>
+<source lang="java">
 <cfcomponent displayname="CSData" extends="ADF.lib.csData.csData_1_0">
@@ Line 31: / Line 31: @@
 </cfcomponent>
-</pre>
+</source>
 Notice how the value of the "extends" attribute is pointing to the csData_1_0 component loaded into the ADF <em>and</em> notice how there are no other methods in this component.  By extending the original csData_1_0 component, you automatically gain all of the methods defined in that component - so you need not copy those in.
 This allows you to take advantage of any changes made to csData_1_0 automatically.

@@ Line 1: / Line 1: @@
 == Overview ==
-The ADF application can override a component in the ADF library.  The ''components'' directory can contain a sub directory named ''lib''.  In here, any library components can be placed in this directory to override the matching ADF library component.
+The ADF application can override a component in the ADF library.  The ''components'' directory can contain a sub directory named ''lib''.  Any library components can be placed in this directory to override the matching ADF library component.
 The [[App Bean Config|App Bean Config]] looks in this directory to find if any ADF library components are to be replaced with the ADF application level component.