Comments on: Code Documentation http://dispatchevent.org/calebjohnston/code-documentation/ Collective thoughts on the Flash Platform, iOS, Unity, and any other technology we use. Tue, 24 Jan 2012 12:18:11 +0000 hourly 1 http://wordpress.org/?v=3.3.1 By: Caleb Johnston http://dispatchevent.org/calebjohnston/code-documentation/comment-page-1/#comment-121014 Caleb Johnston Fri, 25 Jul 2008 21:47:28 +0000 http://blog.extends.eventdispatcher.org/?p=276#comment-121014 1. There is no 'Main Model'. Each model class is usually only a collection of static constant values. However if the values must contain external data then they are variables instead. Those variables are then manually initialized when the external data has been loaded. 2. This can be done but currently, time will not permit! 3. All controllers are singletons that are very high-level in that they don't perform a lot of work other than processing and dispatching events. However, the only managers that are singletons are the AudioManager and the LinkManager. The managers handle more of the raw work. An example of this relationship is the following: LoadController dispatches events to and process events from 3 LoadManagers. But LoadManagers actually perform the real loading of data and all decision making that is involved. In terms of MVC design -both can be considered controllers but in terms of the architecture of the site, there is a difference in roles. The primary reason they're separated is so that I can easily re-use the managers for other projects. The controllers would be far less useful elsewhere. 1. There is no ‘Main Model’. Each model class is usually only a collection of static constant values. However if the values must contain external data then they are variables instead. Those variables are then manually initialized when the external data has been loaded.
2. This can be done but currently, time will not permit!
3. All controllers are singletons that are very high-level in that they don’t perform a lot of work other than processing and dispatching events. However, the only managers that are singletons are the AudioManager and the LinkManager. The managers handle more of the raw work. An example of this relationship is the following:
LoadController dispatches events to and process events from 3 LoadManagers. But LoadManagers actually perform the real loading of data and all decision making that is involved.

In terms of MVC design -both can be considered controllers but in terms of the architecture of the site, there is a difference in roles. The primary reason they’re separated is so that I can easily re-use the managers for other projects. The controllers would be far less useful elsewhere.

]]> By: Hu http://dispatchevent.org/calebjohnston/code-documentation/comment-page-1/#comment-121004 Hu Fri, 25 Jul 2008 18:54:36 +0000 http://blog.extends.eventdispatcher.org/?p=276#comment-121004 Hi Caleb, thank you so much for this post. It is one of the most helpful code posts that I have read. I recommend EnterpriseArchitect for UML purposes, if you are on a PC. The generation of UML is almost automatic and if you start up UML diagrams, it generates the AS files automatically, which saves some tedious and boring typing work. My question about your UML: 1. is there a Main Model that you keep track of all the data? where do the AudioModel, CopyModel, EnvironmentModel get their data from? XML files? I feel the structure of model is also key to a website. 2. Is there anyway you can list the public methods (especially getters and setters) under the classes? 3. Is there a reason you separate "Manager" from "Controller"? What is the key difference of the two? Good jobs. Hi Caleb, thank you so much for this post. It is one of the most helpful code posts that I have read.

I recommend EnterpriseArchitect for UML purposes, if you are on a PC. The generation of UML is almost automatic and if you start up UML diagrams, it generates the AS files automatically, which saves some tedious and boring typing work.

My question about your UML:
1. is there a Main Model that you keep track of all the data? where do the AudioModel, CopyModel, EnvironmentModel get their data from? XML files? I feel the structure of model is also key to a website.
2. Is there anyway you can list the public methods (especially getters and setters) under the classes?
3. Is there a reason you separate “Manager” from “Controller”? What is the key difference of the two?

