@haxall/haxall
    Preparing search index...

    Class Link

    Link is a hyperlink.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Add a child to this node. If adding a text node it is automatically merged with the trailing text node (if applicable). If the node is arlready parented thorw ArgErr. Return this.

      Parameters

      Returns this

    • Convenicence to call add for each node in the given list.

      Parameters

      Returns this

    • Parameters

      Returns this

    • Returns string

    • Parameters

      • it: string

      Returns void

    • Get a readonly list of this elements's children.

      Returns List<DocNode>

    • 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

    • Debug dump to output stream.

      Parameters

      Returns void

    • Iterate the children nodes

      Parameters

      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

    • 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

    • Get the HTML element name to use for this element.

      Returns string

    • Get node id for node type.

      Returns DocNodeId

    • Insert a child node at the specified index. A negative index may be used to access an index from the end of the list. If adding a text node it is automatically merged with surrounding text nodes (if applicable). If the node is already parented throws ArgErr.

      Parameters

      Returns this

    • Is this a block element versus an inline element.

      Returns boolean

    • Returns boolean

    • Parameters

      • it: boolean

      Returns void

    • Return true if this node is the first child in its parent.

      Returns boolean

    • 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

    • Is this an inline versus a block node.

      Returns boolean

    • Return true if this node is the last child in its parent.

      Returns boolean

    • Is the text of the link the same as the URI string

      Returns boolean

    • Returns number

    • Parameters

      • it: number

      Returns void

    • Get the DocElem that contains this node. Return null if not parented.

      Returns DocElem

    • Get the DocElem that contains this node. Return null if not parented.

      Parameters

      Returns void

    • Covariant override to narrow path to list of DocElem.

      Returns List<DocElem>

    • Get the index of this node in its parent's children. Return null if not parented.

      Returns number

    • Remove a child node. If this element is not the child's current parent throw ArgErr. Return this.

      Parameters

      Returns this

    • Remove all child nodes. Return this.

      Returns this

    • Change the text to display for the link

      Parameters

      • text: string

      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

    • Get all the DocText children as a string

      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

    • Returns string

    • Parameters

      • it: string

      Returns void

    • 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 this element and its children to the specified DocWriter.

      Parameters

      Returns void

    • Write this element's children to the specified DocWriter.

      Parameters

      Returns void

    • 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

    • Parameters

      • uri: string
      • ...args: unknown[]

      Returns Link