JSOptionBuilder

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

AnyRef, Any

Instance Constructors

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

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.

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
def _result: T

Extract the built-up options, in a form suitable for passing into a typical facade.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
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.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
JSOptionBuilder → AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object JSOptionBuilder | package jsext

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

Instance Constructors

new JSOptionBuilder(copy: (OptMap) ⇒ B)

Abstract Value Members

abstract def dict: OptMap

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def _result: T

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def jsOpt(name: String, opt: Any): B

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped