@@ -17,6 +17,10 @@ package com.insideria.twitteria.business { private var useDummyData:Boolean = true; + /** + * The Delegate's responsibility is to encapsulate the services to isolate the + * application from changes to the services + */ public function TwitterDelegate(responder:IResponder) { trace("creating TwitterDelegate with useDummyData: " + useDummyData); this.responder = responder; cairngorm/src/com/insideria/twitteria/business/TwitterDelegate.as @@ -13,16 +13,28 @@ package com.insideria.twitteria.command { private var model:TwitteRIAModel = TwitteRIAModel.getInstance(); + /** + * execute is where the main responsibilities of the command + * are executed. + */ public function execute(event:CairngormEvent):void { var evt:SetStatusEvent = event as SetStatusEvent; var delegate:TwitterDelegate = new TwitterDelegate(this); delegate.setStatus(evt.statusText); } + /** + * This command is a responder, so when a service call is done + * it will call result + */ public function result(result:Object):void { new LoadTimelineEvent().dispatch(); } + /** + * This command is a responder, so when a service call fails + * it will call fault + */ public function fault(fault:Object):void { } cairngorm/src/com/insideria/twitteria/command/SetStatusCommand.as @@ -10,6 +10,9 @@ package com.insideria.twitteria.controller { initialize(); } + // The Front Controller's responsibility is to match CairngormEvents to + // CairngormCommands. To make that work, you associate them in your implementation + // of the controller, like here private function initialize():void { addCommand(LogInEvent.LogIn_Event, LogInCommand); addCommand(LoadTimelineEvent.LoadTimeline_Event, LoadTimelineCommand); cairngorm/src/com/insideria/twitteria/controller/TwitteRIAController.as @@ -15,21 +15,27 @@ package com.insideria.twitteria.model { */ public static const LOGIN_VIEW:int = 0; public static const MAIN_VIEW:int = 1; + [Bindable] public var mainViewIndex:int = LOGIN_VIEW; public var username:String; public var password:String; + // In this case, although not a best-practice, we store the + // domain data and view state data in the same model. [Bindable] public var currentTweets:ArrayCollection; // <TwitterStatus> + // Since we can't have private constructors in AS3, we hack together a solution public function TwitteRIAModel(access:Private) { if (access == null) { throw new CairngormError(CairngormMessageCodes.SINGLETON_EXCEPTION, "XCLModelLocator"); } } + // The model needs to be accessed through a static accessor method + // following the singleton pattern public static function getInstance():TwitteRIAModel { if (instance == null) { instance = new TwitteRIAModel(new Private()); cairngorm/src/com/insideria/twitteria/model/TwitteRIAModel.as @@ -12,10 +12,12 @@ private var model:TwitteRIAModel = TwitteRIAModel.getInstance(); private function init():void { + // Dispatches the LoadTimelineEvent, which corresponds to the LoadTimelineCommand new LoadTimelineEvent().dispatch(); } private function setStatus():void { + // Dispatches the SetStatusEvent, which corresponds to the SetStatusCommand new SetStatusEvent(statusText.text).dispatch(); statusText.clear(); } @@ -29,8 +31,9 @@ height="100%" styleName="statusList" itemRenderer="com.insideria.twitteria.view.itemRenderers.TwitterStatusRenderer" - dataProvider="{model.currentTweets}" - /> + dataProvider="{model.currentTweets}" + /><!-- The data provider is bound to the model ^^ --> + <mx:HBox width="100%" styleName="instructions"> <mx:Label text="What are you doing?" /> <mx:Spacer width="100%" /> cairngorm/src/com/insideria/twitteria/view/MainView.mxml @@ -7,11 +7,15 @@ <![CDATA[ import com.insideria.twitteria.model.TwitteRIAModel; + + // We get a reference to the model through the Model Locator + // which is a singleton [Bindable] private var model:TwitteRIAModel = TwitteRIAModel.getInstance(); ]]> </mx:Script> + <!-- The Front Controller needs to be instantiated at the application level --> <controller:TwitteRIAController id="controller" /> <mx:DropShadowFilter id="twitteShadow" inner="true" distance="1" blurX="2" blurY="2" /> @@ -20,6 +24,10 @@ <mx:Label id="titleTwitteLabel" styleName="twitTitle" filters="{[twitteShadow]}" text="Twitte" /> <mx:Label id="titleRIALabel" styleName="riaTitle" left="71" top="4" filters="{[riaShadow]}" text="RIA" /> <mx:Label id="poweredLabel" styleName="poweredBy" right="0" top="15" filters="{[riaShadow]}" text="powered by Cairngorm" /> + + <!-- This is typical Cairngorm - binding something in the view to the model to change state when the model changes + Here the view stack's selected index is bound to a variable that can be thought of as holding the state of the main view + which can be either the login or main state --> <mx:ViewStack bottom="0" left="0" right="0" top="30" selectedIndex="{model.mainViewIndex}"> <view:LoginView id="loginView" /> <view:MainView id="mainView" /> cairngorm/src/twitteria_cairngorm.mxml 7b36b8a76ff1a7a330db1b7fde6ff2b1d1e80f6c Tony Hillerson tony.hillerson@effectiveui.com http://github.com/thillerson/twitteria/commit/2c3b4e018f1589440be690d4dc2e5484fcb0d131 2c3b4e018f1589440be690d4dc2e5484fcb0d131 2009-01-30T17:50:52-08:00 2009-01-30T17:50:52-08:00 documented some of the key Cairngorm points 4a450fa0a023d2a687f97aead7ba1d4d9d3b7941 Tony Hillerson tony.hillerson@effectiveui.com