Trait/Object

org.querki.gadgets.core

Gadget

Related Docs: object Gadget | package core

Permalink

trait Gadget[Output <: Element] extends ManagedFrag[Output]

Wrapper around Scalatags, to provide support for tracking and updating the rendered elements as the underlying data changes.

If you need complex behaviour, subclass this and extend it. If you just need to be able to access the DOM created by the rendered Scalatags, just use the Gadget(scalatags) entry point.

Linear Supertypes
ManagedFrag[Output], Frag, Frag[Element, Node], Modifier[Element], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Gadget
  2. ManagedFrag
  3. Frag
  4. Frag
  5. Modifier
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def doRender(): ManagedFrag[Output]

    Permalink

    Concrete subclasses should fill this in with the actual guts of the Gadget.

    Concrete subclasses should fill this in with the actual guts of the Gadget.

    Note that this can be filled with a conventional Scalatags TypedTag thanks to an implicit conversion in globals.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def applyTo(parent: Element): Unit

    Permalink

    We intercept applyTo() (which is part of Scalatags), to record the parent of this Node.

    We intercept applyTo() (which is part of Scalatags), to record the parent of this Node.

    Definition Classes
    ManagedFrag → Frag → Modifier
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def createFrag: Output

    Permalink

    Concrete classes must define this.

    Concrete classes must define this. It causes the actual DOM node to come into existence.

    Definition Classes
    GadgetManagedFrag
  8. def elem: Output

    Permalink

    Fetches the actual rendered DOM Node for this Frag.

    Fetches the actual rendered DOM Node for this Frag.

    IMPORTANT: this is convenient, but fundamentally unsafe! Only use it in places where you are *certain* that the Node has already been rendered; otherwise, use the safer elemOpt or elemOptRx!

    Definition Classes
    ManagedFrag
  9. def elemOpt: Option[Output]

    Permalink
    Definition Classes
    ManagedFrag
  10. val elemOptRx: Var[Option[Output]]

    Permalink

    An Rx member containing the actual Node iff it has been rendered.

    An Rx member containing the actual Node iff it has been rendered.

    Definition Classes
    ManagedFrag
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. def mapElementOrElse[R](default: R, f: (Element) ⇒ R): R

    Permalink

    Convenience function for operating on the Element, if this Gadget has been rendered.

    Convenience function for operating on the Element, if this Gadget has been rendered.

    Yes, this deliberately squashes Output to Element for purposes of the function call. That is typically good enough, and is kinder to the sQuery type inference.

    TBD: this suggests that sQuery should be smarter about Element subclasses.

  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. def onCreate(elem: Output): Unit

    Permalink

    Concrete Gadgets can override this to perform actions after we've created the actual Element.

  22. def onInserted(): Unit

    Permalink

    This is called immediately after this fragment is inserted into its parent, so that you can provide additional stuff that happens then.

    This is called immediately after this fragment is inserted into its parent, so that you can provide additional stuff that happens then.

    Definition Classes
    ManagedFrag
  23. def onRendered(e: Output): Unit

    Permalink

    Subclasses can override this to define behaviour that happens in the middle of the render function.

    Subclasses can override this to define behaviour that happens in the middle of the render function. Generally used by infrastructure, not concrete classes.

    Definition Classes
    GadgetManagedFrag
  24. def parentOpt: Option[Element]

    Permalink
    Definition Classes
    ManagedFrag
  25. val parentOptRx: Var[Option[Element]]

    Permalink

    The parent of the resulting Node, once it has been created.

    The parent of the resulting Node, once it has been created.

    Definition Classes
    ManagedFrag
  26. def render: Output

    Permalink

    We intercept render (which is part of Scalatags), to record the Node when it gets created, and to provide access to the creation event.

    We intercept render (which is part of Scalatags), to record the Node when it gets created, and to provide access to the creation event.

    IMPORTANT: this imperatively renders the Gadget; if you call it repeatedly, it will render again! Use rendered by preference most of the time.

    Definition Classes
    ManagedFrag → Frag → Frag
  27. def rendered: Output

    Permalink

    Lazy version of render().

    Lazy version of render(). This returns the rendered content of the Gadget, rendering if need be. This allows you to easily fetch the elem repeatedly, without worrying about re-rendering.

    Definition Classes
    ManagedFrag
  28. def setElem(e: Output): Gadget.this.type

    Permalink

    Slam the element for this Gadget.

    Slam the element for this Gadget. You should only call this iff the element was created from an external mechanism and you're building this Gadget around that element.

    This is intentionally designed for chaining, for ease of use -- it returns this Gadget.

    Definition Classes
    ManagedFrag
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  31. def underlyingTag: ManagedFrag[Output]

    Permalink
  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ManagedFrag[Output]

Inherited from Frag

Inherited from Frag[Element, Node]

Inherited from Modifier[Element]

Inherited from AnyRef

Inherited from Any

Ungrouped