aaaaahhhhh, interfaces are so greatly better than abstract classes wh…

…ere interfaces is enough... There is no more ununderstandable AbstractHandler in the project, is only IKeyHandler interface with 1 small default method and two abstract methods
klesun · Jan 10, 2016 · 0d47b47 · 0d47b47
1 parent 355760d
commit 0d47b47
Show file tree

Hide file tree

Showing 12 changed files with 92 additions and 107 deletions.
diff --git a/src/org/klesun_model/AbstractHandler.java b/src/org/klesun_model/AbstractHandler.java
diff --git a/src/org/klesun_model/IComponent.java b/src/org/klesun_model/IComponent.java
@@ -9,7 +9,7 @@ public interface IComponent
 	IModel getModel();
 	IComponent getModelParent();
 	IComponent getFocusedChild();
-	AbstractHandler getHandler();
+	IKeyHandler getHandler();
 
 	default Component getFirstAwtParent() {
 		IComponent context = this;

diff --git a/src/org/klesun_model/IKeyHandler.java b/src/org/klesun_model/IKeyHandler.java
@@ -0,0 +1,46 @@
+package org.klesun_model;
+
+// the IKeyHandler always comes in bound with Model's IComponent the idea of IKeyHandler is
+// such that the Model root Handler's handleKey() is called when we got the key
+// event from GUI; IKeyHandler checks the deepest focused child, whether it listens
+// for this key, if not - it's parent, if it's neither - it's parent, and so on, til
+// we get to the root we started from, and, if the root does not listen neither - we ignore event
+
+// we handle event ONLY ONCE - in the deepest focused child (+ root) we found
+
+import org.shmidusic.Main;
+
+import javax.swing.*;
+import java.awt.event.KeyEvent;
+import java.util.LinkedHashMap;
+
+public interface IKeyHandler
+{
+	final static int ctrl = KeyEvent.CTRL_MASK;
+	final static KeyEvent k = new KeyEvent(new JPanel(),0,0,0,0,'h'); // just for constants
+
+	default Explain handleKey(Combo combo)
+	{
+		Explain result = null;
+
+		if (getContext().getFocusedChild() != null) {
+			result = getContext().getFocusedChild().getHandler().handleKey(combo);
+		}
+
+		if ((result == null || !result.isSuccess()) && getMyClassActionMap().containsKey(combo)) {
+
+			result = getMyClassActionMap().get(combo).redo(getContext());
+			Main.window.updateMenuBar();
+		}
+
+		return result != null ? result : new Explain(false, "No Action For This Combination").setImplicit(true);
+	}
+
+	// we use this to (de)generate [File,Menu,Edit]-like menu that would
+	// (with few decorative exclusions) completely correspond whole model key mapping.
+	// the sad thing is, due to Java not supporting abstract class methods, we generate
+	// every IModel field structure on the fly upon instance creation - so we call this from fake instances
+	LinkedHashMap<Combo, ContextAction> getMyClassActionMap();
+
+	IComponent getContext();
+}
diff --git a/src/org/shmidusic/sheet_music/SheetMusicComponent.java b/src/org/shmidusic/sheet_music/SheetMusicComponent.java
@@ -23,7 +23,7 @@ public class SheetMusicComponent extends JPanel implements IComponent
 {
 	final public MainPanel mainPanel;
 	final public SheetMusic sheetMusic;
-	final AbstractHandler handler;
+	final IKeyHandler handler;
 
 	private Set<StaffComponent> staffComponentSet = new HashSet<>();
 
@@ -43,7 +43,8 @@ public SheetMusicComponent(SheetMusic sheetMusic, MainPanel mainPanel)
 
 		this.setFocusable(true);
 
-		this.handler = new AbstractHandler(this) {
+		IComponent self = this;
+		this.handler = new IKeyHandler() {
 			public LinkedHashMap<Combo, ContextAction> getMyClassActionMap() {
 				return new TruMap<>()
 					.p(new Combo(ctrl, k.VK_L), mkFailableAction(SheetMusicComponent::splitFocusedStaff))
@@ -58,8 +59,14 @@ public LinkedHashMap<Combo, ContextAction> getMyClassActionMap() {
 					.p(new Combo(ctrl, k.VK_E), mkFailableAction(FileProcessor::savePNG).setCaption("Export png"))
 						;
 			}
+			public IComponent getContext() { return self; };
 		};
-		this.addKeyListener(handler);
+		this.addKeyListener(Fp.onKey(e -> {
+			Explain result = handler.handleKey(new Combo(e));
+			if (!result.isSuccess() && !result.isImplicit()) {
+				JOptionPane.showMessageDialog(this, result.getExplanation());
+			}
+		}));
 		addMouseListener(Fp.onClick(e -> requestFocus()));
 	}
 
@@ -147,7 +154,7 @@ public StaffComponent getFocusedChild() {
 	}
 
 	@Override
-	public AbstractHandler getHandler() {
+	public IKeyHandler getHandler() {
 		return this.handler;
 	}
 

diff --git a/src/org/shmidusic/sheet_music/staff/MidianaComponent.java b/src/org/shmidusic/sheet_music/staff/MidianaComponent.java
@@ -1,23 +1,19 @@
 package org.shmidusic.sheet_music.staff;
 
-import org.shmidusic.MainPanel;
+import org.klesun_model.IKeyHandler;
 import org.shmidusic.stuff.graphics.ImageStorage;
 import org.shmidusic.stuff.graphics.Settings;
-import org.klesun_model.AbstractHandler;
 import org.klesun_model.IComponent;
 
-import java.awt.*;
-import java.awt.event.FocusListener;
-
 @Deprecated // sorry, forgot the reason
 abstract public class MidianaComponent implements IComponent
 {
 
 	final private IComponent parent;
-	final private AbstractHandler eventHandler;
+	final private IKeyHandler eventHandler;
 
 	abstract public MidianaComponent getFocusedChild();
-	abstract protected AbstractHandler makeHandler();
+	abstract protected IKeyHandler makeHandler();
 	/** @return int - position of bottomest drawn pixel */
 
 	// TODO: separate Model from Event handler, i wanna be able to instantiate Note without Staff!
@@ -28,7 +24,7 @@ public MidianaComponent(IComponent parent) {
 
 	// TODO: rename to getComponentParent()
 	public IComponent getModelParent() { return this.parent; }
-	public AbstractHandler getHandler() { return this.eventHandler; }
+	public IKeyHandler getHandler() { return this.eventHandler; }
 
 	final public Settings getSettings() {
 		return Settings.inst();

diff --git a/src/org/shmidusic/sheet_music/staff/StaffComponent.java b/src/org/shmidusic/sheet_music/staff/StaffComponent.java
@@ -1,6 +1,5 @@
 package org.shmidusic.sheet_music.staff;
 
-import org.klesun_model.AbstractHandler;
 import org.klesun_model.Explain;
 import org.klesun_model.IComponent;
 import org.shmidusic.sheet_music.SheetMusicComponent;
@@ -30,7 +29,8 @@ public class StaffComponent extends JPanel implements IComponent
 	private boolean isSelectionActive = false;
 	private int selectionStart = -1;
 
-	public StaffComponent(Staff staff, SheetMusicComponent parent) {
+	public StaffComponent(Staff staff, SheetMusicComponent parent)
+	{
 		this.parent = parent;
 		this.staff = staff;
 		this.handler = new StaffHandler(this);
@@ -174,7 +174,7 @@ public ChordComponent getFocusedChild()
 	}
 
 	@Override
-	public AbstractHandler getHandler()	{
+	public StaffHandler getHandler()	{
 		return this.handler;
 	}
 

diff --git a/src/org/shmidusic/sheet_music/staff/StaffHandler.java b/src/org/shmidusic/sheet_music/staff/StaffHandler.java
@@ -26,11 +26,13 @@
 import javax.swing.*;
 import javax.swing.filechooser.FileNameExtensionFilter;
 
-public class StaffHandler extends AbstractHandler {
+public class StaffHandler implements IKeyHandler
+{
+	final private StaffComponent context;
 
-	public StaffHandler(StaffComponent context) { super(context); }
+	public StaffHandler(StaffComponent context) { this.context = context; }
 	public StaffComponent getContext() {
-		return (StaffComponent)super.getContext();
+		return context;
 	}
 
 	private static TruMap<Combo, ContextAction<StaffComponent>> actionMap = new TruMap<>();

diff --git a/src/org/shmidusic/sheet_music/staff/chord/ChordComponent.java b/src/org/shmidusic/sheet_music/staff/chord/ChordComponent.java
@@ -2,10 +2,7 @@
 
 import org.apache.commons.math3.fraction.Fraction;
 import org.json.JSONObject;
-import org.klesun_model.AbstractHandler;
-import org.klesun_model.Explain;
-import org.klesun_model.IComponent;
-import org.klesun_model.IModel;
+import org.klesun_model.*;
 import org.klesun_model.field.IField;
 import org.shmidusic.sheet_music.staff.Staff;
 import org.shmidusic.sheet_music.staff.chord.note.Note;
@@ -187,7 +184,7 @@ public NoteComponent getFocusedChild() {
 	}
 
 	@Override
-	public AbstractHandler getHandler() {
+	public IKeyHandler getHandler() {
 		return this.handler;
 	}
 

diff --git a/src/org/shmidusic/sheet_music/staff/chord/ChordHandler.java b/src/org/shmidusic/sheet_music/staff/chord/ChordHandler.java
@@ -12,17 +12,17 @@
 import java.util.*;
 import java.util.function.*;
 
-public class ChordHandler extends AbstractHandler {
-
+public class ChordHandler implements IKeyHandler
+{
 	final public static int ACCORD_EPSILON = Note.getTimeMilliseconds(new Fraction(1, 16), 120); // 0.125 sec
 
+	final private ChordComponent context;
+
 	public ChordHandler(ChordComponent context) {
-		super(context);
+		this.context = context;
 	}
-
-	@Override
 	public ChordComponent getContext() {
-		return (ChordComponent)super.getContext();
+		return context;
 	}
 
 	private static TruMap<Combo, ContextAction<ChordComponent>> actionMap = new TruMap<>();

diff --git a/src/org/shmidusic/sheet_music/staff/chord/note/NoteComponent.java b/src/org/shmidusic/sheet_music/staff/chord/note/NoteComponent.java
@@ -1,7 +1,7 @@
 package org.shmidusic.sheet_music.staff.chord.note;
 
-import org.klesun_model.AbstractHandler;
 import org.klesun_model.Explain;
+import org.klesun_model.IKeyHandler;
 import org.shmidusic.sheet_music.staff.MidianaComponent;
 import org.shmidusic.sheet_music.staff.chord.ChordComponent;
 import org.shmidusic.sheet_music.staff.staff_config.KeySignature;
@@ -34,7 +34,7 @@ public MidianaComponent getFocusedChild() {
 	}
 
 	@Override
-	protected AbstractHandler makeHandler() {
+	protected IKeyHandler makeHandler() {
 		return new NoteHandler(this);
 	}
 

diff --git a/src/org/shmidusic/sheet_music/staff/chord/note/NoteHandler.java b/src/org/shmidusic/sheet_music/staff/chord/note/NoteHandler.java
@@ -1,9 +1,6 @@
 package org.shmidusic.sheet_music.staff.chord.note;
 
-import org.klesun_model.AbstractHandler;
-import org.klesun_model.Combo;
-import org.klesun_model.ContextAction;
-import org.klesun_model.Explain;
+import org.klesun_model.*;
 import org.klesun_model.field.Field;
 import org.klesun_model.field.IField;
 import org.shmidusic.stuff.graphics.Settings;
@@ -19,10 +16,12 @@
 import java.util.function.Consumer;
 import java.util.function.Function;
 
-public class NoteHandler extends AbstractHandler {
+public class NoteHandler implements IKeyHandler
+{
+	final private NoteComponent context;
 
 	public NoteHandler(NoteComponent context) {
-		super(context);
+		this.context = context;
 	}
 	private static TruMap<Combo, ContextAction<NoteComponent>> actionMap = new TruMap<>();
 	static {
@@ -71,12 +70,9 @@ private static Consumer<NoteComponent> modelRecalcTacts(Consumer<Note> modelLamb
 		};
 	}
 
-	@Override
 	public NoteComponent getContext() {
-		return (NoteComponent)super.getContext();
+		return context;
 	}
-
-	@Override
 	public LinkedHashMap<Combo, ContextAction> getMyClassActionMap() { return actionMap; }
 
 	public static LinkedHashMap<Combo, ContextAction<NoteComponent>> getClassActionMap() {

diff --git a/src/org/shmidusic/sheet_music/staff/staff_config/StaffConfigComponent.java b/src/org/shmidusic/sheet_music/staff/staff_config/StaffConfigComponent.java
@@ -1,8 +1,6 @@
 package org.shmidusic.sheet_music.staff.staff_config;
 
-import org.klesun_model.AbstractHandler;
-import org.klesun_model.Combo;
-import org.klesun_model.ContextAction;
+import org.klesun_model.*;
 import org.shmidusic.sheet_music.staff.MidianaComponent;
 import org.shmidusic.sheet_music.staff.StaffComponent;
 import org.shmidusic.stuff.OverridingDefaultClasses.TruMap;
@@ -32,11 +30,14 @@ public StaffConfig getModel() {
 	public MidianaComponent getFocusedChild() { return null; }
 
 	@Override
-	protected AbstractHandler makeHandler() {
-		return new AbstractHandler(this) {
+	protected IKeyHandler makeHandler()
+	{
+		IComponent self = this;
+		return new IKeyHandler() {
 			public LinkedHashMap<Combo, ContextAction> getMyClassActionMap() {
 				return new TruMap<>();
 			}
+			public IComponent getContext() { return self; }
 		};
 	}