feat: Hotkey Manager

Author: Coldensjo

.gitignore

@@ -13,6 +13,8 @@ workerswfs/
 
 *.p12
 
+/.history
+
 # Project files, i.e. `.project`, `.actionScriptProperties` and `.flexProperties`
 # should NOT be excluded as they contain compiler settings and other important
 # information for Eclipse / Flash Builder.

locale/en_US/strings.properties

@@ -52,6 +52,7 @@ debug=Debug
 delete=Delete
 deleteFrame=Delete frame
 duplicate=Duplicate
+reset=Reset
 duplicateFrame=Duplicate frame
 edit=Edit
 edition=Edition
@@ -75,6 +76,7 @@ format=Format
 found=Found
 frameStrategy=Frame strategy
 general=General
+hotkeys=Hotkeys
 gettingFreeIds=Getting free ids
 hasingSprites=Hashing Sprites
 changingDurationsInItems=Changing frame durations in items
@@ -122,6 +124,7 @@ organizingSprites=Organizing sprites
 outfit=Outfit
 outfits=Outfits
 paste=Paste
+pressShortcut=Press shortcut...
 patterns=Patterns
 pause=Pause
 pingPong=Ping Pong

locale/es_ES/strings.properties

@@ -52,6 +52,7 @@ debug=Debug
 delete=Borrar
 deleteFrame=Borrar cuadro
 duplicate=Duplicar
+reset=Restablecer
 duplicateFrame=Duplicar cuadro
 edit=Editar
 edition=Edición
@@ -75,6 +76,7 @@ format=Formato
 found=Encontrado
 frameStrategy=Estrategia
 general=General
+hotkeys=Atajos
 gettingFreeIds=Buscando IDs libres
 hasingSprites=Hashing Sprites
 changingDurationsInItems=Cambiar la duración de los fotogramas en los elementos
@@ -122,6 +124,7 @@ organizingSprites=Organizando sprites
 outfit=Outfit
 outfits=Outfits
 paste=Pegar
+pressShortcut=Presione un atajo...
 patterns=Patrones
 pause=Pausar
 pingPong=Ping Pong

locale/pt_BR/strings.properties

@@ -52,6 +52,7 @@ debug=Debug
 delete=Deletar
 deleteFrame=Deletar quadro
 duplicate=Duplicar
+reset=Restaurar
 duplicateFrame=Duplicar quadro
 edit=Editar
 edition=Edição
@@ -75,6 +76,7 @@ format=Formato
 found=Encontrado
 frameStrategy=Frame strategy
 general=Geral
+hotkeys=Atalhos
 gettingFreeIds=Obtendo ids livres
 hasingSprites=Hashing Sprites
 changingDurationsInItems=Alterando as durações dos quadros nos itens
@@ -121,6 +123,7 @@ organizingSprites=Organizando sprites
 outfit=Roupa
 outfits=Roupas
 paste=Colar
+pressShortcut=Pressione um atalho...
 patterns=Padrões
 pause=Pausa
 pingPong=Ping Pong

src/ObjectBuilder.mxml

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="utf-8"?>
+<s:HGroup xmlns:fx="http://ns.adobe.com/mxml/2009"
+         xmlns:s="library://ns.adobe.com/flex/spark"
+         xmlns:controls="ob.components.controls.*"
+         width="100%"
+         verticalAlign="middle"
+         gap="10"
+         creationComplete="creationCompleteHandler(event)">
+    <fx:Metadata>
+        [ResourceBundle("strings")]
+    </fx:Metadata>
+
+    <fx:Script>
+        <![CDATA[
+            import flash.events.Event;
+            import flash.events.MouseEvent;
+
+            import mx.events.FlexEvent;
+            import ob.events.HotkeyManagerEvent;
+            import ob.hotkeys.HotkeyDefinition;
+            import ob.hotkeys.HotkeyManager;
+
+            [Bindable]
+            public var definition:HotkeyDefinition;
+
+            public var hotkeyManager:HotkeyManager;
+
+            protected function creationCompleteHandler(event:FlexEvent):void
+            {
+                if (hotkeyManager)
+                    hotkeyManager.addEventListener(HotkeyManagerEvent.HOTKEY_CHANGED, hotkeyChangedHandler, false, 0, true);
+
+                updateDisplay();
+            }
+
+            protected function inputChangeHandler(event:Event):void
+            {
+                if (!definition || !hotkeyManager)
+                    return;
+
+                hotkeyManager.updateHotkey(definition.id, hotkeyInput.hotkey);
+            }
+
+            protected function clearButtonClickHandler(event:MouseEvent):void
+            {
+                if (!definition || !hotkeyManager)
+                    return;
+
+                hotkeyManager.updateHotkey(definition.id, null);
+            }
+
+            protected function resetButtonClickHandler(event:MouseEvent):void
+            {
+                if (!definition || !hotkeyManager)
+                    return;
+
+                hotkeyManager.resetHotkey(definition.id);
+            }
+
+            protected function hotkeyChangedHandler(event:HotkeyManagerEvent):void
+            {
+                if (!definition || event.actionId != definition.id)
+                    return;
+
+                updateDisplay();
+            }
+
+            private function updateDisplay():void
+            {
+                if (!definition)
+                    return;
+
+                actionLabel.text = definition.label;
+                hotkeyInput.hotkey = definition.hotkey;
+                clearButton.enabled = definition.hotkey != null;
+                resetButton.enabled = definition.defaultHotkey != null && !definition.usesDefault();
+            }
+        ]]>
+    </fx:Script>
+
+    <s:Label id="actionLabel" width="100%" maxDisplayedLines="1"/>
+    <controls:HotkeyInput id="hotkeyInput"
+                          width="160"
+                          change="inputChangeHandler(event)"/>
+    <s:Button id="clearButton"
+              minWidth="60"
+              label="@Resource(key='clear', bundle='strings')"
+              click="clearButtonClickHandler(event)"/>
+    <s:Button id="resetButton"
+              minWidth="60"
+              label="@Resource(key='reset', bundle='strings')"
+              click="resetButtonClickHandler(event)"/>
+</s:HGroup>

