API Docs for: 2.0.0

Class UIBuilder

Class defined in: public/src/ui_builder.js:22

Constructor for UIBuilder object

UIBuilder( json_cfg, clientID )
public/src/ui_builder.js:22
Parameters:
  • json_cfg <Object>

    configuration structure

  • clientID <Number>

    ID of the display client (-1, 0, ...N)

addRemoteSite( data )
public/src/ui_builder.js:1307

Add a remote side in the top sharing bar

Parameters:
  • data <Object>

    remote site information

background( )
public/src/ui_builder.js:67

Build the background image/color

build( )
public/src/ui_builder.js:262

Buidling the UI for the display

buildImageBox( id, imgsrc, title )
public/src/ui_builder.js:621

Builds a box to display an image

Parameters:
  • id <String>

    DOM id of the element created

  • imgsrc <String>

    URL to the image

  • title <String>

    text above the image

buildMessageBox( id, message )
public/src/ui_builder.js:565

Builds a box to display a message

Parameters:
  • id <String>

    DOM id of the element created

  • message <String>

    text to display

changeSagePointerMode( pointer_data )
public/src/ui_builder.js:1092

Switch between window and application interaction mode

Parameters:
  • pointer_data <Object>

    pointer information

changeSVGColor( svgItem, elementType, strokeColor, fillColor )
public/src/ui_builder.js:817

Change stroke and fill color of SVG elements

Parameters:
  • svgItem <Element>

    base node

  • elementType <String>

    type of SVG element to update

  • strokeColor <String>

    stroke color

  • fillColor <String>

    fill color

connectedToRemoteSite( data )
public/src/ui_builder.js:1361

Update remote side status and color

Parameters:
  • data <Object>

    remote site information

createRadialMenu( data )
public/src/ui_builder.js:1102

Create a radial menu

Parameters:
createSagePointer( pointer_data )
public/src/ui_builder.js:981

Create a pointer

Parameters:
  • pointer_data <Object>

    pointer information

drawObject( drawingObject )
public/src/ui_builder.js:863

Draws a drawing object gotten from the server to the tile's drawingSvg

Parameters:
  • drawingObject <Object>

    drawing object

hideDataSharingRequestDialog( )
public/src/ui_builder.js:1409

Close dialog to accept/reject requests for a new data sharing session from a remote site

hideDataSharingWaitingDialog( )
public/src/ui_builder.js:1433

Close dialog that displays wait message for data sharing session from a remote site

hideInterface( )
public/src/ui_builder.js:1442

Called when auto-hide kicks, using CSS features

hideSagePointer( pointer_data )
public/src/ui_builder.js:1053

Hide a pointer

Parameters:
  • pointer_data <Object>

    pointer information

logoLoaded( )
public/src/ui_builder.js:741

Called when SVG logo file is finished loading

radialMenuEvent( data )
public/src/ui_builder.js:1233

Deal with event in radial menu

Parameters:
setTime( val )
public/src/ui_builder.js:680

Update the clock in the title bar

Parameters:
  • val <Date>

    new time from server

showDataSharingRequestDialog( data )
public/src/ui_builder.js:1394

Dialog to accept/reject requests for a new data sharing session from a remote site

Parameters:
  • data <Object>

    remote site information

showDataSharingWaitingDialog( data )
public/src/ui_builder.js:1418

Dialog that displays wait message for data sharing session from a remote site

Parameters:
  • data <Object>

    remote site information

showError( )
public/src/ui_builder.js:697

Show a dialog on the wall when there is an error

showInterface( )
public/src/ui_builder.js:1482

Show the ui elements again

showSagePointer( pointer_data )
public/src/ui_builder.js:1022

Show the pointer: change CSS values, update position, label and color

Parameters:
  • pointer_data <Object>

    pointer information

toggleHelp( )
public/src/ui_builder.js:707

Show some help

updateObject( drawingObject )
public/src/ui_builder.js:923

update a drawing object already drawn in the drawingSvg

Parameters:
  • drawingObject <Object>

    drawing object

updateRadialMenu( data )
public/src/ui_builder.js:1173

Update the radial menu state (visibility, position)

Parameters:
updateRadialMenuApps( data )
public/src/ui_builder.js:1293

Update the list of app in the menu

Parameters:
updateRadialMenuDocs( data )
public/src/ui_builder.js:1279

Update the list of file in the menu

Parameters:
updateRadialMenuPosition( data )
public/src/ui_builder.js:1212

Update the radial menu position

Parameters:
updateSagePointerPosition( pointer_data )
public/src/ui_builder.js:1065

Move a pointer using CSS

Parameters:
  • pointer_data <Object>

    pointer information

updateVersionText( data )
public/src/ui_builder.js:722

Update the version number in the title bar

Parameters:
  • data <Object>

    new time from server

watermarkLoaded( )
public/src/ui_builder.js:782

Called when SVG watermark file is finished loading