@haxall/haxall
    Preparing search index...

    Class CompSpace

    CompSpace manages a tree of components. It is the base class for different component applications for control, Ion UI, and remote programming

    Hierarchy (View Summary)

    Implements

    • AbstractCompSpace
    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Check that the xeto can be loaded or raise exception

      Parameters

      • $xeto: string

      Returns this

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Create new component instance from dict state. The dict must have a Comp spec tag.

      Parameters

      Returns Comp

    • Create new list of component instances from dict state. Each dict must have a Comp spec tag.

      Parameters

      Returns List<Comp>

    • Convenience to create new default component instance from spec.

      Parameters

      Returns Comp

    • Iterate every component in space

      Parameters

      • f: (arg0: Comp) => void

      Returns void

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Log error

      Parameters

      • msg: string
      • Optionalerr: Err

      Returns void

    • This method should be called at periodically to execute components and check timers. The frequency this method is called determines the smallest timer increment. For example if its called every 100ms then timers will only fire as fast as 100ms.

      Parameters

      Returns void

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Initialize the root - this must be called exactly once during initialization

      Parameters

      • f: (arg0: this) => Comp

      Returns this

    • Initialize server provider interface for given instance

      Parameters

      Returns CompSpi

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Has this space been started, but not stopped yet

      Returns boolean

    • Load tree from xeto instances

      Parameters

      • $xeto: string

      Returns this

    • Xeto namespace for this space

      Returns LibNamespace

    • Callback anytime a component in the space is modified. The name and value are the slot modified, or null for a remove.

      Parameters

      Returns void

    • Create post-proessing

      Parameters

      Returns void

    • Callback when component is mounted into tree

      Parameters

      Returns void

    • Callback for subclasses on start

      Returns void

    • Callback for subclasses on stop

      Returns void

    • Callback when component is unmounted from tree

      Parameters

      Returns void

    • Read by id

      Parameters

      • id: Ref
      • Optionalchecked: boolean

      Returns Comp

    • Root component

      Returns Comp

    • Save tree to eto instances

      Returns string

    • Start space. Sublasses must begin to call checkTimers

      Returns void

    • Stop space. Sublasses must cease to call checkTimers

      Returns void

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • Modify the namespace on the fly. Every component in the current tree must map to a spec in the new namespace or exception is raised. This update does not check that components validate against the new specs.

      Parameters

      Returns void

    • Current version of component changes

      Returns number

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void