src/ob/components/HotkeyEditorRow.mxml

@@ -53,6 +53,10 @@ THE SOFTWARE.
             import ob.settings.ObjectBuilderSettings;
 
             import otlib.assets.Assets;
+            import ob.components.HotkeyEditorRow;
+            import ob.hotkeys.HotkeyDefinition;
+            import ob.hotkeys.HotkeyManager;
+            import spark.components.Label;
 
             //--------------------------------------------------------------------------
             // PROPERTIES
@@ -62,6 +66,7 @@ THE SOFTWARE.
             private var _settingsChanged:Boolean;
             private var _detail:uint = DialogDetail.CANCEL;
             private var _languages:ArrayCollection;
+            private var _hotkeyManager:HotkeyManager;
 
             //--------------------------------------
             // Getters / Setters
@@ -82,6 +87,18 @@ THE SOFTWARE.
 
             public function get detail():uint { return _detail; }
 
+            public function get hotkeyManager():HotkeyManager { return _hotkeyManager; }
+            public function set hotkeyManager(value:HotkeyManager):void
+            {
+                if (_hotkeyManager == value)
+                    return;
+
+                _hotkeyManager = value;
+
+                if (initialized)
+                    rebuildHotkeyRows();
+            }
+
             //--------------------------------------------------------------------------
             // METHODS
             //--------------------------------------------------------------------------
@@ -103,6 +120,42 @@ THE SOFTWARE.
                 }
             }
 
+            private function rebuildHotkeyRows():void
+            {
+                if (!hotkeyContainer)
+                    return;
+
+                hotkeyContainer.removeAllElements();
+
+                if (!_hotkeyManager)
+                    return;
+
+                var definitions:Array = _hotkeyManager.definitions;
+                var currentCategory:String = null;
+
+                for each (var definition:HotkeyDefinition in definitions)
+                {
+                    if (!definition)
+                        continue;
+
+                    if (currentCategory != definition.category)
+                    {
+                        currentCategory = definition.category;
+
+                        var header:Label = new Label();
+                        header.text = currentCategory;
+                        header.setStyle("fontWeight", "bold");
+                        hotkeyContainer.addElement(header);
+                    }
+
+                    var row:HotkeyEditorRow = new HotkeyEditorRow();
+                    row.percentWidth = 100;
+                    row.definition = definition;
+                    row.hotkeyManager = _hotkeyManager;
+                    hotkeyContainer.addElement(row);
+                }
+            }
+
             //--------------------------------------
             // Private
             //--------------------------------------
@@ -182,6 +235,7 @@ THE SOFTWARE.
                 focusManager.showFocus();
 
                 setSettings(_settings);
+                rebuildHotkeyRows();
             }
 
             protected function confirmButtonClickHandler(event:MouseEvent):void
@@ -330,6 +384,18 @@ THE SOFTWARE.
             </mg:GroupBox>
 
         </s:NavigatorContent>
+
+        <s:NavigatorContent label="@Resource(key='hotkeys', bundle='strings')"
+                            width="100%" height="100%">
+            <s:layout>
+                <s:VerticalLayout padding="10" paddingTop="20" />
+            </s:layout>
+            <s:Scroller width="100%" height="100%">
+                <s:VGroup id="hotkeyContainer"
+                          width="100%"
+                          gap="10"/>
+            </s:Scroller>
+        </s:NavigatorContent>
     </mx:ViewStack>
 
     <s:BorderContainer width="100%" skinClass="com.mignari.skins.PixeledBorderContainerSkin">