Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextContainer

Common aspects of top-level Text classes

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

accessibilityId

accessibilityId: number = null

accessibilityPriority

accessibilityPriority: number = 2

accessibilityText

accessibilityText: string = null

alpha

alpha: number

bitmapCache

bitmapCache: BitmapCache

cacheCanvas

cacheCanvas: HTMLCanvasElement | Object

cacheID

cacheID: number

characterCase

characterCase: Case = Case.NORMAL

children

children: DisplayObject[]

compositeOperation

compositeOperation: string

cursor

cursor: string

filters

filters: Filter[]

font

font: string = "belinda"

hitArea

hitArea: DisplayObject

id

id: number

mask

mask: Shape

mouseChildren

mouseChildren: boolean

mouseEnabled

mouseEnabled: boolean

name

name: string

numChildren

numChildren: number

original

original: ConstructObj = null

parent

parent: Container

regX

regX: number

regY

regY: number

rotation

rotation: number

scaleX

scaleX: number

scaleY

scaleY: number

shadow

shadow: Shadow

skewX

skewX: number

skewY

skewY: number

snapToPixel

snapToPixel: boolean

stage

stage: Stage

style

style: Style[] = null

text

text: string = ""

tickChildren

tickChildren: boolean

tickEnabled

tickEnabled: boolean

transformMatrix

transformMatrix: Matrix2D

visible

visible: boolean

x

x: number

y

y: number

Static suppressCrossDomainErrors

suppressCrossDomainErrors: boolean

Methods

addAccessibility

  • addAccessibility(): void

addChild

  • addChild<T>(child: T): T
  • addChild<T>(child0: DisplayObject, lastChild: T): T
  • addChild<T>(child0: DisplayObject, child1: DisplayObject, lastChild: T): T
  • addChild<T>(child0: DisplayObject, child1: DisplayObject, child2: DisplayObject, lastChild: T): T
  • addChild(...children: DisplayObject[]): DisplayObject

  • Type parameters

    • T: DisplayObject

    Parameters

    • child: T

    Returns T

  • Type parameters

    • T: DisplayObject

    Parameters

    • child0: DisplayObject
    • lastChild: T

    Returns T

  • Type parameters

    • T: DisplayObject

    Parameters

    • child0: DisplayObject
    • child1: DisplayObject
    • lastChild: T

    Returns T

  • Type parameters

    • T: DisplayObject

    Parameters

    • child0: DisplayObject
    • child1: DisplayObject
    • child2: DisplayObject
    • lastChild: T

    Returns T

  • Parameters

    • Rest ...children: DisplayObject[]

    Returns DisplayObject

addChildAt

  • addChildAt<T>(child: T, index: number): T
  • addChildAt<T>(child0: DisplayObject, lastChild: T, index: number): T
  • addChildAt<T>(child0: DisplayObject, child1: DisplayObject, lastChild: T, index: number): T
  • addChildAt(...childOrIndex: (number | DisplayObject)[]): DisplayObject

  • Type parameters

    • T: DisplayObject

    Parameters

    • child: T
    • index: number

    Returns T

  • Type parameters

    • T: DisplayObject

    Parameters

    • child0: DisplayObject
    • lastChild: T
    • index: number

    Returns T

  • Type parameters

    • T: DisplayObject

    Parameters

    • child0: DisplayObject
    • child1: DisplayObject
    • lastChild: T
    • index: number

    Returns T

  • Parameters

    • Rest ...childOrIndex: (number | DisplayObject)[]

    Returns DisplayObject

addEventListener

  • addEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): Function
  • addEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): Function
  • addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean }, useCapture?: boolean): Object
  • addEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void }, useCapture?: boolean): Object

  • Parameters

    • type: string
    • listener: (eventObj: Object) => boolean
        • (eventObj: Object): boolean

        • Parameters

          • eventObj: Object

          Returns boolean

    • Optional useCapture: boolean

    Returns Function

  • Parameters

    • type: string
    • listener: (eventObj: Object) => void
        • (eventObj: Object): void

        • Parameters

          • eventObj: Object

          Returns void

    • Optional useCapture: boolean

    Returns Function

  • Parameters

    • type: string
    • listener: { handleEvent: (eventObj: Object) => boolean }
      • handleEvent: (eventObj: Object) => boolean
          • (eventObj: Object): boolean

          • Parameters

            • eventObj: Object

            Returns boolean

    • Optional useCapture: boolean

    Returns Object

  • Parameters

    • type: string
    • listener: { handleEvent: (eventObj: Object) => void }
      • handleEvent: (eventObj: Object) => void
          • (eventObj: Object): void

          • Parameters

            • eventObj: Object

            Returns void

    • Optional useCapture: boolean

    Returns Object

cache

  • cache(x: number, y: number, width: number, height: number, scale?: number): void

  • Parameters

    • x: number
    • y: number
    • width: number
    • height: number
    • Optional scale: number

    Returns void

clone

  • clone(recursive?: boolean): Container

  • Parameters

    • Optional recursive: boolean

    Returns Container

complete

  • complete(): void

contains

  • contains(child: DisplayObject): boolean

  • Parameters

    • child: DisplayObject

    Returns boolean

dispatchEvent

  • dispatchEvent(eventObj: Object, target?: Object): boolean
  • dispatchEvent(eventObj: string, target?: Object): boolean
  • dispatchEvent(eventObj: Event, target?: Object): boolean

  • Parameters

    • eventObj: Object
    • Optional target: Object

    Returns boolean

  • Parameters

    • eventObj: string
    • Optional target: Object

    Returns boolean

  • Parameters

    • eventObj: Event
    • Optional target: Object

    Returns boolean

draw

  • draw(ctx: CanvasRenderingContext2D, ignoreCache?: boolean): boolean

  • Parameters

    • ctx: CanvasRenderingContext2D
    • Optional ignoreCache: boolean

    Returns boolean

fontLoaded

  • fontLoaded(): void

Private fontsFromCharacterStyles

  • fontsFromCharacterStyles(styles: any): any[]

getBounds

  • getBounds(): Rectangle

  • Returns Rectangle

getCacheDataURL

  • getCacheDataURL(): string

getCharCodeAt

  • getCharCodeAt(index: number): number

getChildAt

  • getChildAt(index: number): DisplayObject

  • Parameters

    • index: number

    Returns DisplayObject

getChildByName

  • getChildByName(name: string): DisplayObject

  • Parameters

    • name: string

    Returns DisplayObject

getChildIndex

  • getChildIndex(child: DisplayObject): number

  • Parameters

    • child: DisplayObject

    Returns number

getConcatenatedDisplayProps

  • getConcatenatedDisplayProps(props?: DisplayProps): DisplayProps

getConcatenatedMatrix

  • getConcatenatedMatrix(mtx?: Matrix2D): Matrix2D

  • Parameters

    • Optional mtx: Matrix2D

    Returns Matrix2D

getMatrix

  • getMatrix(matrix?: Matrix2D): Matrix2D

  • Parameters

    • Optional matrix: Matrix2D

    Returns Matrix2D

getNumChildren

  • getNumChildren(): number
  • deprecated
    • use numChildren property instead.

    Returns number

getObjectUnderPoint

  • getObjectUnderPoint(x: number, y: number, mode: number): DisplayObject

  • Parameters

    • x: number
    • y: number
    • mode: number

    Returns DisplayObject

getObjectsUnderPoint

  • getObjectsUnderPoint(x: number, y: number, mode: number): DisplayObject[]

  • Parameters

    • x: number
    • y: number
    • mode: number

    Returns DisplayObject[]

getStage

  • getStage(): Stage
  • deprecated

    Returns Stage

getTransformedBounds

  • getTransformedBounds(): Rectangle

globalToLocal

  • globalToLocal(x: number, y: number, pt?: Point | Object): Point

  • Parameters

    • x: number
    • y: number
    • Optional pt: Point | Object

    Returns Point

hasEventListener

  • hasEventListener(type: string): boolean

  • Parameters

    • type: string

    Returns boolean

hitTest

  • hitTest(x: number, y: number): boolean

  • Parameters

    • x: number
    • y: number

    Returns boolean

isVisible

  • isVisible(): boolean

  • Returns boolean

Abstract layout

  • layout(): any

Protected ligatureSwap

  • ligatureSwap(char: Character, ligTarget: string): number

  • Figure out how many characters a ligature covers, and swap character glyph

    Parameters

    Returns number

Protected loadFonts

  • loadFonts(): void

localToGlobal

  • localToGlobal(x: number, y: number, pt?: Point | Object): Point

  • Parameters

    • x: number
    • y: number
    • Optional pt: Point | Object

    Returns Point

localToLocal

  • localToLocal(x: number, y: number, target: DisplayObject, pt?: Point | Object): Point

  • Parameters

    • x: number
    • y: number
    • target: DisplayObject
    • Optional pt: Point | Object

    Returns Point

off

  • off(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): void
  • off(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): void
  • off(type: string, listener: { handleEvent: (eventObj: Object) => boolean }, useCapture?: boolean): void
  • off(type: string, listener: { handleEvent: (eventObj: Object) => void }, useCapture?: boolean): void
  • off(type: string, listener: Function, useCapture?: boolean): void

  • Parameters

    • type: string
    • listener: (eventObj: Object) => boolean
        • (eventObj: Object): boolean

        • Parameters

          • eventObj: Object

          Returns boolean

    • Optional useCapture: boolean

    Returns void

  • Parameters

    • type: string
    • listener: (eventObj: Object) => void
        • (eventObj: Object): void

        • Parameters

          • eventObj: Object

          Returns void

    • Optional useCapture: boolean

    Returns void

  • Parameters

    • type: string
    • listener: { handleEvent: (eventObj: Object) => boolean }
      • handleEvent: (eventObj: Object) => boolean
          • (eventObj: Object): boolean

          • Parameters

            • eventObj: Object

            Returns boolean

    • Optional useCapture: boolean

    Returns void

  • Parameters

    • type: string
    • listener: { handleEvent: (eventObj: Object) => void }
      • handleEvent: (eventObj: Object) => void
          • (eventObj: Object): void

          • Parameters

            • eventObj: Object

            Returns void

    • Optional useCapture: boolean

    Returns void

  • Parameters

    • type: string
    • listener: Function
    • Optional useCapture: boolean

    Returns void

on

  • on(type: string, listener: (eventObj: Object) => boolean, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Function
  • on(type: string, listener: (eventObj: Object) => void, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Function
  • on(type: string, listener: { handleEvent: (eventObj: Object) => boolean }, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Object
  • on(type: string, listener: { handleEvent: (eventObj: Object) => void }, scope?: Object, once?: boolean, data?: any, useCapture?: boolean): Object

  • Parameters

    • type: string
    • listener: (eventObj: Object) => boolean
        • (eventObj: Object): boolean

        • Parameters

          • eventObj: Object

          Returns boolean

    • Optional scope: Object
    • Optional once: boolean
    • Optional data: any
    • Optional useCapture: boolean

    Returns Function

  • Parameters

    • type: string
    • listener: (eventObj: Object) => void
        • (eventObj: Object): void

        • Parameters

          • eventObj: Object

          Returns void

    • Optional scope: Object
    • Optional once: boolean
    • Optional data: any
    • Optional useCapture: boolean

    Returns Function

  • Parameters

    • type: string
    • listener: { handleEvent: (eventObj: Object) => boolean }
      • handleEvent: (eventObj: Object) => boolean
          • (eventObj: Object): boolean

          • Parameters

            • eventObj: Object

            Returns boolean

    • Optional scope: Object
    • Optional once: boolean
    • Optional data: any
    • Optional useCapture: boolean

    Returns Object

  • Parameters

    • type: string
    • listener: { handleEvent: (eventObj: Object) => void }
      • handleEvent: (eventObj: Object) => void
          • (eventObj: Object): void

          • Parameters

            • eventObj: Object

            Returns void

    • Optional scope: Object
    • Optional once: boolean
    • Optional data: any
    • Optional useCapture: boolean

    Returns Object

removeAllChildren

  • removeAllChildren(): void

  • Returns void

removeAllEventListeners

  • removeAllEventListeners(type?: string): void

removeChild

  • removeChild(...child: DisplayObject[]): boolean

  • Parameters

    • Rest ...child: DisplayObject[]

    Returns boolean

removeChildAt

  • removeChildAt(...index: number[]): boolean

  • Parameters

    • Rest ...index: number[]

    Returns boolean

removeEventListener

  • removeEventListener(type: string, listener: (eventObj: Object) => boolean, useCapture?: boolean): void
  • removeEventListener(type: string, listener: (eventObj: Object) => void, useCapture?: boolean): void
  • removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => boolean }, useCapture?: boolean): void
  • removeEventListener(type: string, listener: { handleEvent: (eventObj: Object) => void }, useCapture?: boolean): void
  • removeEventListener(type: string, listener: Function, useCapture?: boolean): void

  • Parameters

    • type: string
    • listener: (eventObj: Object) => boolean
        • (eventObj: Object): boolean

        • Parameters

          • eventObj: Object

          Returns boolean

    • Optional useCapture: boolean

    Returns void

  • Parameters

    • type: string
    • listener: (eventObj: Object) => void
        • (eventObj: Object): void

        • Parameters

          • eventObj: Object

          Returns void

    • Optional useCapture: boolean

    Returns void

  • Parameters

    • type: string
    • listener: { handleEvent: (eventObj: Object) => boolean }
      • handleEvent: (eventObj: Object) => boolean
          • (eventObj: Object): boolean

          • Parameters

            • eventObj: Object

            Returns boolean

    • Optional useCapture: boolean

    Returns void

  • Parameters

    • type: string
    • listener: { handleEvent: (eventObj: Object) => void }
      • handleEvent: (eventObj: Object) => void
          • (eventObj: Object): void

          • Parameters

            • eventObj: Object

            Returns void

    • Optional useCapture: boolean

    Returns void

  • Parameters

    • type: string
    • listener: Function
    • Optional useCapture: boolean

    Returns void

render

  • render(): void

set

  • set(props: Object): DisplayObject

  • Parameters

    • props: Object

    Returns DisplayObject

setBounds

  • setBounds(x: number, y: number, width: number, height: number): void

  • Parameters

    • x: number
    • y: number
    • width: number
    • height: number

    Returns void

setChildIndex

  • setChildIndex(child: DisplayObject, index: number): void

  • Parameters

    • child: DisplayObject
    • index: number

    Returns void

setTransform

  • setTransform(x?: number, y?: number, scaleX?: number, scaleY?: number, rotation?: number, skewX?: number, skewY?: number, regX?: number, regY?: number): DisplayObject

  • Parameters

    • Optional x: number
    • Optional y: number
    • Optional scaleX: number
    • Optional scaleY: number
    • Optional rotation: number
    • Optional skewX: number
    • Optional skewY: number
    • Optional regX: number
    • Optional regY: number

    Returns DisplayObject

sortChildren

  • sortChildren(sortFunction: (a: DisplayObject, b: DisplayObject) => number): void

  • Parameters

    • sortFunction: (a: DisplayObject, b: DisplayObject) => number
        • (a: DisplayObject, b: DisplayObject): number

        • Parameters

          • a: DisplayObject
          • b: DisplayObject

          Returns number

    Returns void

swapChildren

  • swapChildren(child1: DisplayObject, child2: DisplayObject): void

  • Parameters

    • child1: DisplayObject
    • child2: DisplayObject

    Returns void

swapChildrenAt

  • swapChildrenAt(index1: number, index2: number): void

  • Parameters

    • index1: number
    • index2: number

    Returns void

toString

  • toString(): string

  • Returns string

uncache

  • uncache(): void

  • Returns void

updateCache

  • updateCache(compositeOperation?: string): void

  • Parameters

    • Optional compositeOperation: string

    Returns void

updateContext

  • updateContext(ctx: CanvasRenderingContext2D): void

  • Parameters

    • ctx: CanvasRenderingContext2D

    Returns void

willTrigger

  • willTrigger(type: string): boolean

  • Parameters

    • type: string

    Returns boolean

Static initialize

  • initialize(target: Object): void

  • Parameters

    • target: Object

    Returns void

Generated using TypeDoc