Class Behavior<TData, TProperty, TMethod, TChainingFilter, TExtraThisFields>

constructor

• new Behavior<TData, TProperty, TMethod, TChainingFilter, TExtraThisFields>(): glassEasel.Behavior<TData, TProperty, TMethod, TChainingFilter, TExtraThisFields>

• Type Parameters

  • TData extends DataList
  • TProperty extends PropertyList
  • TMethod extends MethodList
  • TChainingFilter extends ChainingFilterType
  • TExtraThisFields extends DataList = Empty

  Returns glassEasel.Behavior<TData, TProperty, TMethod, TChainingFilter, TExtraThisFields>

is

ownerSpace

_$updateTemplate

• _$updateTemplate(template): void

• Parameters

  • template: {
        [key: string]: unknown;
    }

    • [key: string]: unknown

  Returns void

general

• general(): glassEasel.GeneralBehavior

• Returns glassEasel.GeneralBehavior

getComponentDependencies

• getComponentDependencies(genericTargets?): Set<glassEasel.GeneralComponentDefinition>

• List all component dependencies (recursively)

  This method will prepare the underlying behavior.

  Parameters

  • Optional genericTargets: {
        [name: string]: glassEasel.GeneralComponentDefinition | NativeNodeDefinition;
    }

    • [name: string]: glassEasel.GeneralComponentDefinition | NativeNodeDefinition

  Returns Set<glassEasel.GeneralComponentDefinition>

getMethods

• getMethods(): TMethod

• Get the methods

  Only valid after prepare .

  Returns TMethod

getPropertyOptionalType

• getPropertyOptionalType(name): undefined | null | NormalizedPropertyType[]

• Get the type of the specified property

  Only valid after prepare . Return undefined if the name is not a property.

  Parameters

  • name: string

  Returns undefined | null | NormalizedPropertyType[]

getPropertyType

• getPropertyType(name): undefined | NormalizedPropertyType

• Get the type of the specified property

  Only valid after prepare . Return undefined if the name is not a property.

  Parameters

  • name: string

  Returns undefined | NormalizedPropertyType

getTemplate

• getTemplate(): undefined | {
      [key: string]: unknown;
  }

• Get the template content

  This method is usually used by the template engine.

  Returns undefined | {
      [key: string]: unknown;
  }

hasBehavior

• hasBehavior(other): boolean

• Check whether the other behavior is a dependent behavior of this behavior

  Parameters

  • other: string | glassEasel.GeneralBehavior

  Returns boolean

listProperties

• listProperties(): string[]

• List the properties

  Only valid after prepare .

  Returns string[]

prepare

• prepare(): void

• Execute the prepare phase (an optimization phase) of this behavior

  Every behavior needs this phase for better future performance. However, this phase requires a little time for execution, and requires its all dependent behaviors created. If a dependent behavior is not prepared, then its prepare phase is also executed.

  Returns void

Static create

• create<TData, TProperty, TMethod>(def, ownerSpace?): glassEasel.Behavior<Empty & TData, Empty & TProperty, Empty & TMethod, never, Empty>

• Create a behavior with classic-style definition

  Type Parameters

  • TData extends DataList
  • TProperty extends PropertyList
  • TMethod extends MethodList

  Parameters

  • def: ComponentParams<TData, TProperty, TMethod> & ThisType<ComponentInstance<TData, TProperty, TMethod, Empty>>
  • Optional ownerSpace: ComponentSpace

  Returns glassEasel.Behavior<Empty & TData, Empty & TProperty, Empty & TMethod, never, Empty>

Static prepare

• prepare<TData, TProperty, TMethod, TChainingFilter>(behavior): void

• Same as prepare method in the prototype (for backward compatibility)

  Type Parameters

  • TData extends DataList
  • TProperty extends PropertyList
  • TMethod extends MethodList
  • TChainingFilter extends ChainingFilterType = never

  Parameters

  • behavior: glassEasel.Behavior<TData, TProperty, TMethod, TChainingFilter, Empty>

  Returns void