Tidy up tagChanged eventListeners
[potlatch2.git] / net / systemeD / potlatch2 / TagViewer.mxml
1 <?xml version="1.0" encoding="utf-8"?>
2 <!---
3   The TagViewer is the container for the entire sidebar. It has a number of components, and subpanels, in a ViewStack that change
4   depending on what is selected, i.e. the ControllerState.
5
6   @see net.systemeD.potlatch2.controller.ControllerState
7     -->
8 <mx:VBox
9     xmlns:fx="http://ns.adobe.com/mxml/2009"
10         xmlns:mx="library://ns.adobe.com/flex/mx"
11         xmlns:flexlib="flexlib.containers.*"
12         xmlns:controls="net.systemeD.controls.*"
13         xmlns:potlatch2="net.systemeD.potlatch2.*"
14     xmlns:sidepanel="net.systemeD.potlatch2.panels.*"
15         horizontalScrollPolicy="off"
16     backgroundColor="white"
17     initialize="loadFeatures()">
18
19 <mx:ViewStack id="sidebar" width="100%" height="100%" creationPolicy="all">
20
21   <!-- Drag & drop icon panel -->
22
23   <mx:VBox id="dndPanel" width="100%" height="100%" horizontalScrollPolicy="off" styleName="dndPanelVbox">
24     <mx:Text id="dndPanelText" text="{dndPrompt}" width="100%" styleName="helpInfo" />
25         <mx:Repeater id="dndRep" dataProvider="{MapFeatures.getInstance().getCategoriesForType('point')}" styleName="dndRepeater">
26                 <mx:HBox width="100%" styleName="dndPanelCategory">
27                         <mx:Label text="{dndRep.currentItem.name}:" styleName="dndPanelCategoryLabel"/>
28                 </mx:HBox>
29
30                 <mx:TileList dataProvider="{dndRep.currentItem.getFeaturesForType('point', true)}" width="100%" height="1"
31                                      rowHeight="32" columnWidth="32" updateComplete="resizePOIGrid(event)" styleName="dndPanelTileList">
32                         <mx:itemRenderer>
33                                 <fx:Component>
34                                         <mx:VBox toolTip="{data.name}">
35                                                 <fx:Script><![CDATA[
36                                                         import mx.events.DragEvent;
37                                                         import mx.managers.DragManager;
38                                                         import mx.core.DragSource;
39
40                                                         private function dragPOI(event:MouseEvent, tags:Array):void {
41                                                                 if (outerDocument.controller.map.dragstate==outerDocument.controller.map.DRAGGING) return;
42
43                                                                 // Get the drag initiator component from the event object.
44                                                                 var dragInitiator:Image = event.currentTarget as Image;
45                                                                 var dragSource:DragSource = new DragSource();
46                                                                 dragSource.addData(tags, 'tags');
47                                                                 dragSource.addData(event.target.parent.parent.parent.parent, 'container');
48
49                                                                 var dragProxy:Image = new Image();
50                                                                 dragProxy.source = dragInitiator.source;
51                                                                 dragProxy.width = dragInitiator.width;   // must set width and height explicitly
52                                                                 dragProxy.height = dragInitiator.height; // for non-embedded images
53                                                                 DragManager.doDrag(dragInitiator, dragSource, event, dragProxy);
54                                                         }
55                                                 ]]></fx:Script>
56                                                 <mx:Image id="foo" source="{data.dndimage}" height="24" width="24" mouseMove="dragPOI(event, data.tags)" toolTip="{data.name}" />
57                                         </mx:VBox>
58                                 </fx:Component>
59                         </mx:itemRenderer>
60                 </mx:TileList>
61         </mx:Repeater>
62   </mx:VBox>
63
64   <!-- Standard tagging panel -->
65
66   <mx:VBox id="tagsPanel" width="100%" height="100%" creationPolicy="auto" tabChildren="true">
67     <mx:ViewStack id="stack" width="100%" height="100%" change="tagsPanel.tabChildren=(event.newIndex==0)">
68       <mx:VBox width="100%" height="100%" label="Simple" id="editorContainer" creationComplete="initEditorStackUIs()" styleName="dndPanelVbox">
69         <mx:VBox width="100%" verticalGap="1" styleName="dndTagHeader">
70           <mx:HBox width="100%" id="iconContainer" styleName="featureSelector">
71             <mx:Image id="iconImage"/>
72             <mx:Text condenseWhite="true" width="100%" id="iconText" styleName="dndIconText"/>
73           </mx:HBox>
74           <mx:HBox width="100%">
75             <mx:PopUpButton id="popupChange" openAlways="true" width="100%" styleName="dndTagPopUpMenu" closeDuration="0" />
76             <mx:LinkButton icon="@Embed('../../../embedded/information.svg')" click="openDescription()" id="helpLabel" styleName="helpInfo"/>
77           </mx:HBox>
78         </mx:VBox>
79       </mx:VBox>
80       <mx:VBox width="100%" height="100%" label="Advanced" id="advancedContainer" initialize="checkAdvanced()" verticalGap="1">
81         <mx:Label id="advancedID" click="openEntityPage()">
82           <mx:htmlText><![CDATA[<i>No Selection</i>]]></mx:htmlText>
83         </mx:Label>
84
85                 <potlatch2:TagGrid id="advancedTagGrid" width="100%" height="75%" />
86
87         <mx:HBox horizontalAlign="right" width="100%">
88           <mx:LinkButton label="Delete" click="advancedTagGrid.removeTag()" id="advancedDeleteButton" enabled="{advancedTagGrid.selectedItem != null? true : false}"/>
89           <mx:LinkButton label="Add" click="advancedTagGrid.addNewTag()" id="advancedAddButton"/>
90         </mx:HBox>
91
92         <mx:DataGrid editable="true" width="100%" height="25%" id="relationsGrid"
93             doubleClickEnabled="true"
94             itemDoubleClick="editRelation(relationsGrid.selectedItem.id)"
95             doubleClick="if (event.target.parent==relationsGrid) { addToRelation(); }">
96             <mx:columns>
97                 <mx:DataGridColumn editable="false" dataField="description" headerText="Relation"/>
98                 <mx:DataGridColumn editable="false" dataField="id_idx" headerText="ID"/>
99                 <mx:DataGridColumn editable="true" dataField="role" headerText="Role">
100                     <mx:itemEditor><fx:Component><mx:TextInput restrict="&#x0020;-&#x10FFFF;" /></fx:Component></mx:itemEditor>
101                 </mx:DataGridColumn>
102                                 <mx:DataGridColumn width="20" editable="false">
103                                         <mx:itemRenderer>
104                                                 <fx:Component>
105                                     <mx:HBox horizontalAlign="center" verticalAlign="middle">
106                                                                 <mx:PopUpButton arrowButtonWidth="12" paddingLeft="0" paddingRight="0" width="12" height="12" 
107                                                                                 open="{outerDocument.updateRelationMenu(event);}" 
108                                                                                 creationComplete="{outerDocument.createRelationMenu(PopUpButton(event.target));}"/>
109                                                         </mx:HBox>
110                                                 </fx:Component>
111                                         </mx:itemRenderer>
112                                 </mx:DataGridColumn>
113             </mx:columns>
114         </mx:DataGrid>
115
116         <mx:HBox horizontalAlign="right" width="100%">
117           <mx:LinkButton label="Remove from" click="removeFromRelation(relationsGrid.selectedItem.id, relationsGrid.selectedItem.index)"
118                           enabled="{relationsGrid.selectedItem != null? true : false}"/>
119           <mx:LinkButton label="Add to" click="addToRelation()"/>
120         </mx:HBox>
121
122       </mx:VBox>
123
124       <mx:VBox width="100%" height="100%" label="Members" id="membersVBox" initialize="checkMembers()" verticalGap="1">
125         <mx:Label id="membersText" text="Relation Members"/>
126         <mx:DataGrid editable="true" width="100%" height="100%" id="membersGrid"
127                       dragEnabled="true" dragMoveEnabled="true" dropEnabled="true">
128           <mx:columns>
129             <mx:DataGridColumn editable="false" dataField="type" headerText="Type"/>
130             <mx:DataGridColumn editable="false" dataField="id" headerText="ID"/>
131             <mx:DataGridColumn editable="true" dataField="role" headerText="Role">
132                                 <mx:itemEditor><fx:Component><mx:TextInput restrict="&#x0020;-&#x10FFFF;" /></fx:Component></mx:itemEditor>
133                         </mx:DataGridColumn>
134           </mx:columns>
135         </mx:DataGrid>
136       </mx:VBox>
137
138       </mx:ViewStack>
139
140           <mx:HBox width="100%">
141                 <mx:LinkBar dataProvider="{stack}"/>
142                 <mx:Spacer width="100%"/>
143                 <mx:LinkButton
144                         icon="@Embed('../../../embedded/view_tabbed.png')"
145                         disabledIcon="@Embed('../../../embedded/view_tabbed_disabled.png')"
146                         click="setEditorStackUI(true)" id="tabNavigatorLabel" paddingTop="6"
147                         toolTip="Show in tabs"
148                         enabled="{editorStack is Accordion &amp;&amp; stack.selectedIndex==0}" />
149                 <mx:LinkButton
150                         icon="@Embed('../../../embedded/view_accordion.png')"
151                         disabledIcon="@Embed('../../../embedded/view_accordion_disabled.png')"
152                         click="setEditorStackUI(false)" id="accordionLabel" paddingTop="6"
153                         toolTip="Show in sliding windows"
154                         enabled="{editorStack is TabNavigator &amp;&amp; stack.selectedIndex==0}" />
155           </mx:HBox>
156   </mx:VBox>
157
158   <!-- Multiple selection -->
159
160   <mx:VBox id="multiplePanel" width="100%" height="100%" horizontalScrollPolicy="off" styleName="dndPanelVbox">
161     <potlatch2:TagGrid id="multiAdvancedTagGrid" width="100%" height="75%" />
162         <mx:HBox horizontalAlign="right" width="100%">
163           <mx:LinkButton label="Delete" click="multiAdvancedTagGrid.removeTag()" enabled="{multiAdvancedTagGrid.selectedItem != null? true : false}"/>
164           <mx:LinkButton label="Add" click="multiAdvancedTagGrid.addNewTag()" />
165         </mx:HBox>
166
167     <mx:DataGrid editable="true" width="100%" height="25%" id="multiRelationsGrid"
168         doubleClickEnabled="true"
169         itemDoubleClick="editRelation(multiRelationsGrid.selectedItem.id)"
170         doubleClick="if (event.target.parent==multiRelationsGrid) { addToRelation(); }">
171         <mx:columns>
172             <mx:DataGridColumn editable="false" dataField="description" headerText="Relation"/>
173             <mx:DataGridColumn editable="false" dataField="id_idx" headerText="ID"/>
174             <mx:DataGridColumn editable="true" dataField="role" headerText="Role">
175                 <mx:itemEditor><fx:Component><mx:TextInput restrict="&#x0020;-&#x10FFFF;" /></fx:Component></mx:itemEditor>
176             </mx:DataGridColumn>
177                         <mx:DataGridColumn width="20" editable="false">
178                                 <mx:itemRenderer>
179                                         <fx:Component>
180                             <mx:HBox horizontalAlign="center" verticalAlign="middle">
181                                                         <mx:PopUpButton arrowButtonWidth="12" paddingLeft="0" paddingRight="0" width="12" height="12" 
182                                                                         open="{outerDocument.updateRelationMenu(event);}" 
183                                                                         creationComplete="{outerDocument.createRelationMenu(PopUpButton(event.target));}"/>
184                                                 </mx:HBox>
185                                         </fx:Component>
186                                 </mx:itemRenderer>
187                         </mx:DataGridColumn>
188         </mx:columns>
189     </mx:DataGrid>
190     <mx:HBox horizontalAlign="right" width="100%">
191       <mx:LinkButton label="Remove from" click="removeFromRelation(multiRelationsGrid.selectedItem.id)"
192                       enabled="{multiRelationsGrid.selectedItem != null? true : false}"/>
193       <mx:LinkButton label="Add to" click="addToRelation()"/>
194     </mx:HBox>
195
196   </mx:VBox>
197
198   <!-- Multiple selection but items cannot be edited -->
199
200   <mx:VBox id="multipleInvalidPanel" width="100%" height="100%" horizontalScrollPolicy="off" styleName="dndPanelVbox">
201         <mx:Text id="multipleInvalidPanelText" text="You have selected multiple items." width="100%" styleName="helpInfo" />
202   </mx:VBox>
203
204   <!-- Generic marker panel -->
205
206   <mx:VBox id="markerPanel" width="100%" height="100%" horizontalScrollPolicy="off" styleName="dndPanelVbox">
207     <sidepanel:MarkerPanel id="markerPanelContents" width="100%"/>
208   </mx:VBox>
209
210   <!-- Bug editing panel -->
211
212   <mx:VBox id="bugPanel" width="100%" height="100%" horizontalScrollPolicy="off" styleName="dndPanelVbox">
213     <sidepanel:BugPanel id="bugPanelContents" width="100%"/>
214   </mx:VBox>
215
216   <!-- Background layer selection -->
217
218   <mx:VBox id="backgroundPanel" width="100%" height="100%" horizontalScrollPolicy="off" styleName="dndPanelVbox">
219     <sidepanel:BackgroundPanel id="backgroundPanelContents" width="100%"/>
220   </mx:VBox>
221
222   <!-- merge tags from background layer -->
223
224   <mx:VBox id="backgroundMergePanel" width="100%" height="100%" horizontalScrollPolicy="off" styleName="dndPanelVbox">
225     <sidepanel:BackgroundMergePanel id="backgroundMergePanelContents" width="100%" />
226   </mx:VBox>
227
228 </mx:ViewStack>
229
230   <fx:Script><![CDATA[
231       import net.systemeD.halcyon.connection.*;
232       import net.systemeD.halcyon.MapPaint;
233       import net.systemeD.potlatch2.EditController;
234       import net.systemeD.potlatch2.mapfeatures.*;
235       import net.systemeD.potlatch2.mapfeatures.editors.*;
236       import net.systemeD.potlatch2.utils.*;
237       import net.systemeD.controls.CollapsiblePanel;
238
239       import mx.collections.*;
240       import mx.containers.VBox;
241       import mx.containers.HBox;
242       import mx.containers.TabNavigator;
243       import mx.containers.Accordion;
244       import mx.events.*;
245       import mx.core.*;
246       import mx.managers.PopUpManager;
247       import mx.controls.Menu;
248       import mx.controls.Alert;
249       import flash.geom.Point;
250       import flash.net.*;
251       import mx.events.DragEvent;
252       import mx.managers.DragManager;
253       import mx.core.DragSource;
254       import mx.controls.TabBar;
255       import spark.components.Form;
256       import spark.layouts.FormLayout;
257 //    import flexlib.containers.SuperTabNavigator;
258
259       [Bindable] [Embed(source="../../../embedded/tab_basic.png"       )] private var tabIconBasic:Class;
260       [Bindable] [Embed(source="../../../embedded/tab_address.png"     )] private var tabIconAddress:Class;
261       [Bindable] [Embed(source="../../../embedded/tab_cycle.png"       )] private var tabIconCycle:Class;
262       [Bindable] [Embed(source="../../../embedded/tab_details.png"     )] private var tabIconDetails:Class;
263       [Bindable] [Embed(source="../../../embedded/tab_restrictions.png")] private var tabIconRestrictions:Class;
264       [Bindable] [Embed(source="../../../embedded/tab_transport.png"   )] private var tabIconTransport:Class;
265       [Bindable] [Embed(source="../../../embedded/tab_walk.png"        )] private var tabIconWalk:Class;
266       private var tabIcons:Object= { Basic:tabIconBasic, Details:tabIconDetails, Address:tabIconAddress, Walk:tabIconWalk, Cycle:tabIconCycle, 
267                                          Transport:tabIconTransport, Restrictions:tabIconRestrictions};
268
269       [Bindable]
270       public var dndPrompt:String="Add new points by dragging them onto the map";
271
272       private var editorStackTabNavigator:TabNavigator;
273       private var editorStackAccordion:Accordion;
274       [Bindable] private var editorStack:Container;
275
276       public var mapFeatures:MapFeatures;
277       public var controller:EditController;
278       private var selectedEntity:Entity;
279       private var connection:Connection;
280       private var currentCategorySelector:CategorySelector;
281       private var categorySelectors:Object = {};        // hash of categorySelectors for each limitType
282       private var feature:Feature = null;
283
284       private var rowData:Object;               // relation membership reference, needed so it's accessible from relation actions menu
285
286           public function setEntity(entities:Array, layer:MapPaint=null):void {
287                 UIComponent.suspendBackgroundProcessing();
288                 connection=null;
289
290                 var firstSelected:Entity=null;
291                 if (entities.length==1) { firstSelected=entities[0]; }
292
293                 if (selectedEntity!=firstSelected && selectedEntity!=null) {
294                         selectedEntity.removeEventListener(Connection.TAG_CHANGED, tagChanged);
295                         selectedEntity.removeEventListener(Connection.ADDED_TO_RELATION, addedToRelation);
296                         selectedEntity.removeEventListener(Connection.REMOVED_FROM_RELATION, removedFromRelation);
297                         if (selectedEntity is EntityCollection) EntityCollection(selectedEntity).releaseListeners();
298                 }
299
300                 if (entities.length==0) {
301                         // Nothing selected, so show drag-and-drop panel
302                         sidebar.selectedChild = dndPanel;
303                         selectedEntity=null;
304
305                 } else if (entities.length==1) {
306                         // Single entity selected, so show tag panel
307                         if (firstSelected!=null && selectedEntity!=firstSelected) { 
308                                 firstSelected.addEventListener(Connection.TAG_CHANGED, tagChanged, false, 0, true);
309                         }
310                         selectedEntity=firstSelected;
311                         connection=firstSelected.connection;
312                         if (advancedID!=null) { setupAdvanced(firstSelected); }
313                         if (firstSelected is Relation) { stack.addChild(membersVBox); }
314             if (selectedEntity is Marker && connection is BugConnection) {
315               bugPanelContents.init(selectedEntity, BugConnection(connection));
316               sidebar.selectedChild = bugPanel;
317             } else if (selectedEntity is Marker) {
318               markerPanelContents.init(selectedEntity, layer);
319               sidebar.selectedChild = markerPanel;
320             } else if (connection is SnapshotConnection) {
321               backgroundPanelContents.init(selectedEntity);
322               sidebar.selectedChild = backgroundPanel;
323             } else {
324               refreshFeatureIcon();
325               initialiseEditors();
326               sidebar.selectedChild = tagsPanel;
327             }
328
329         } else if (entities.length==2
330                       && xor(entities[0].connection is SnapshotConnection, entities[1].connection is SnapshotConnection)
331                       && xor(!controller.map.getLayerForEntity(entities[0]).isBackground, !controller.map.getLayerForEntity(entities[1]).isBackground) ) {
332             backgroundMergePanelContents.init(entities);
333             sidebar.selectedChild = backgroundMergePanel;
334                         // ** FIXME: do we need to set selectedEntity here?
335
336                 } else if(isMultipleEditable(entities)) {
337                         selectedEntity = new EntityCollection(entities);
338                         selectedEntity.addEventListener(Connection.TAG_CHANGED, tagChanged, false, 0, true);
339             sidebar.selectedChild = multiplePanel;
340                         setupMultiAdvanced(selectedEntity);
341                         connection=entities[0].connection;
342                         
343                 } else {
344                         //The selection contains elements which can't be edited all together.
345                         sidebar.selectedChild = multipleInvalidPanel;
346                         selectedEntity=null;
347                 }
348                 UIComponent.resumeBackgroundProcessing();
349       }
350
351       private function xor(a:Boolean, b:Boolean):Boolean {
352           return ( a || b) && !(a && b);
353       }
354
355       private function refreshFeatureIcon():void {
356           var oldFeature:Feature = feature;
357           feature = selectedEntity == null ? null : mapFeatures.findMatchingFeature(selectedEntity);
358           if ( feature != oldFeature ) {
359               if ( oldFeature != null )
360                   oldFeature.removeEventListener("imageChanged", featureImageChanged);
361               if ( feature != null )
362                   feature.addEventListener("imageChanged", featureImageChanged);
363           }
364           setCategorySelector(selectedEntity, feature);
365       }
366
367       private function featureImageChanged(event:Event):void {
368           setCategorySelector(selectedEntity, feature);
369       }
370
371       /** Set the icon, categorySelector and help text for the current entity. */
372       private function setCategorySelector(entity:Entity, feature:Feature):void {
373                         // Remove the "user has selected something" event listener from previous categorySelector,
374                         // and make it invisible because Flex is crap at updating click areas otherwise
375                         if (currentCategorySelector) { 
376                                 currentCategorySelector.removeEventListener("selectedType", changeFeatureType);
377                                 currentCategorySelector.visible=false;
378                         }
379                         
380                         // Have we cached the categorySelector for this limitType? If not, create one
381                         var lt:String=limitType(entity);
382                         if (!categorySelectors[lt]) {
383                                 categorySelectors[lt]=new CategorySelector();
384                                 categorySelectors[lt].setLimitTypes(lt);
385                         }
386                         currentCategorySelector=categorySelectors[lt];
387                         currentCategorySelector.addEventListener("selectedType", changeFeatureType, false, 0, true);
388
389                         // Update surrounding icon/text display
390                         if (feature) {
391                                 iconImage.source = feature.image;
392                                 iconText.htmlText = feature.htmlDetails(entity);
393                                 popupChange.label = feature.name;
394                                 helpLabel.visible = feature.hasHelpURL();
395                                 currentCategorySelector.setSelectedFeature(feature);
396                         } else {
397                                 iconImage.source = null;
398                                 popupChange.label = "unknown";
399                                 helpLabel.visible = false;
400                                 if (entity==null) {
401                                         iconText.htmlText = "<i>Nothing selected</i>";
402                                 } else if (entity.hasTags()) {
403                                         iconText.htmlText = "<b>Not recognised</b><br/><font size='10pt'>Try looking at the tags under the advanced properties</font>";
404                                 } else {
405                                         iconText.htmlText = "<b>No tags set</b><br/><font size='10pt'>Please use the menu below to define what this "+entity.getType()+" is</font>";
406                                 }
407                                 currentCategorySelector.setSelectedFeature(null);
408                         }
409
410                         // Set it as the popup, and make sure it's visible
411                         popupChange.popUp=currentCategorySelector;
412                         currentCategorySelector.visible=true;
413       }
414
415           private function isMultipleEditable(entities:Array):Boolean {
416                 for each(var entity:Entity in entities) {
417                         if(!(entity is Node || entity is Way))
418                                 return false;
419                 }
420                 return true;
421           }
422
423       private function limitType(entity:Entity):String {
424           if      (entity is Node    ) return "point";
425           else if (entity is Way     ) return Way(entity).isArea() ? "area" : "line";
426           else if (entity is Relation) return "relation";
427           return null;
428       }
429
430       private var tabComponents:Object = {};
431       private var subpanelComponents:Object = {};
432
433       private function initialiseEditors():void {
434                 editorStack.removeAllChildren();
435                 if ( selectedEntity == null || feature == null )
436                         return;
437
438                 var basicEditorBox:VBox = createEditorBox();
439                 basicEditorBox.label = "Basic";
440                 basicEditorBox.icon=tabIconBasic;
441                 editorStack.addChild(basicEditorBox);
442
443                 var tabs:Object = {};
444                 var tabList:Array = [];
445                 tabComponents = {};
446                 var subpanels:Object = {};
447                 subpanelComponents = {};
448
449                 // First create the tabs
450                 for each (var factory:EditorFactory in feature.editors) {
451                         var category:String = factory.category;
452                         if (category!='') {
453                                 var tab:VBox = tabs[category];
454                                 if ( tab == null) {
455                                         tab = createEditorBox();
456                                         tab.label = category;
457                                         if (tabIcons[category]) tab.icon=tabIcons[category];
458                                         tabs[category] = tab;
459                                         tabList.push(tab);      
460                                 }
461                         }
462                 }
463
464                 // Put the tabs on-screen in order
465                 tabList.sort(sortCategories,16);
466                 for each (tab in tabList) {
467                         editorStack.addChild(tab);
468                         tabComponents[tab] = [];
469                 }
470
471                 // Then add the individual editors to them
472                 for each (factory in feature.editors) {
473
474                         // Add to basic editor box first
475                         if ( factory.presence.isEditorPresent(factory, selectedEntity, null) ) {
476                                 var editor:DisplayObject = factory.createEditorInstance(selectedEntity);
477                                 if (editor) Form(basicEditorBox.getChildByName("form")).addElement(UIComponent(editor));
478                         }
479
480                         // Then prepare to add to category panel
481                         category=factory.category;
482                         if (factory.category=='') continue;
483                         var catEditor:DisplayObject = factory.createEditorInstance(selectedEntity);
484                         if (!catEditor) continue;
485                         tab=tabs[category];
486                         
487                         // Create subcategory panel if needed
488                         if (factory.subcategory) {
489                                 var subcategory:String = factory.subcategory;
490                                 if (!subpanels[category]) { subpanels[category]={}; }
491                                 var subpanel:CollapsiblePanel = subpanels[category][subcategory];
492                                 if (!subpanel) {
493                                         subpanel=new CollapsiblePanel(false);
494                                         subpanel.percentWidth=100;
495                                         subpanel.styleName="subcategoryPanel";
496                                         subpanel.title=subcategory;
497                                         subpanels[category][subcategory]=subpanel;
498                                         addConstrainedForm(subpanel);
499                                         tabComponents[tab].push(subpanel);
500                                 }
501                                 Form(subpanel.getChildByName("form")).addElement(UIComponent(catEditor));
502                         } else {
503                                 tabComponents[tab].push(catEditor);
504                         }
505                 }
506       }
507
508         // ** FIXME: Order probably shouldn't be hard-coded, but configurable
509         private static var categoryOrder:Array=["Restrictions","Transport","Cycle","Walk","Address","Details"]; // reverse order
510         private function sortCategories(a:VBox,b:VBox):int {
511                 var a1:int=categoryOrder.indexOf(a.label);
512                 var a2:int=categoryOrder.indexOf(b.label);
513                 if (a1<a2) { return 1; }
514                 else if (a1>a2) { return -1; }
515                 return 0;
516         }
517         
518         private function createEditorBox():VBox {
519                 var box:VBox = new VBox();
520                 box.percentWidth = 100;
521                 box.percentHeight = 100;
522                 box.styleName = "dndEditorContainer";
523                 addConstrainedForm(box);
524                 return box;
525         }
526         
527         private function addConstrainedForm(parentObject:DisplayObjectContainer):void {
528                 var form:Form = new Form();
529                 form.name = "form";
530                 form.percentWidth=100;
531                 form.addEventListener(mx.events.ResizeEvent.RESIZE, formResizeHandler, false, 0, true);
532                 parentObject.addChild(form);
533                 if (parentObject.width>0) form.maxWidth=parentObject.width;
534         }
535         
536         private function formResizeHandler(e:Event):void {
537                 var form:Form=Form(e.target);
538                 if (form.parent.width>0) form.maxWidth=form.parent.width;
539         }
540
541         private function ensureEditorsPopulated(tab:VBox):void {
542                 var components:Array = tabComponents[tab];
543                 var form:Form=Form(tab.getChildByName("form"));
544                 if ( components == null || tab == null || form.numElements >= components.length ) return;
545                 for each (var component:DisplayObject in components ) {
546                         form.addElement(UIComponent(component));
547                 }
548         }
549
550         private function initEditorStackUIs():void {
551                 editorStackTabNavigator = new TabNavigator();
552 //              editorStackTabNavigator.allowTabSqueezing=false;
553 //              editorStackTabNavigator.minTabWidth=10;
554 //              editorStackTabNavigator.closePolicy="close_never";
555 //              editorStackTabNavigator.scrollSpeed=20;
556                 editorStackTabNavigator.creationPolicy="auto";
557                 editorStackTabNavigator.percentWidth=100;
558                 editorStackTabNavigator.percentHeight=100;
559                 editorStackTabNavigator.styleName="dndStackTab";
560 //              editorStackTabNavigator.popUpButtonPolicy="off"
561
562
563                 editorStackAccordion = new Accordion();
564                 editorStackAccordion.percentWidth=100;
565                 editorStackAccordion.percentHeight=100;
566                 editorStackAccordion.creationPolicy="auto";
567                 editorStackAccordion.styleName="dndStackAccordion";
568                 /* FIXME: the accordion icons should be right-aligned. See:
569                 http://www.kristoferjoseph.com/blog/2008/11/06/positioning-the-flex-accordion-header-icon
570                 http://blog.flexexamples.com/2007/09/13/changing-text-alignment-in-an-flex-accordion-header/
571                 */
572
573                 setEditorStackUI(true);
574         }
575
576         private function setEditorStackUI(isTabbed:Boolean):void {
577                 var children:Array=[]; var i:uint;
578
579                 if (editorStack) {
580                         // blank existing component
581                         editorStack.removeEventListener("change",editorStackUIChange);
582                         editorStack.removeEventListener("updateComplete",editorStackUIUpdate);
583                         editorStack.removeAllChildren();
584                         editorContainer.removeChildAt(1);
585                 }
586
587                 // replace with new component
588                 editorStack = (isTabbed ? editorStackTabNavigator : editorStackAccordion) as Container;
589                 editorContainer.addChild(editorStack);
590
591                 // re-add children and listeners
592                 initialiseEditors();
593                 editorStack.addEventListener("change",editorStackUIChange);
594                 editorStack.addEventListener("updateComplete",editorStackUIUpdate);
595         }
596
597         private function editorStackUIChange(event:Event):void {
598                 ensureEditorsPopulated(IndexChangedEvent(event).relatedObject as VBox);
599         }
600
601         private function editorStackUIUpdate(event:Event):void {
602                 if (editorStack is TabNavigator) {
603                         var e:TabNavigator = editorStack as TabNavigator;
604                         if (e.selectedIndex<0) { return; }
605                         for (var i:uint=0; i<e.numChildren; i++) {
606                                 e.getTabAt(i).selected=(i==e.selectedIndex);
607                         }
608                 }
609         }
610
611
612         public function togglePanel():void {
613                 if (stack.selectedChild==editorContainer && selectedEntity!=null) {
614                         stack.selectedChild=advancedContainer;
615                 } else if (stack.selectedChild!=editorContainer) {
616                         stack.selectedChild=editorContainer;
617                 }
618         }
619
620         public function selectAdvancedPanel():void {
621                 checkAdvanced();
622                 stack.selectedChild=advancedContainer;
623         }
624
625       private function checkAdvanced():void {
626           if ( selectedEntity != null )
627              setupAdvanced(selectedEntity);
628       }
629
630       private var listeningToRelations:Array = [];
631
632       private function setupAdvanced(entity:Entity):void {
633                 if (!advancedTagGrid) advancedContainer.createComponentsFromDescriptors();      // if Flex hasn't created it, force it
634                 advancedTagGrid.init(entity);
635
636                 if ( entity == null ) {
637                         advancedID.htmlText = "";
638                 } else {
639                         var entityText:String = "xx";
640                         if      ( entity is Node     ) entityText = "Node";
641                         else if ( entity is Way      ) entityText = "Way";
642                         else if ( entity is Relation ) entityText = "Relation";
643                         advancedID.htmlText = entityText+": <b>"+entity.id+"</b> "+(entity.status ? entity.status : '');
644                 }
645
646                 removeRelationListeners();
647
648                 if ( entity == null ) {
649                         relationsGrid.dataProvider = null;
650                 } else {
651                         resetRelationsGrid(entity);
652                         entity.addEventListener(Connection.ADDED_TO_RELATION, addedToRelation);
653                         entity.addEventListener(Connection.REMOVED_FROM_RELATION, removedFromRelation);
654                 }
655       }
656
657           private function setupMultiAdvanced(entity:Entity):void {
658                 multiAdvancedTagGrid.init(entity);
659                 resetRelationsGrid(entity);
660                 entity.addEventListener(Connection.ADDED_TO_RELATION, addedToRelation, false, 0, true);
661                 entity.addEventListener(Connection.REMOVED_FROM_RELATION, removedFromRelation, false, 0, true);
662       }
663
664           public function addNewTag():void {
665                 if (sidebar.selectedChild==multiplePanel) { multiAdvancedTagGrid.addNewTag(); }
666                 else if (stack.selectedChild==advancedContainer) { advancedTagGrid.addNewTag(); }
667           }
668
669       private function addedToRelation(event:RelationMemberEvent):void {
670          resetRelationsGrid(selectedEntity);
671       }
672
673       private function removedFromRelation(event:RelationMemberEvent):void {
674          resetRelationsGrid(selectedEntity);
675       }
676
677       private function removeRelationListeners():void {
678           for each( var rel:Relation in listeningToRelations ) {
679               rel.removeEventListener(Connection.TAG_CHANGED, relationTagChanged);
680               rel.removeEventListener(Connection.RELATION_MEMBER_ADDED, entityRelationMemberChanged);
681               rel.removeEventListener(Connection.RELATION_MEMBER_REMOVED, entityRelationMemberChanged);
682           }
683           listeningToRelations = [];
684           if (relationsGrid) relationsGrid.removeEventListener(DataGridEvent.ITEM_EDIT_END, relationRoleChanged);
685           if (multiRelationsGrid) multiRelationsGrid.removeEventListener(DataGridEvent.ITEM_EDIT_END, relationRoleChanged);
686       }
687
688       private function resetRelationsGrid(entity:Entity):void {
689           removeRelationListeners();
690
691           var instance:DataGrid=relationsGrid;
692           if (entity is EntityCollection) instance=multiRelationsGrid;
693           var memberships:Array = entity.getRelationMemberships();
694           for each (var m:Object in memberships) {
695               m.relation.addEventListener(Connection.TAG_CHANGED, relationTagChanged);
696               m.relation.addEventListener(Connection.RELATION_MEMBER_ADDED, entityRelationMemberChanged);
697               m.relation.addEventListener(Connection.RELATION_MEMBER_REMOVED, entityRelationMemberChanged);
698               listeningToRelations.push(m.relation);
699           }
700           instance.dataProvider = memberships;
701           instance.addEventListener(DataGridEvent.ITEM_EDIT_END, relationRoleChanged, false, -100);
702       }
703
704       private function relationRoleChanged(event:DataGridEvent):void {
705                 if (event.dataField != 'role') { return; }      // shouldn't really happen
706
707                 var relations:Array=event.currentTarget.dataProvider.toArray();
708                 var props:Object=relations[event.rowIndex];
709
710                 var relation:Relation=props['relation'];
711                 var newRole:String=event.itemRenderer.data['role'];
712
713                 if (selectedEntity is EntityCollection) {
714                         for each (var entity:Entity in EntityCollection(selectedEntity).entities) {
715                                 var indexes:Array=relation.findEntityMemberIndexes(entity);
716                                 for each (var index:int in indexes) {
717                                         relation.setMember(index, new RelationMember(entity,newRole), MainUndoStack.getGlobalStack().addAction);
718                                 }
719                         }
720                 } else {
721                         relation.setMember(props['index'], new RelationMember(selectedEntity,newRole), MainUndoStack.getGlobalStack().addAction);
722                 }
723       }
724
725       private function relationTagChanged(event:TagEvent):void {
726           resetRelationsGrid(selectedEntity);
727       }
728
729       private function entityRelationMemberChanged(event:RelationMemberEvent):void {
730           resetRelationsGrid(selectedEntity);
731       }
732
733       private function checkMembers():void {
734           if (selectedEntity is Relation) {
735             setupMembers(selectedEntity as Relation);
736           }
737       }
738
739       private function setupMembers(rel:Relation):void {
740           var members:Array = [];
741           for (var i:int=0 ; i<rel.length; i++) {
742             var props:Object = {};
743             var member:RelationMember = rel.getMember(i);
744             props["id"] = member.entity.id;
745             props["type"] = member.entity.getType();
746             props["role"] = member.role;
747
748             members.push(props);
749           }
750           membersGrid.dataProvider = members;
751           membersGrid.dataProvider.addEventListener('collectionChange', membersChange);
752       }
753
754       private function membersChange(event:Event):void {
755           // Dropping all the members and re-adding them isn't exactly optimal
756           // but is at least robust for any kind of change.
757           // Figuring out a better way is someone else's FIXME
758
759           var rel:Relation = selectedEntity as Relation;
760           var action:CompositeUndoableAction = new CompositeUndoableAction("Rearrange relation members for "+rel);
761
762           // drop members
763           for (var i:int=rel.length-1 ; i>=0; i--) {
764             rel.removeMemberByIndex(i, action.push);
765           }
766
767           // add members in new order
768           for each(var memberObject:Object in membersGrid.dataProvider) {
769             var e:Entity;
770             var id:Number = memberObject.id;
771                         switch (memberObject.type) {
772                                 case 'node':            e = connection.getNode(id); break;
773                 case 'way':                     e = connection.getWay(id); break;
774                                 case 'relation':        e = connection.getRelation(id); break;
775             }
776             rel.appendMember(new RelationMember(e, memberObject.role), action.push);
777           }
778           MainUndoStack.getGlobalStack().addAction(action);
779       }
780
781       private function editRelation(id:Number):void {
782           var panel:RelationEditorPanel = RelationEditorPanel(
783               PopUpManager.createPopUp(Application(FlexGlobals.topLevelApplication), RelationEditorPanel, true));
784           panel.setRelation(connection.getRelation(id));
785           PopUpManager.centerPopUp(panel);
786       }
787
788         /** Create relation actions menu */
789
790         public function createRelationMenu(button:PopUpButton):void {
791                 var menu:Menu = new Menu(); 
792                 var dp:Object = [ {label: "Select all members"}, 
793                                                   {label: "Deselect all members"}, 
794                                                   {label: "Add selection to this relation", enabled: false},
795                                                   {label: "Delete relation"} ]; 
796                 menu.dataProvider = dp; 
797                 menu.addEventListener("itemClick", selectRelationMenu); 
798                 button.popUp = menu;
799         }
800
801         /** Enable 'add selection to...' entry only if some of the selection isn't in the relation.
802             Called each time the menu is clicked. */
803         
804         public function updateRelationMenu(event:Event):void {
805                 rowData=event.target.parent.data;       // this makes it accessible from selectRelationMenu
806                 var menu:Menu = Menu(event.target.popUp);
807                 var enable:Boolean = false;
808                 if (selectedEntity != null && selectedEntity is EntityCollection) {
809                         // Enable only if some entities aren't a member of the relation
810                         enable=!rowData.universal;
811                 }
812                 if (enable==menu.dataProvider[2].enabled) return;
813                 menu.dataProvider[2].enabled=enable;
814                 menu.invalidateList();
815         }
816
817         /** Do the action selected in the relation actions menu */
818
819         public function selectRelationMenu(event:MenuEvent):void {
820                 var rel:Relation=rowData.relation;
821                 var entities:Array;
822                 var controller:EditController=FlexGlobals.topLevelApplication.theController;
823                 switch (event.index) {
824                         case 0: // Select all members
825                                 entities=selectedEntity.entities.concat(rel.memberEntities);
826                                 entities=entities.filter(function(e:*, i:int, arr:Array):Boolean { return arr.indexOf(e) == i } );      // remove duplicates
827                                 // ** FIXME: This is a really horrible way of changing the controller state
828                                 controller.setState(controller.findStateForSelection(entities));
829                                 break;
830
831                         case 1: // Deselect all members
832                                 entities=selectedEntity.entities;
833                                 entities=entities.filter(function(e:*, i:int, arr:Array):Boolean { return !e.hasParent(rel) } );
834                                 controller.setState(controller.findStateForSelection(entities));
835                                 break;
836
837                         case 2: // Add selection to this relation
838                                 var undo:CompositeUndoableAction=new CompositeUndoableAction("Remove selection from relations");
839                                 for each (var entity:Entity in selectedEntity.entities) {
840                                         if (!entity.hasParent(rel)) {
841                                                 rel.appendMember(new RelationMember(entity,''), undo.push);
842                                         }
843                                 }
844                                 MainUndoStack.getGlobalStack().addAction(undo);
845                                 break;
846                         
847                         case 3: // Delete relation
848                                 var warning:String="This relation has # members. Deleting it will affect all of them and erase this $. Are you really sure?";
849                                 warning=warning.replace("#",rel.length).replace("$",rel.getRelationType());
850                                 Alert.show(warning,"Are you sure?",Alert.YES | Alert.CANCEL,null,
851                                         function(event:CloseEvent):void { 
852                                                 if (event.detail==Alert.CANCEL) return;
853                                                 rel.remove(MainUndoStack.getGlobalStack().addAction);
854                                         } , null, Alert.CANCEL);
855                                 break;
856                 }
857         }
858
859       private function tagChanged(event:TagEvent):void {
860           refreshFeatureIcon();
861       }
862
863       public function loadFeatures():void {
864           mapFeatures = MapFeatures.getInstance();
865           stack.removeChild(membersVBox); // remove by default, will be added if relation
866       }
867
868       /** Open up a new browser page, showing the help page as defined in Map Features XML file .*/
869       public function openDescription():void {
870           if ( feature != null && feature.hasHelpURL() )
871               navigateToURL(new URLRequest(feature.helpURL), "potlatch_help");
872       }
873
874       /** Open up a new browser page showing OSM's view of the current entity. */
875       public function openEntityPage():void {
876           if (selectedEntity != null && selectedEntity.id >= 0) {
877               // This is slightly hard-coded, but not drastically. The ../s could be changed for string manipulation of the apiBase
878               var urlBase:String = connection.apiBase + '../../browse/'
879               navigateToURL(new URLRequest(urlBase+selectedEntity.getType()+'/'+selectedEntity.id), "potlatch_browse");
880           }
881       }
882
883       public function addToRelation():void {
884           new RelationSelectPanel().init(selectedEntity,new Object());
885       }
886
887       private function removeFromRelation(id:Number, index:int=-1):void {
888                 var rel:Relation=connection.getRelation(id);
889                 if (index>-1) {
890                         rel.removeMemberByIndex(index, MainUndoStack.getGlobalStack().addAction);
891                 } else if (selectedEntity is EntityCollection) {
892                         var undo:CompositeUndoableAction=new CompositeUndoableAction("Remove selection from relations");
893                         for each (var e:Entity in EntityCollection(selectedEntity).entities) rel.removeMember(e,undo.push);
894                         MainUndoStack.getGlobalStack().addAction(undo);
895                 }
896       }
897
898       public function changeFeatureType(event:Event):void {
899           if ( selectedEntity == null )
900               return;
901
902           UIComponent.suspendBackgroundProcessing();
903           var newFeature:Feature = currentCategorySelector.selectedType;
904           var undoStack:Function = MainUndoStack.getGlobalStack().addAction;
905           var action:CompositeUndoableAction = new CompositeUndoableAction(
906                   "Set "+selectedEntity.getType()+" "+selectedEntity.id+" to "+newFeature.name);
907                   selectedEntity.suspend();
908           
909           // build a list of tags that are editable in new feature
910           var editableTags:Array = new Array();
911           for each( var editor:EditorFactory in newFeature.editors ) {
912               if ( editor is SingleTagEditorFactory ) {
913                   var singleTagEditor:SingleTagEditorFactory = editor as SingleTagEditorFactory;
914                   editableTags.push(singleTagEditor.key);
915               }
916           }
917
918           // remove tags from the current feature
919           if ( feature != null ) {
920               for each( var oldtag:Object in feature.tags ) {
921                   if ( editableTags.indexOf(oldtag["k"]) < 0 ) {
922                       selectedEntity.setTag(oldtag["k"], null, action.push);
923                   }
924               }
925           }
926
927           // set tags for new feature
928           if ( newFeature != null ) {
929               for each( var newtag:Object in newFeature.tags ) {
930                   selectedEntity.setTag(newtag["k"], newtag["v"], action.push);
931               }
932           }
933
934                   selectedEntity.resume();
935           undoStack(action);
936           popupChange.close();
937           initialiseEditors();
938           UIComponent.resumeBackgroundProcessing();
939       }
940
941         private function resizePOIGrid(event:Event):void {
942                 var rows:Number=event.target.dataProvider.length/event.target.columnCount;
943                 if (rows!=Math.floor(rows)) { rows=Math.floor(rows+1); }
944                 event.target.height=rows*(event.target.rowHeight+1);
945         }
946
947   ]]></fx:Script>
948 </mx:VBox>
949