From c4218115053ba27c8243cc5eb28ce69bdaeeb281 Mon Sep 17 00:00:00 2001 From: Billy Lamberta Date: Wed, 13 Oct 2010 17:38:26 -0400 Subject: [PATCH] Generated docs for Text classes and associated static classes. Updated doc build script and index nav. --- build/majdoc | 12 +- doc/api/display.html | 6 + doc/api/elementnode.html | 6 + doc/api/event.html | 6 + doc/api/eventdispatcher.html | 6 + doc/api/fontstyle.html | 139 +++ doc/api/fontvariant.html | 120 +++ doc/api/fontweight.html | 158 ++++ doc/api/gradienttype.html | 6 + doc/api/graphics.html | 9 +- doc/api/index.html | 6 + doc/api/keyboard.html | 6 + doc/api/keyboardevent.html | 6 + doc/api/layer.html | 6 + doc/api/linecap.html | 6 + doc/api/linejoin.html | 6 + doc/api/matrix.html | 6 + doc/api/mouseevent.html | 6 + doc/api/node.html | 6 + doc/api/pattern.html | 6 + doc/api/point.html | 6 + doc/api/rectangle.html | 6 + doc/api/sprite.html | 8 +- doc/api/style/main.js | 7 + doc/api/text.html | 1658 ++++++++++++++++++++++++++++++++++ doc/api/textalign.html | 177 ++++ doc/api/textbaseline.html | 199 ++++ doc/api/textevent.html | 6 + doc/api/touchevent.html | 6 + doc/api/uievent.html | 6 + doc/api/utils-types.html | 6 + doc/api/utils.html | 6 + 32 files changed, 2615 insertions(+), 4 deletions(-) create mode 100644 doc/api/fontstyle.html create mode 100644 doc/api/fontvariant.html create mode 100644 doc/api/fontweight.html create mode 100644 doc/api/text.html create mode 100644 doc/api/textalign.html create mode 100644 doc/api/textbaseline.html diff --git a/build/majdoc b/build/majdoc index 64986ac..b31aee6 100755 --- a/build/majdoc +++ b/build/majdoc @@ -42,7 +42,7 @@ CLASS_INHERITS['EventDispatcher']='Object' CLASS_SRC['Node']="$SRC_HOME/node.js" CLASS_INHERITS['Node']='EventDispatcher:Object' CLASS_SRC['Sprite']="$SRC_HOME/sprite.js" -CLASS_INHERITS['Sprite']='Node:EventDispatcher:Object' +CLASS_INHERITS['Sprite']='Node:EventDispatcher:Objectw' CLASS_SRC['Graphics']="$SRC_HOME/graphics.js" CLASS_INHERITS['Graphics']='Object' @@ -81,6 +81,16 @@ CLASS_SRC['LineCap']="$SRC_HOME/constants/linecap.js" CLASS_SRC['LineJoin']="$SRC_HOME/constants/linejoin.js" CLASS_SRC['Pattern']="$SRC_HOME/constants/pattern.js" +#primitives +CLASS_SRC['FontStyle']="$SRC_HOME/primitives/constants/fontstyle.js" +CLASS_SRC['FontVariant']="$SRC_HOME/primitives/constants/fontvariant.js" +CLASS_SRC['FontWeight']="$SRC_HOME/primitives/constants/fontweight.js" +CLASS_SRC['TextAlign']="$SRC_HOME/primitives/constants/textalign.js" +CLASS_SRC['TextBaseline']="$SRC_HOME/primitives/constants/textbaseline.js" +CLASS_SRC['Text']="$SRC_HOME/primitives/text.js" +CLASS_INHERITS['Text']='Sprite:Node:EventDispatcher:Object' + + #parse multi-line doc comments from source file, #separate fields with '~' and concat to single line function parse_docs_from_file { diff --git a/doc/api/display.html b/doc/api/display.html index 7ad1ed3..e56749f 100644 --- a/doc/api/display.html +++ b/doc/api/display.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/elementnode.html b/doc/api/elementnode.html index a194a4e..532e161 100644 --- a/doc/api/elementnode.html +++ b/doc/api/elementnode.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/event.html b/doc/api/event.html index fba8762..1ee844f 100644 --- a/doc/api/event.html +++ b/doc/api/event.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/eventdispatcher.html b/doc/api/eventdispatcher.html index 9551121..d3a8544 100644 --- a/doc/api/eventdispatcher.html +++ b/doc/api/eventdispatcher.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/fontstyle.html b/doc/api/fontstyle.html new file mode 100644 index 0000000..09a80ff --- /dev/null +++ b/doc/api/fontstyle.html @@ -0,0 +1,139 @@ + + + + +Doodle.js - API: doodle.FontStyle + + + + + + + + + +
    +

    doodle.FontStyle

    + +
    +

    Description:

    +
    +
    FontStyle
    +
    +

    +
    + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Constants

    +
    +
    ITALIC :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    NORMAL :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    OBLIQUE :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    +
    + + + diff --git a/doc/api/fontvariant.html b/doc/api/fontvariant.html new file mode 100644 index 0000000..fbee1cd --- /dev/null +++ b/doc/api/fontvariant.html @@ -0,0 +1,120 @@ + + + + +Doodle.js - API: doodle.FontVariant + + + + + + + + + +
    +

    doodle.FontVariant

    + +
    +

    Description:

    +
    +
    FontVariant
    +
    +

    +
    + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Constants

    +
    +
    NORMAL :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    SMALL_CAPS :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    +
    + + + diff --git a/doc/api/fontweight.html b/doc/api/fontweight.html new file mode 100644 index 0000000..f8bc344 --- /dev/null +++ b/doc/api/fontweight.html @@ -0,0 +1,158 @@ + + + + +Doodle.js - API: doodle.FontWeight + + + + + + + + + +
    +

    doodle.FontWeight

    + +
    +

    Description:

    +
    +
    FontWeight
    +
    +

    +
    + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Constants

    +
    +
    BOLDER :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    BOLD :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    LIGHTER :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    NORMAL :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    +
    + + + diff --git a/doc/api/gradienttype.html b/doc/api/gradienttype.html index 115a95d..cfdcc23 100644 --- a/doc/api/gradienttype.html +++ b/doc/api/gradienttype.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/graphics.html b/doc/api/graphics.html index 6fa942c..efe4952 100644 --- a/doc/api/graphics.html +++ b/doc/api/graphics.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • @@ -43,7 +49,7 @@

    doodle.Graphics

    Description:

    -
    Graphics (draw:Array, extrema:Object) :Object
    +
    Graphics (draw:Array) :Object

    @@ -56,7 +62,6 @@

    Inherits

    Parameters

    1. draw:Array –
      2. -
    2. extrema:Object – Reference to object's extrema points.

    Returns

    diff --git a/doc/api/index.html b/doc/api/index.html index 0ff3263..3b4c309 100644 --- a/doc/api/index.html +++ b/doc/api/index.html @@ -24,6 +24,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -38,6 +41,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/keyboard.html b/doc/api/keyboard.html index c8585ac..5f90ed3 100644 --- a/doc/api/keyboard.html +++ b/doc/api/keyboard.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/keyboardevent.html b/doc/api/keyboardevent.html index c3cb789..f4b581b 100644 --- a/doc/api/keyboardevent.html +++ b/doc/api/keyboardevent.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/layer.html b/doc/api/layer.html index a0bef78..1944532 100644 --- a/doc/api/layer.html +++ b/doc/api/layer.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/linecap.html b/doc/api/linecap.html index ae16d44..6fe707d 100644 --- a/doc/api/linecap.html +++ b/doc/api/linecap.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/linejoin.html b/doc/api/linejoin.html index be62b93..b2bd15b 100644 --- a/doc/api/linejoin.html +++ b/doc/api/linejoin.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/matrix.html b/doc/api/matrix.html index 4a4d447..b6ba974 100644 --- a/doc/api/matrix.html +++ b/doc/api/matrix.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/mouseevent.html b/doc/api/mouseevent.html index a2e5e29..ac0e21a 100644 --- a/doc/api/mouseevent.html +++ b/doc/api/mouseevent.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/node.html b/doc/api/node.html index 8f54177..7318c39 100644 --- a/doc/api/node.html +++ b/doc/api/node.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/pattern.html b/doc/api/pattern.html index 61231d7..eedb847 100644 --- a/doc/api/pattern.html +++ b/doc/api/pattern.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/point.html b/doc/api/point.html index 1198a18..a1fa47a 100644 --- a/doc/api/point.html +++ b/doc/api/point.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/rectangle.html b/doc/api/rectangle.html index c219752..74734b7 100644 --- a/doc/api/rectangle.html +++ b/doc/api/rectangle.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/sprite.html b/doc/api/sprite.html index 670f444..e1265db 100644 --- a/doc/api/sprite.html +++ b/doc/api/sprite.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • @@ -52,7 +58,7 @@

    Inherits

    1. Node
    2. EventDispatcher
      3. -
    3. Object
      4. +
    4. Objectw

    Parameters

    diff --git a/doc/api/style/main.js b/doc/api/style/main.js index 291c27c..d4627ad 100644 --- a/doc/api/style/main.js +++ b/doc/api/style/main.js @@ -33,6 +33,8 @@ $(document).ready(function () { 'Matrix': doodle_base+"matrix.html", 'Point': doodle_base+"point.html", 'Rectangle': doodle_base+"rectangle.html", + //primitives + 'Text': doodle_base+"text.html", //events 'Event': doodle_base+"event.html", 'KeyboardEvent': doodle_base+"keyboardevent.html", @@ -46,6 +48,11 @@ $(document).ready(function () { 'LineCap': doodle_base+"linecap.html", 'LineJoin': doodle_base+"linejoin.html", 'Pattern': doodle_base+"pattern.html", + 'FontStyle': doodle_base+"fontstyle.html", + 'FontVariant': doodle_base+"fontvariant.html", + 'FontWeight': doodle_base+"fontweight.html", + 'TextAlign': doodle_base+"textalign.html", + 'TextBaseline': doodle_base+"textbaseline.html", //packages 'utils': doodle_base+"utils.html", 'utils.types': doodle_base+"utils-types.html", diff --git a/doc/api/text.html b/doc/api/text.html new file mode 100644 index 0000000..6b28ed3 --- /dev/null +++ b/doc/api/text.html @@ -0,0 +1,1658 @@ + + + + +Doodle.js - API: doodle.Text + + + + + + + + + +
    +

    doodle.Text

    + +
    +

    Description:

    +
    +
    Text (text:string) :Text
    +
    +

    +
    + +

    Inherits

    +
      +
    1. Sprite
      2. +
    2. Node
      3. +
    3. EventDispatcher
      4. +
    4. Object
      5. +
    + +

    Parameters

    +
      +
    1. text:string – [optional] Text to display.
      2. +
    + +

    Returns

    +
      +
    • Text – A text object.
      • +
    + +

    Throws

    +
      +
    • SyntaxError – Invalid parameters.
      • +
    • TypeError – Text argument not a string.
      • +
    + + + + +
    +
    +
    +
    +
    +

    Properties

    +
    +
    context :CanvasRenderingContext2D
    +
    +

    drawing context to use

    +
    + + + +

    Returns

    +
      +
    • CanvasRenderingContext2D –
      • +
    + + + + + + +
    +
    +
    height :number
    +
    +

    Indicates the height of the sprite, in pixels.

    +
    + + + +

    Returns

    +
      +
    • number –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    width :number
    +
    +

    Indicates the width of the sprite, in pixels.

    +
    + + + +

    Returns

    +
      +
    • number –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    align :TextAlign
    +
    +

    +
    + + + +

    Returns

    +
      +
    • TextAlign –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    • SyntaxError –
      • +
    + + + + +
    +
    +
    alpha :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number –
      • +
    + + + + + + +
    +
    +
    backgroundColor :Color
    +
    +

    +
    + + + +

    Returns

    +
      +
    • Color –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    baseline :TextBaseline
    +
    +

    +
    + + + +

    Returns

    +
      +
    • TextBaseline –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    • SyntaxError –
      • +
    + + + + +
    +
    +
    children :Array
    +
    +

    +
    + + + +

    Returns

    +
      +
    • Array –
      • +
    + + + + + + +
    +
    +
    color :Color
    +
    +

    +
    + + + +

    Returns

    +
      +
    • Color –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    debug.boundingBox :boolean
    +
    +

    +
    + + + +

    Returns

    +
      +
    • boolean –
      • +
    + + + + + + +
    +
    +
    fontFamily :String
    +
    +

    +
    + + + +

    Returns

    +
      +
    • String –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    font :String
    +
    +

    +
    + + + +

    Returns

    +
      +
    • String –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    • SyntaxError –
      • +
    • ReferenceError –
      • +
    + + + + +
    +
    +
    fontSize :Number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • Number – In pixels.
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    fontStyle :FontStyle
    +
    +

    +
    + + + +

    Returns

    +
      +
    • FontStyle –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    • SyntaxError –
      • +
    + + + + +
    +
    +
    fontVariant :FontVariant
    +
    +

    +
    + + + +

    Returns

    +
      +
    • FontVariant –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    • SyntaxError –
      • +
    + + + + +
    +
    +
    fontWeight :FontWeight
    +
    +

    +
    + + + +

    Returns

    +
      +
    • FontWeight –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    • SyntaxError –
      • +
    + + + + +
    +
    +
    id :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string –
      • +
    + + + + + + +
    +
    +
    parent :Node
    +
    +

    +
    + + + +

    Returns

    +
      +
    • Node –
      • +
    + + + + + + +
    +
    +
    root :Display
    +
    +

    +
    + + + +

    Returns

    +
      +
    • Display –
      • +
    + + + + + + +
    +
    +
    rotation :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number –
      • +
    + + + + + + +
    +
    +
    rotation :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    strokeColor :Color
    +
    +

    +
    + + + +

    Returns

    +
      +
    • Color –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    strokeWidth :Number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • Number –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    • RangeError –
      • +
    + + + + +
    +
    +
    text :String
    +
    +

    +
    + + + +

    Returns

    +
      +
    • String –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    transform :Matrix
    +
    +

    +
    + + + +

    Returns

    +
      +
    • Matrix –
      • +
    + + + + + + +
    +
    +
    visible :boolean
    +
    +

    +
    + + + +

    Returns

    +
      +
    • boolean –
      • +
    + + + + + + +
    +
    +
    x :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number –
      • +
    + + + + + + +
    +
    +
    y :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number –
      • +
    + + + + + + +
    +
    +
    graphics :Graphics
    +
    +

    The graphics object contains drawing operations to be stored in draw_commands. Objects and Arrays are passed by reference, so these will be modified

    +
    + + + +

    Returns

    +
      +
    • Graphics –
      • +
    + + + + + + +
    +
    +
    +
    +

    Methods

    +
    +
    modify (fn:Function) :Object
    +
    +

    Call function passing object as 'this'.

    +
    + +

    Parameters

    +
      +
    1. fn:Function –
      2. +
    + +

    Returns

    +
      +
    • Object –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    setChildIndex (child:Node, index:number) :void
    +
    +

    Changes the position of an existing child in the node's children array. This affects the layering of child objects.

    +
    + +

    Parameters

    +
      +
    1. child:Node –
      2. +
    2. index:number –
      3. +
    + + + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    willTrigger (type:string) :boolean
    +
    +

    Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. The difference between the hasEventListener() and the willTrigger() methods is that hasEventListener() examines only the object to which it belongs, whereas the willTrigger() method examines the entire event flow for the event specified by the type parameter.

    +
    + +

    Parameters

    +
      +
    1. type:string – The type of event.
      2. +
    + +

    Returns

    +
      +
    • boolean –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    hasEventListener (type:string) :boolean
    +
    +

    Checks whether the EventDispatcher object has any listeners registered for a specific type of event.

    +
    + +

    Parameters

    +
      +
    1. type:string –
      2. +
    + +

    Returns

    +
      +
    • boolean –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    contains (node:Node) :boolean
    +
    +

    Determine if node is among it's children, grandchildren, etc.

    +
    + +

    Parameters

    +
      +
    1. node:Node –
      2. +
    + +

    Returns

    +
      +
    • boolean –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    dispatchEvent (event:doodle.events.Event) :boolean
    +
    +

    Dispatches an event into the event flow. The event target is the EventDispatcher object upon which the dispatchEvent() method is called.

    +
    + +

    Parameters

    +
      +
    1. event:doodle.events.Event –
      2. +
    + +

    Returns

    +
      +
    • boolean – true if the event was successfully dispatched.
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    broadcastEvent (event:doodle.events.Event) :boolean
    +
    +

    Dispatches an event to every object with an active listener. Ignores propagation path, objects come from

    +
    + +

    Parameters

    +
      +
    1. event:doodle.events.Event –
      2. +
    + +

    Returns

    +
      +
    • boolean – True if the event was successfully dispatched.
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    • Error –
      • +
    + + + + +
    +
    +
    handleEvent (event:doodle.events.Event) :boolean
    +
    +

    Lookup and call listener if registered for specific event type.

    +
    + +

    Parameters

    +
      +
    1. event:doodle.events.Event –
      2. +
    + +

    Returns

    +
      +
    • boolean – true if node has listeners of event type.
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    addChildAt (node:Node, index:number) :Node
    +
    +

    +
    + +

    Parameters

    +
      +
    1. node:Node –
      2. +
    2. index:number –
      3. +
    + +

    Returns

    +
      +
    • Node –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    addChild (node:Node) :Node
    +
    +

    +
    + +

    Parameters

    +
      +
    1. node:Node –
      2. +
    + +

    Returns

    +
      +
    • Node –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    getBounds (targetCoordSpace:Node) :Rectangle
    +
    +

    +
    + +

    Parameters

    +
      +
    1. targetCoordSpace:Node –
      2. +
    + +

    Returns

    +
      +
    • Rectangle –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    getChildById (id:string) :Node|null
    +
    +

    +
    + +

    Parameters

    +
      +
    1. id:string –
      2. +
    + +

    Returns

    +
      +
    • Node|null –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    globalToLocal (point:Point) :Point
    +
    +

    +
    + +

    Parameters

    +
      +
    1. point:Point –
      2. +
    + +

    Returns

    +
      +
    • Point –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    hitTestObject (node:Node) :boolean
    +
    +

    +
    + +

    Parameters

    +
      +
    1. node:Node –
      2. +
    + +

    Returns

    +
      +
    • boolean –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    hitTestPoint (pt:Point) :boolean
    +
    +

    +
    + +

    Parameters

    +
      +
    1. pt:Point –
      2. +
    + +

    Returns

    +
      +
    • boolean –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    localToGlobal (point:Point) :Point
    +
    +

    +
    + +

    Parameters

    +
      +
    1. point:Point –
      2. +
    + +

    Returns

    +
      +
    • Point –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    removeAllChildren () :void
    +
    +

    +
    + + + + + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    removeChildAt (index:number) :void
    +
    +

    +
    + +

    Parameters

    +
      +
    1. index:number –
      2. +
    + + + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    removeChildById (id:string) :void
    +
    +

    +
    + +

    Parameters

    +
      +
    1. id:string –
      2. +
    + + + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    removeChild (node:Node) :void
    +
    +

    +
    + +

    Parameters

    +
      +
    1. node:Node –
      2. +
    + + + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    rotate (deg:number) :number
    +
    +

    +
    + +

    Parameters

    +
      +
    1. deg:number –
      2. +
    + +

    Returns

    +
      +
    • number –
      • +
    + + + + + + +
    +
    +
    scaleX (sx:number) :number
    +
    +

    +
    + +

    Parameters

    +
      +
    1. sx:number –
      2. +
    + +

    Returns

    +
      +
    • number –
      • +
    + + + + + + +
    +
    +
    scaleY (sy:number) :number
    +
    +

    +
    + +

    Parameters

    +
      +
    1. sy:number –
      2. +
    + +

    Returns

    +
      +
    • number –
      • +
    + + + + + + +
    +
    +
    swapChildren (node1:Node, node2:Node) :void
    +
    +

    +
    + +

    Parameters

    +
      +
    1. node1:Node –
      2. +
    2. node2:Node –
      3. +
    + + + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    addEventListener (type:string, listener:Function, useCapture:boolean) :void
    +
    +

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.

    +
    + +

    Parameters

    +
      +
    1. type:string –
      2. +
    2. listener:Function –
      3. +
    3. useCapture:boolean –
      4. +
    + + + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    removeEventListener (type:string, listener:Function, useCapture:boolean) :void
    +
    +

    Removes a listener from the EventDispatcher object.

    +
    + +

    Parameters

    +
      +
    1. type:string –
      2. +
    2. listener:Function –
      3. +
    3. useCapture:boolean –
      4. +
    + + + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    toString () :string
    +
    +

    Returns the string representation of the specified object.

    +
    + + + +

    Returns

    +
      +
    • string –
      • +
    + + + + + + +
    +
    +
    swapDepthAt (index:number) :void
    +
    +

    Swap positions with another node at a given index in the parents child list.

    +
    + +

    Parameters

    +
      +
    1. index:number –
      2. +
    + + + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    swapDepths (node:Node) :void
    +
    +

    Swap positions with another node in the parents child list.

    +
    + +

    Parameters

    +
      +
    1. node:Node –
      2. +
    + + + +

    Throws

    +
      +
    • TypeError –
      • +
    • ReferenceError –
      • +
    + + + + +
    +
    +
    swapChildrenAt (index1:number, index2:number) :void
    +
    +

    Swaps the child nodes at the two specified index positions in the child list.

    +
    + +

    Parameters

    +
      +
    1. index1:number –
      2. +
    2. index2:number –
      3. +
    + + + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    compose (x:number, y:number, width:number, height:number) :Sprite
    +
    +

    Updates the position and size of this sprite.

    +
    + +

    Parameters

    +
      +
    1. x:number –
      2. +
    2. y:number –
      3. +
    3. width:number –
      4. +
    4. height:number –
      5. +
    + +

    Returns

    +
      +
    • Sprite –
      • +
    + +

    Throws

    +
      +
    • TypeError –
      • +
    + + + + +
    +
    +
    +
    +

    Constants

    +
    +
    INPUT_METHOD_DROP :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number – [read-only]
      • +
    + + + + + + +
    +
    +
    INPUT_METHOD_HANDWRITING :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number – [read-only]
      • +
    + + + + + + +
    +
    +
    INPUT_METHOD_IME :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number – [read-only]
      • +
    + + + + + + +
    +
    +
    INPUT_METHOD_KEYBOARD :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number – [read-only]
      • +
    + + + + + + +
    +
    +
    INPUT_METHOD_MULTIMODAL :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number – [read-only]
      • +
    + + + + + + +
    +
    +
    INPUT_METHOD_OPTION :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number – [read-only]
      • +
    + + + + + + +
    +
    +
    INPUT_METHOD_PASTE :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number – [read-only]
      • +
    + + + + + + +
    +
    +
    INPUT_METHOD_SCRIPT :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number – [read-only]
      • +
    + + + + + + +
    +
    +
    INPUT_METHOD_UNKNOWN :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number – [read-only]
      • +
    + + + + + + +
    +
    +
    INPUT_METHOD_VOICE :number
    +
    +

    +
    + + + +

    Returns

    +
      +
    • number – [read-only]
      • +
    + + + + + + +
    +
    +
    TEXT_INPUT :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    +
    + + + diff --git a/doc/api/textalign.html b/doc/api/textalign.html new file mode 100644 index 0000000..48f7624 --- /dev/null +++ b/doc/api/textalign.html @@ -0,0 +1,177 @@ + + + + +Doodle.js - API: doodle.TextAlign + + + + + + + + + +
    +

    doodle.TextAlign

    + +
    +

    Description:

    +
    +
    TextAlign
    +
    +

    +
    + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Constants

    +
    +
    CENTER :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    END :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    LEFT :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    RIGHT :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    START :string
    +
    +

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    +
    + + + diff --git a/doc/api/textbaseline.html b/doc/api/textbaseline.html new file mode 100644 index 0000000..4a54d02 --- /dev/null +++ b/doc/api/textbaseline.html @@ -0,0 +1,199 @@ + + + + +Doodle.js - API: doodle.TextBaseline + + + + + + + + + +
    +

    doodle.TextBaseline

    + +
    +

    Description:

    +
    +
    TextBaseline
    +
    +

    +
    + + + + + + + + + + + +

    See Also

    + +
    +
    +
    +
    + +
    +

    Constants

    +
    +
    MIDDLE :string
    +
    +

    Let the anchor point's vertical position be half way between the bottom and the top of the em box of the first available font of the inline box.

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    ALPHABETIC :string
    +
    +

    Let the anchor point's vertical position be the alphabetic baseline of the first available font of the inline box.

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    BOTTOM :string
    +
    +

    Let the anchor point's vertical position be the bottom of the em box of the first available font of the inline box.

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    HANGING :string
    +
    +

    Let the anchor point's vertical position be the hanging baseline of the first available font of the inline box.

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    IDEOGRAPHIC :string
    +
    +

    Let the anchor point's vertical position be the ideographic baseline of the first available font of the inline box.

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    TOP :string
    +
    +

    Let the anchor point's vertical position be the top of the em box of the first available font of the inline box.

    +
    + + + +

    Returns

    +
      +
    • string – [read-only]
      • +
    + + + + + + +
    +
    +
    +
    + + + diff --git a/doc/api/textevent.html b/doc/api/textevent.html index 9792ebe..d378f34 100644 --- a/doc/api/textevent.html +++ b/doc/api/textevent.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/touchevent.html b/doc/api/touchevent.html index 127d86d..66ce1c9 100644 --- a/doc/api/touchevent.html +++ b/doc/api/touchevent.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/uievent.html b/doc/api/uievent.html index e65abd7..6a8cd50 100644 --- a/doc/api/uievent.html +++ b/doc/api/uievent.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/utils-types.html b/doc/api/utils-types.html index f7728cf..0fd24f5 100644 --- a/doc/api/utils-types.html +++ b/doc/api/utils-types.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent
    • diff --git a/doc/api/utils.html b/doc/api/utils.html index f69b68c..9f89dc0 100644 --- a/doc/api/utils.html +++ b/doc/api/utils.html @@ -17,6 +17,9 @@
  • ElementNode
  • Event
  • EventDispatcher
    • +
  • FontStyle
    • +
  • FontVariant
    • +
  • FontWeight
  • GradientType
  • Graphics
  • Keyboard
    • @@ -31,6 +34,9 @@
  • Point
  • Rectangle
  • Sprite
    • +
  • Text
    • +
  • TextAlign
    • +
  • TextBaseline
  • TextEvent
  • TouchEvent
  • UIEvent