Difference between revisions of "Board18Market6"

From BOARD18 Project WIKI
Jump to navigation Jump to search
(i)
 
(updated release notice)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
board18Market6.js contains all the functions that
{{ReleaseNoticeX|2.5|Design_Document_board18Market_Page}}
The board18Market6.js file contains all the functions that
respond to various onclick events on the stock chart in the  
respond to various onclick events on the stock chart in the  
Market page and on the main and tray menues.  <br>But right click  
Market page and on the main and tray menues.  But right click  
events that cause a context menu to be displayed are handled
events that cause a context menu to be displayed are handled
by functions in the board18Market5.js file.
by functions in the board18Market5.js file.


==Function registerMainMenu()==
== Function updateMenu(menuType)==
The registerMainMenu function creates the main menu on the  
The updateMenu function will update the menu move specific options.<br>
board18Market page. It uses the jquery context menu plugin.
The input '''menuType''' must be either 'active' or 'no'.<br>
If the '''menuType''' is 'active' then the menu will contain as its first
two options 'Accept Move' and 'Cancel Move'.<br>
If the '''menuType''' is 'no' then the menu will contain as its first
two options 'Undo Move' and 'Redo Move'.


==Function makeTrayItems()==
== Function makeTrayItems() ==
The makeTrayItems function will use the  
The makeTrayItems function will use the  
BD18.trays array to construct the items
BD18.trays array to construct the items
to be displayed in the tray menu.
to be displayed in the tray menu.


==Function registerTrayMenu()==
== Function registerTrayMenu() ==
The registerTrayMenu function creates the  
The registerTrayMenu function creates the  
tray menu on the board18Market page. It uses
tray menu on the board18Map page. It uses
the jquery context menu plugin and the
the jquery context menu plugin and the
makeTrayItems function.
makeTrayItems function.


==Function boxPos(event)==
== Function leftMenuEvent(key) ==
This function handles the selection of the leftMenu(Tray)
and displays the proper BD18.tray.
 
== Function boxPos(event) ==
This function calculates the board coordinates of a stock price
This function calculates the board coordinates of a stock price
box given the raw coordinates of a mouse click event.
box given the raw coordinates of a mouse click event.


==Function traySelect(event)==
== Function traySelect(event) ==
This function responds to onclick events in the trays canvas.
This function responds to onclick events in the trays canvas.
It selects a item from those currently displayed and highlites
It selects a item from those currently displayed and highlites
the selected item.
the selected item.


==Function boxSelect(event)==
== Function boxSelect(event) ==
This function responds to left mousedown events in the   
This function responds to left mousedown events in the   
map canvas. It checks various conditions and executes  
map canvas. It checks various conditions and executes  
Line 35: Line 44:
no relevant condition then it merely returns.
no relevant condition then it merely returns.


==Function mapMouseEvent(event)==
== Function mapMouseEvent(event) ==
This function responds to mousedown events on the map canvas.
This function responds to mousedown events on the map canvas.
It uses event.witch to determine which mouse button was pressed.
It uses event.witch to determine which mouse button was pressed.
If the left or center button was pressed then it calls the
If the left or center button was pressed then it calls the
boxSelect functon. Otherwise it assumes that the right button
boxSelect function. Otherwise it assumes that the right button
was pressed and does nothing. Right mose events are handled
was pressed and calls the ContextMenu function.
by the jquery.contextMenu library [see the makeMenus function].
== Function ContextMenu(event) ==
This function uses makeMenuItems to create a ContextMenu
The menu will be positioned so as not to overlap the
bounderies of the document. The displayed menu will not scroll.
 
== Function doit(mm,e) ==
This function is called via onclick events coded into the
main menu on the board18Map page. the passed parameter
indicates the menu choice to be acted upon.
 
mm is the onclick action to be taken.

Latest revision as of 08:06, 28 July 2017

This page has been updated to comply with Release 2.5.x of BOARD18. Go Back

The board18Market6.js file contains all the functions that respond to various onclick events on the stock chart in the Market page and on the main and tray menues. But right click events that cause a context menu to be displayed are handled by functions in the board18Market5.js file.

Function updateMenu(menuType)

The updateMenu function will update the menu move specific options.
The input menuType must be either 'active' or 'no'.
If the menuType is 'active' then the menu will contain as its first two options 'Accept Move' and 'Cancel Move'.
If the menuType is 'no' then the menu will contain as its first two options 'Undo Move' and 'Redo Move'.

Function makeTrayItems()

The makeTrayItems function will use the BD18.trays array to construct the items to be displayed in the tray menu.

Function registerTrayMenu()

The registerTrayMenu function creates the tray menu on the board18Map page. It uses the jquery context menu plugin and the makeTrayItems function.

Function leftMenuEvent(key)

This function handles the selection of the leftMenu(Tray) and displays the proper BD18.tray.

Function boxPos(event)

This function calculates the board coordinates of a stock price box given the raw coordinates of a mouse click event.

Function traySelect(event)

This function responds to onclick events in the trays canvas. It selects a item from those currently displayed and highlites the selected item.

Function boxSelect(event)

This function responds to left mousedown events in the map canvas. It checks various conditions and executes the appropriate function based on them. If it can find no relevant condition then it merely returns.

Function mapMouseEvent(event)

This function responds to mousedown events on the map canvas. It uses event.witch to determine which mouse button was pressed. If the left or center button was pressed then it calls the boxSelect function. Otherwise it assumes that the right button was pressed and calls the ContextMenu function.

Function ContextMenu(event)

This function uses makeMenuItems to create a ContextMenu The menu will be positioned so as not to overlap the bounderies of the document. The displayed menu will not scroll.

Function doit(mm,e)

This function is called via onclick events coded into the main menu on the board18Map page. the passed parameter indicates the menu choice to be acted upon.

mm is the onclick action to be taken.