Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

You can donate to the Synchronet project using PayPal.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
module:ddlightbarmenu.js [2018/03/24 16:10] – Created a documentation page for load/DDLightbarMenu.js as a developer reference. nightfoxmodule:ddlightbarmenu.js [2019/05/09 02:40] (current) – removed digital man
Line 1: Line 1:
-====== DDLightbarMenu.js ====== 
-DDLightbarMenu.js is a loadable JavaScript file that provides a lightbar menu class for use in JavaScript scripts for Synchronet.  DDLightbarMenu supports single item selection and multiple item selection.  For one example of how to use DDLightbarMenu, you can look at the code for ''[[howto:door:slyvote]]''.\\ 
-\\ 
-The user can naviate the list using the up & down arrows, PageUp, PageDown, Home, and End keys.  The enter key selects an item.  The ESC key will exit the menu and return null.  This menu library requires the use of an ANSI terminal.  By default, this menu library does not display a border around the menu.  If you want this library to draw a border around the menu, you can set the borderEnabled property to true.  Without a border, the menu gains 2 characters of width and 2 lines of height. 
- 
-This script provides an object, DDLightbarMenu.  Use the DDLightbarMenu constructor to create the object.  Some other notable methods: 
-  * Add() 
-  * SetItemHotkey() 
-  * AddItemHotkey() 
-  * SetPos() 
-  * SetSize() 
-  * GetVal() 
- 
-To change the colors used for displaying the items, you can change the values in the colors object within the DDLightbarMenu object.  These are the current supported colors: 
-  * itemColor: The color to use for non-selected items (current default is white on blue) 
-  * selectedItemColor: The color to use for selected items (current default is blue on white) 
-  * itemTextCharHighlightColor: The color of a highlighted non-space character in an item text (specified by having a & in the item text).  It's important not to specify a "\1n" in here in case the item text should have a background color. 
-  * borderColor: The color for the borders (if borders are enabled) 
- 
-By default, the menu selection will wrap around to the beginning/end when using the down/up arrows.  That behavior can be disabled by setting the wrapNavigation property to false. 
- 
-This menu object supports adding multiple hotkeys to each menu item.  A hotkey can be specified in the Add() method a couple of different ways - By specifying a hotkey as the 3rd parameter and/or by putting a & in the menu item text just before a key you want to use as the hotkey.  For example, in the text "E&xit", "x" would be used as the hotkey for the item.  If you want to disable the use of ampersands for hotkeys in menu items (for instance, if you want an item to literally display an ampersand before a character), set the ampersandHotkeysInItems property to false.  For instance: 
-  lbMenu.ampersandHotkeysInItems = false; 
-Note that ampersandHotkeysInItems must be set before adding menu items. 
- 
-You can call the SetItemHotkey() method to set a single hotkey to be used for a menu item or AddItemHotkey() to add an additional hotkey for an item in addition to any existing hotkeys it might already have. 
- 
-This menu class also supports an optional "numbered mode", where each option is displayed with a number to the left (starting at 1), and the user is allowed to choose an option by typing the number of the item.  Numbered mode is disabled by default and can be enabled by setting the numberedMode property to true.  For example: 
-  lbMenu.numberedMode = true; 
-When numbered mode is enabled and the user starts typing a number, the menu will prompt the user for an item number.  Note that the prompt will be located on the line below the menu, so in addition to the menu's height, you'll also need an extra line on the screen to account for the item prompt.  In addition, when the user presses the enter key after the item number, a carriage return/line feed will be outputted, so in numbered mode, the menu's height should not go further than 2 lines below the console height.  Otherwise, the display of the menu will not be correct if the user decides not to enter a number. 
- 
-This menu also supports multiple options selected (by default, that is not enabled).  To enable that, set the multiSelect property to true.  When enabled, the GetVal() method will return an array of the user's selections rather than a string (or null if the user aborted).  You can also set a limit on the number of items selected in multi-select mode by setting the maxNumSelections property.  The default value is -1, which means no limit (0 also means no limit).  Example, with a limit: 
-  lbMenu.multiSelect = true; 
-  lbMenu.maxNumSelections = 5; 
- 
-Example usage: 
-  load("DDLightbarMenu.js"); 
-  // Create a menu at position 1, 3 with width 45 and height of 10 
-  var lbMenu = new DDLightbarMenu(1, 3, 45, 10); 
-  // Add 12 items to the menu, each of which will return the text of the item 
-  for (var i = 0; i < 12; ++i) 
-    lbMenu.Add("Item " + +(i+1), "Item " + +(i+1)); 
-  // Set up the hotkey "s" to select the 2nd item 
-  lbMenu.SetItemHotkey(1, "s"); 
-  // Show the menu and get the chosen item from the user 
-  var val = lbMenu.GetVal(); 
-  // Output the chosen menu item 
-  console.print("\1n\r\n"); 
-  console.print("Value:" + val + ":, type: " + typeof(val) + "\r\n"); 
-  console.pause(); 
-   
-  // Changing the normal item color to green & selected item color to bright green: 
-  lbMenu.colors.itemColor = "\1n\1g"; 
-  lbMenu.colors.selectedItemColor = "\1n\1h\1g"; 
-   
-  // Disabling the navigation wrap behavior: 
-  lbMenu.wrapNavigation = false; 
-   
-  // If you want a particular character in an item's text highlighted with 
-  // a different color, you can put a & character immediately before it, as 
-  // long as it's not a space.  For instance, to highlight the "x" in "Exit": 
-  lbMenu.Add("E&xit", -1); 
- 
-To enable borders, set the borderEnabled property to true.  Example: 
-  lbMenu.borderEnabled = true; 
- 
-The menu object has an object called borderChars, which stores the characters used to draw the border.  you can change the characters used to draw the border by setting the following properties of the borderChars object: 
-  * upperLeft: The character to use for the upper-left corner 
-  * upperRight: The character to use for the upper-right corner 
-  * lowerLeft: The character to use for the lower-left corner 
-  * lowerRight: The character to use for the lower-right corner 
-  * top: The character to use for the top border 
-  * bottom: The character to use for the bottom border 
-  * left: The character to use for the left border 
-  * right: The character to use for the right border 
-For example: 
-  lbMenu.borderChars.upperLeft = "\xDA"; // Single-line upper-left character 
- 
-If you want hotkeys to be case-sensitive, you can set the hotkeyCaseSensitive property to true (it is false by default).  For example: 
-  lbMenu.hotkeyCaseSensitive = true; 
- 
-===== See Also ===== 
-  * [[:module:|module index]] 
- 
-{{tag>}} 
  

Trace: