Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FullscreenComponent

フルスクリーン状態を管理するコンポーネント Grimoire.jsによって管理されているキャンバス(正確にはその親のコンテナ)のフルスクリーン状態等を管理します。 (他の要素をフルスクリーン化することも可能ですが、通常このGrimoire.jsによって生成されるキャンバスを含むDOM要素に対して用いられます。) また、一部の古いブラウザでは動作しない機能であることに注意してください。 また、fullscreen属性は必ず マウスのイベントなどのユーザーのインタラクションを伴うイベントからの呼び出しで 動的に trueにされる必要があります。 最初からtrueに設定して初期状態でキャンバスをフルスクリーン状態にすることはWebAPIの制約上できません。

Hierarchy

  • Component
    • FullscreenComponent

Index

Constructors

constructor

  • Returns FullscreenComponent

Properties

attributes

attributes: NSDictionary<Attribute>

Attributes managed by this component

type

{NSDictionary}

companion

companion: NSDictionary<any>

The dictionary which is shared in entire tree.

returns

[description]

disposed

disposed: boolean

element

element: Element

XMLElement of this component

type

{Element}

enabled

enabled: boolean

id

id: string

ID related to this instance to identify.

isActive

isActive: boolean

isDefaultComponent

isDefaultComponent: boolean

Whether this component was created by nodeDeclaration

type

{boolean}

name

name: NSIdentity

Name of this component

type

{NSIdentity}

node

node: GomlNode

Node this component is attached

type

{GomlNode}

tree

tree: GomlInterface

Tree interface for the tree this node is attached.

returns

[description]

Methods

$awake

  • $awake(): void

Protected ___addAtribute

  • ___addAtribute(name: string, attribute: IAttributeDeclaration): void
  • Parameters

    • name: string
    • attribute: IAttributeDeclaration

    Returns void

Protected ___addAttribute

  • ___addAttribute(name: string, attribute: IAttributeDeclaration): Attribute
  • Add additional attribute to this component.

    Parameters

    • name: string
    • attribute: IAttributeDeclaration

    Returns Attribute

Protected ___bindAttributes

  • ___bindAttributes(): void
  • Returns void

Protected ___removeAttributes

  • ___removeAttributes(name?: string): void
  • Parameters

    • Optional name: string

    Returns void

addEnabledObserver

  • addEnabledObserver(observer: function): void
  • Parameters

    • observer: function
        • (component: Component): void
        • Parameters

          • component: Component

          Returns void

    Returns void

awake

  • awake(): boolean
  • Returns boolean

dispose

  • dispose(): void
  • Returns void

getAttribute

  • getAttribute(name: Name): any
  • Parameters

    • name: Name

    Returns any

getAttributeRaw

  • getAttributeRaw(name: Name): Attribute
  • Parameters

    • name: Name

    Returns Attribute

getTypeName

  • getTypeName(): string
  • Obtain class name

    Returns string

    Class name of the instance.

initialized

  • initialized(info: ITreeInitializedInfo): void
  • Parameters

    • info: ITreeInitializedInfo

    Returns void

removeEnabledObserver

  • removeEnabledObserver(observer: function): boolean
  • Parameters

    • observer: function
        • (component: Component): void
        • Parameters

          • component: Component

          Returns void

    Returns boolean

resolveDefaultAttributes

  • resolveDefaultAttributes(nodeAttributes?: object | null): any
  • Parameters

    • Optional nodeAttributes: object | null

    Returns any

setAttribute

  • setAttribute(name: Name, value: any): void
  • Set value of attribute

    Parameters

    • name: Name
    • value: any

    Returns void

toString

  • toString(): string
  • Obtain stringfied object. If this method was not overridden, this method return class name.

    Returns string

    stringfied object

Static getUniqueRandom

  • getUniqueRandom(length: number): string
  • Generate random string

    Parameters

    • length: number

      length of random string

    Returns string

    generated string

Object literals

Static attributes

attributes: object

fullscreen

fullscreen: object

フルスクリーン状態かどうか

このフラグをtrueにする際は、必ず、マウスイベントなどのユーザーのインタラクションを伴うイベントからの呼び出しで変更されなければなりません。

したがって、GOMLで初期状態からこのフラグをtrueにすることはできません。

converter

converter: string = "Boolean"

default

default: boolean = false

fullscreenTarget

fullscreenTarget: object

フルスクリーンにするDOM要素へのクエリ

nullが指定された場合、キャンバスの親要素が用いられます。

converter

converter: string = "String"

default

default: null = null

Generated using TypeDoc