SAGE2: SAGE2_UI

Makes the speech debug text visible.

Removes all entries from context menu.

Create a list of element, returns the longest one

• list <Event>

  list of files

• type <Event>

  type of list

• parent <Event>

  add elements to parent

Format a date into a string

• date <Date>

  date

Check if transcript is a local speech command.

Animated the listening visual

Starts the mouse hold recognition. If there has not been a 1st name mention. Restart listener. Show listening. Mark this as getting an automatic name mention.

Handler for closing a dialog box with ESC key

• event <Event>

  event data

Start drag'n'drop

• event <Event>

  event data

Detect drag leave event

• event <Event>

  event data

Handler for file drop

• event <Event>

  event data

Triggered on file upload complete: redraw UI

Upload a file from the UI (not drag-and-drop)

File upload progress callback

• percent <Number>

  process

File upload start callback

• files <Object>

  array-like that containing the file infos

Handler for force click event (safari)

• event <Event>

  event data

Get a CSS value from a style sheet

• cssFile <String>

  CSSS sheet

• selector <String>

  item to search

Processing click

• element <Element>

  DOM element triggering the click

Processing double click

• element <Element>

  DOM element triggering the double click

Populates context menu. Called on initial right click with empty array for entriesToAdd Called again when appContextMenuContents packet is received. The call is given data.entries, data.app

Entries created will store their information within the div.

• data <Object>
  • Object with properties described below.
  • x <Integer>
    • Location of original right click.
  • y <Integer>
    • Location of original right click.
  • entries <Array>
    • Array of objects describing each entry.
  • app <Array>
    • App id the menu is for.

Hides context menu from the document. It only makes visibility hidden. So values are still there.

Show a given dialog

• id <String>

  element to show

Hide the touch mouse overlay

Intializes the speech recognition object.

Initializes by creating listeners to restart and enable sending if mouse is held down.

Handler for key down

• event <Event>

  event data

Handler for key press

• event <Event>

  event data

Handler for key up

• event <Event>

  event data

Creates and intializes the listening visual.

Start the selected application

Open a selected file

First handler for mouse event: fiding out if device has a mouse

• event <Event>

  event data

Updates position of mouse location to move the listening visual.

• e <Object>
  • The mouse event, should be standard.

Handler for detecting backspace outside the drawing area

• event <Event>

  event data

Will open a page containing the voice help.

Pad a number to string

• n <Number>

  input number

• width <Number>

  maximum width

• z <String>

  padding character, 0 by default

Handler for click event

• event <Event>

  event data

Handler for double click event

• event <Event>

  event data

Handler for mouse move

• event <Event>

  event data

Handler for mouse press

• event <Event>

  event data

Handler for mouse up

• event <Event>

  event data

Handler for pointer scroll event

• event <Event>

  event data

Prevent default event processing on a event

• event <Event>

  event data

Reload the page if server reloads

• callback <Function>

  function to call

Resize window handling

Resize menus

• ratio <Number>

  scale factor

Restarts the voice recognition if mouse is held down, after response speech is done.

Entry point of the user interface

Handler resizes

• ratio <Number>

  scale factor

Hides the SAGE2 pointer dialog

Enable the SAGE2 pointer dialog

UI will speak the date.

UI will speak the time.

This function is activated in 2 ways.

1. User click the send button.
2. User hits enter when making a note. This check is done in the noBackspace funciton. When activated will make the packet to launch app. Collects values from tags on page.

Set whether or not to show the listening visual.

• shouldShow <Boolean>
  • true to show, otherwise false.

Activates after receiving from server what the name marker is. Only after receiving will it init the voice recognition.

This sets the values of the note making button to make instead of save.

After loading page will perform additional setup for the context menu. Mainly to do with javascript loading of variables for later use.

setupFocusHandlers

Sets context menu to visible and moves to coordinates. Called after setting the entries.

• x <Integer>
  • x position.
• y <Integer>
  • y position.

Show a given dialog

• id <String>

  element to show

Show the touch mouse overlay

Initialize speech synthesis

Will attempt to voice the given what to say.

• whatToSay <String>
  • will attempt to say this.

Toggles speech recongition on / off.

Will toggle whether or not voice recognition starts for long click and hold.

Handler for touch end event

• event <Event>

  event data

Handler for touch move event

• event <Event>

  event data

Handler for touch start event

• event <Event>

  event data

When a user tries to draw on the doodle canavs, the events are converted to locations of where to place the line data. Previous location to current location. The client doesn't actually cause their canvas to update. The app sends a confirmation back which causes the canvas to update.

• xDest <Number>
  • location on canvas for next point.
• yDest <Number>
  • location on canvas for next point.
• xPrev <Number>
  • previous location on canvas.
• yPrev <Number>
  • previous location on canvas.

This will be called from a wsio packet "sendDataToClient". Must clear out canvas, set state, show dialog. Should happen when a user chooses to edit an existing doodle. Their canvas needs to be set to the current state of the doodle before edits should be made. But, doodles can be made from images which have varying sizes. They must also be contained within view correctly.

• data <Object>
  • object with properties below.
  • imageWidth <Object>
    • image resolution.
  • imageHeight <Object>
    • image resolution.
  • canvasImage <Object>
    • image as toDataURL().
  • clientDest <Object>
    • should be this client.
  • appId <Object>
    • app id this is for.

Called when the user creates a new doodle, or closes the doodle dialog. This is necessary because the doodle canvas space is a shared draw space, if they do not remove themselves the app will continue to send updates even if they are not currently editing the app.

• data <Object>
  • object with properties below.
  • imageWidth <Object>
    • image resolution.
  • imageHeight <Object>
    • image resolution.
  • canvasImage <Object>
    • image as toDataURL().
  • clientDest <Object>
    • should be this client.
  • appId <Object>
    • app id this is for.