Packages

abstract class JSOptionBuilder[T <: Object, B <: JSOptionBuilder[T, _]] extends JSOptionSetter[T, B]

Helper class for defining strongly-typed "options" classes to pass into Scala.js facades. This approach is particularly helpful for jQuery-based facades, which often take very complex options objects, with large numbers of polymorphic fields.

T

A placeholder facade trait -- usually just a declaration of a trait that inherits from js.Object.

B

This class. (It is probably possible to eliminate this declaration, but I haven't figured it out yet.)

Linear Supertypes
JSOptionSetter[T, B], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JSOptionBuilder
  2. JSOptionSetter
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JSOptionBuilder(copy: (OptMap) ⇒ B)

    copy

    The chaining constructor. You don't usually need to worry about this explicitly, just follow the documented patterns.

Abstract Value Members

  1. abstract def dict: OptMap

    This is a dictionary of option values.

    This is a dictionary of option values. It is usually *very* heterogeneous, mixing everything from Ints to Functions. So it needs to be js.Any.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def _result: T

    Extract the built-up options, in a form suitable for passing into a typical facade.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def jsOpt(name: String, opt: Any): B

    Define one field in an options class.

    Define one field in an options class.

    Note that jsOpt is not, in and of itself, strongly-typed. You use this helper to add a strongly-typed method for each field.

    Attributes
    protected
    Definition Classes
    JSOptionBuilder → JSOptionSetter
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    JSOptionBuilder → AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from JSOptionSetter[T, B]

Inherited from AnyRef

Inherited from Any

Ungrouped