Good jobs.

]]> By: shaun http://dispatchevent.org/calebjohnston/code-documentation/comment-page-1/#comment-117885 shaun Thu, 05 Jun 2008 14:58:46 +0000 http://blog.extends.eventdispatcher.org/?p=276#comment-117885 thanks for sharing your application structure - I find it much more useful to look at the big picture than read through specific code snippets. I wish more developers would share their UML.. application design is certainly more challenging than writing code! thanks again. s thanks for sharing your application structure – I find it much more useful to look at the big picture than read through specific code snippets. I wish more developers would share their UML.. application design is certainly more challenging than writing code! thanks again. s

]]> By: dispatchEvent() / Flash Site Experience Profile http://dispatchevent.org/calebjohnston/code-documentation/comment-page-1/#comment-117842 dispatchEvent() / Flash Site Experience Profile Mon, 02 Jun 2008 05:21:59 +0000 http://blog.extends.eventdispatcher.org/?p=276#comment-117842 [...] is essentially the second part to my last post. This time however, I’m concentrating on the user experience of the same campaign site [...] [...] is essentially the second part to my last post. This time however, I’m concentrating on the user experience of the same campaign site [...]

]]> By: Paolo Iulita http://dispatchevent.org/calebjohnston/code-documentation/comment-page-1/#comment-117746 Paolo Iulita Tue, 27 May 2008 20:35:05 +0000 http://blog.extends.eventdispatcher.org/?p=276#comment-117746 and you gained it! short but complete. I'll dive on Absract Classes Issues and workarounds :) About singleton, I asked just for being secure, since often UML diagram reports singleton classes. Good job and thanks again! and you gained it! short but complete.
I’ll dive on Absract Classes Issues and workarounds :)
About singleton, I asked just for being secure, since often UML diagram reports singleton classes.

Good job and thanks again!

]]> By: Caleb Johnston http://dispatchevent.org/calebjohnston/code-documentation/comment-page-1/#comment-117737 Caleb Johnston Mon, 26 May 2008 17:38:34 +0000 http://blog.extends.eventdispatcher.org/?p=276#comment-117737 Thanks for writing Paolo. I will try and keep my response short but complete. 1) Actionscript doesn't formally support abstract classes. Mims has provided a work-around example for building your own abstract class functionality. You can read that post here: http://blog.extends.eventdispatcher.org/mims/abstract-classes-in-as3/ However its my personal preference to use the existing language features as they are unless I truly need the additional organizational feature of something thats not native. Again this is my preference. Also, for my purposes there is no default behavior needed for any of my view classes other than what is provided in the base MovieClip and Sprite classes. So I think an abstract class is a bit unnecessary. 2) Yes. However, they interact with other classes almost exclusively through event listeners. Although in the case of the NavigationController, some listeners are added like so: NavigationController.getInstance().addEventListener(...); Perhaps I can amend the diagram to show which classes are singletons. Thanks again for your feedback! Thanks for writing Paolo. I will try and keep my response short but complete.
1) Actionscript doesn’t formally support abstract classes. Mims has provided a work-around example for building your own abstract class functionality. You can read that post here: http://blog.extends.eventdispatcher.org/mims/abstract-classes-in-as3/
However its my personal preference to use the existing language features as they are unless I truly need the additional organizational feature of something thats not native. Again this is my preference. Also, for my purposes there is no default behavior needed for any of my view classes other than what is provided in the base MovieClip and Sprite classes. So I think an abstract class is a bit unnecessary.
2) Yes. However, they interact with other classes almost exclusively through event listeners. Although in the case of the NavigationController, some listeners are added like so: NavigationController.getInstance().addEventListener(…);

Perhaps I can amend the diagram to show which classes are singletons. Thanks again for your feedback!

]]> By: Paolo Iulita http://dispatchevent.org/calebjohnston/code-documentation/comment-page-1/#comment-117730 Paolo Iulita Mon, 26 May 2008 08:28:47 +0000 http://blog.extends.eventdispatcher.org/?p=276#comment-117730 hey man that's nice! a cool diagram to study in order to see how different people approaches different type of solutions. I have only two questions: 1) why haven't you created an AbstractView class and then extended it for all of your view classes? 2) are the controller classes singelton? thanks and again congratulations for sharing this with us. Paolo hey man that’s nice! a cool diagram to study in order to see how different people approaches different type of solutions.

I have only two questions:

1) why haven’t you created an AbstractView class and then extended it for all of your view classes?

2) are the controller classes singelton?

thanks and again congratulations for sharing this with us.

Paolo

]]>