plugins/dali-script-v8/docs/content/stage.js

   1 /**
   2 ## Stage API
   3
   4 The Stage is a top-level object used for displaying a tree of Actors.
   5
   6  - Stage is a static object used by accessing the dali.stage object.
   7  - Stage provides a top-level "root" actor.
   8  - Stage provides Key Events to the application
   9  - Stage has a background color you can set, see  {{#crossLink "stage/setBackgroundColor:method"}}{{/crossLink}}
  10
  11 When an actor is not required, remove it from the stage to save memory and help performance.
  12 ```
  13 dali.stage.setBackgroundColor( dali.COLOR_WHITE);
  14
  15 var stageSize = dali.stage.getSize();
  16
  17 var imageActor = new dali.ImageActor( );
  18
  19 dali.stage.add( imageActor );
  20
  21 // when the actor is no longer required
  22 dali.stage.remove( imageActor );
  23 ```
  24
  25 <img src="../assets/img/stage.png"/>
  26
  27 ### Key Events
  28
  29 Key events are received through the key-event callback.
  30
  31 ```
  32 daliApp.myCallback = function (keyEvent)
  33 {
  34   switch (keyEvent.keyDescription) {
  35           case "Up": log("up");
  36               break;
  37
  38           case "Down": log("down");
  39               break;
  40
  41           case "Left": log("left");
  42               break;
  43
  44           case "Right": log("right");
  45               break;
  46
  47   }
  48 }
  49
  50 dali.stage.connect("key-event", daliApp.myCallback);
  51 ```
  52
  53 The key event object has the following properties
  54 ```
  55   KeyEvent = {
  56     state,             // boolean  = "down" or "up" key state
  57     shiftPressed,      // boolean, shift key is held
  58     ctrlPressed,       // boolean, ctrl key is held
  59     altPressed,        // boolean, alt key is held
  60     keyModifiers,      // key modifiers
  61     keyCode,           // key code
  62     keyDescription,    // key description
  63     timestamp          // The time in milli-seconds when the event occured
  64   }
  65 ```
  66  @class Stage
  67 */