- New: autofocus on menuitems so that they are autofocused when page opens

- Bugfix: FullPage confirmation page now follow parent page custom positioning
- Change: MPage.item_getCurrent() will now return MItem instead of MItemData

Author: john32b

haxelib.json

@@ -1,6 +1,6 @@
 {
   "name": "djFlixel",
-  "version": "0.5.7",
+  "version": "0.5.8",
   "releasenote": "",
   "description": "Set of tools and helpers for HaxeFlixel",
   "url" : "https://github.com/john32b/djFlixel",

readme.md

@@ -1,5 +1,5 @@
 
-> :star: **NEW UPDATE** (2023-04) `V0.5.7` See [Announcement](https://github.com/john32b/djFlixel/discussions/25)  
+> :star: **NEW UPDATE** (2023-05) `V0.5.8` See [Announcements Page](https://github.com/john32b/djFlixel/discussions/categories/announcements)  
 
 # 🔦 What is it
 

src/djFlixel/ui/FlxMenu.hx

@@ -476,9 +476,15 @@ class FlxMenu extends FlxGroup
 
 				case 3: // Call - Confirm New Page
 					var P = MPageData.getConfirmationPage(it);
-						_flag_restore_selected_index = true;	// Use the custom index 
+						var a = pageActive;
+						P.par({
+							pos:a.PAR.pos,
+							x:a.PAR.x,
+							y:a.PAR.y,
+							width:a.PAR.width
+						});
 						goto(P);
-					_mev(pageCall, "?fs");
+						_mev(pageCall, "?fs");
 					return;
 
 				default: 
@@ -648,7 +654,7 @@ class FlxMenu extends FlxGroup
 		MP.y = mpActive.indexItem.y;
 		add(MP);
 
-		MP.setSelection(P.PAR.cindex);
+		MP.selectFirstAvailable();
 		MP.viewOn();
 	}//---------------------------------------------------;
 

src/djFlixel/ui/menu/MItemData.hx

@@ -25,6 +25,7 @@
 	
 	- There are some standard field options that can go to any field, these are:
 	
+*new*	|AF| AutoFocus. Will make the item focused by default when the page opens
 		|D|	Put it after the mandatory fields. Will DISABLE the element
 		|U| Put it after the mandatory fields. Will make the item UNSELECTABLE (useful for labels)
 		|I=Some Text|  Writes custom text in the .info field of the object. It can be used later however you want
@@ -214,6 +215,8 @@ class MItemData
 		.ask		;	Array<String> The question to ask in {linK} if .ltype==2,3 
 						e.g. ["Are you sure?","Yes","No"] valid for {links}
 						
+		.autofocus  ;   Boolean. If this is set. This item gets focused by default
+						
 	   
 	**/
 	public var P:Dynamic = {};
@@ -255,8 +258,16 @@ class MItemData
 			for (i in F)
 			{
 				// Check for universal parameters:
-				// Currently : { |D| , |U| }
+				// Currently : { |D| , |U| , |AF| }
 
+				
+				// |AF| , for autofocusing
+				if (i == "AF")
+				{
+					P.autofocus = true;
+					continue;
+				}
+				
 				// |D| , for Disabling the item
 				if (i == "D") {
 					disabled = true;

src/djFlixel/ui/menu/MPage.hx

@@ -146,6 +146,7 @@ class MPage extends VList<MItem,MItemData>
 		// Set data and init the items
 		setDataSource(page.items);
 
+		
 		// :: NEW : All cursor logic is in its own place
 		// TODO, Cache the cursor object to be reusable?
 		if (STP.cursor != null)
@@ -221,18 +222,24 @@ class MPage extends VList<MItem,MItemData>
 		}
 	}//---------------------------------------------------;
 
-	// Initializes the emenu, and focuses the first available
+	/**
+	  - Called whenever a page is shown normally (i.e. not when going back to it)
+	  - Initializes the menu and focuses an item (first selectable, or custom autofocus)
+	**/
 	public function selectFirstAvailable()
 	{
-		setSelection(get_nextSelectableIndex(0, 1));
+		var ind = page.getAutofocus();
+		if (ind < 0) ind = get_nextSelectableIndex(0, 1);
+		setSelection(ind);
 	}//---------------------------------------------------;
 
 
-	/**Focus an item, Moves the cursor to that item, scrolls the view if needed
+	/** Focuses an item (moves the cursor to that item and item gets highlighted)
+	    Hard-scrolls the view if needed
 	   @param  id ID of the Item
 	   @return Success
 	**/
-	public function item_moveCursorTo(id:String):Bool
+	public function item_focus(id:String):Bool
 	{
 		var i = page.getIndex(id);
 		if (i >-1){
@@ -277,12 +284,14 @@ class MPage extends VList<MItem,MItemData>
 
 	}//---------------------------------------------------;
 
-	/** Get the current active item data the cursor is pointing
+	/** 
+	 * ~ NEW in 0.5.8. BREAKING CHANGES : This now returns items, not itemdata
+	 * ~ to get itemdata, simple do item_getCurrent().data;
+	 * Get the current item the cursor is pointing
 	 */
-	public function item_getCurrent():MItemData
+	public function item_getCurrent():MItem
 	{
-		if (indexData < 0) return null;
-		return data[indexData];
+		return indexItem;
 	}//---------------------------------------------------;
 
 

src/djFlixel/ui/menu/MPageData.hx

@@ -149,6 +149,18 @@ class MPageData
 	}//---------------------------------------------------;
 
 
+	/**
+	   Checks items for "autofocus"
+	   @return Index of item to be autofocused. -1 for nothing
+	**/
+	public function getAutofocus():Int
+	{
+		for (ind in 0...items.length) {
+			if (items[ind].P.autofocus != null) return ind;
+		}
+		return -1;
+	}//---------------------------------------------------;
+	
 
 	/**
 	   Quickly construct a pagedata with the confirmation options of the Link Item
@@ -171,10 +183,9 @@ class MPageData
 			}
 		}
 
-		P.add(' ${Q[1]}|link|${item.P.link} -|${Q[2]}|link|@back');
+		P.add(' ${Q[1]}|link|${item.P.link} -|${Q[2]}|link|@back|AF');
 		P.PAR.noPool = true;
 		P.PAR.slots = P.items.length;
-		P.PAR.cindex = P.items.length - 1;	// Highlight the last one by default
 		return P;
 	}//---------------------------------------------------;