Object/Trait

io.udash.bindings

Bindings

Related Docs: trait Bindings | package bindings

Permalink

object Bindings extends Bindings

Linear Supertypes
Bindings, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bindings
  2. Bindings
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final class AttrOps extends AnyVal

    Permalink
  2. final class AttrPairOps extends AnyVal

    Permalink
  3. final class PropertyOps[T] extends AnyVal

    Permalink

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. val CheckButtons: inputs.CheckButtons.type

    Permalink
    Definition Classes
    Bindings
  5. val Checkbox: inputs.Checkbox.type

    Permalink
    Definition Classes
    Bindings
  6. val FileInput: inputs.FileInput.type

    Permalink
    Definition Classes
    Bindings
  7. val NumberInput: inputs.NumberInput.type

    Permalink
    Definition Classes
    Bindings
  8. val PasswordInput: inputs.PasswordInput.type

    Permalink
    Definition Classes
    Bindings
  9. val RadioButtons: inputs.RadioButtons.type

    Permalink
    Definition Classes
    Bindings
  10. val Select: inputs.Select.type

    Permalink
    Definition Classes
    Bindings
  11. val TextArea: inputs.TextArea.type

    Permalink
    Definition Classes
    Bindings
  12. val TextInput: inputs.TextInput.type

    Permalink
    Definition Classes
    Bindings
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. def available(e: Node): Boolean

    Permalink
    Annotations
    @inline()
  15. def bind[T](property: properties.single.ReadableProperty[T]): Binding

    Permalink

    Use it to bind value of property into DOM structure.

    Use it to bind value of property into DOM structure. Value of the property will be rendered as text node. (Using .toString method.) If property value is null, empty text node will be added.

    property

    Property to bind.

    returns

    Modifier for bound property.

    Definition Classes
    Bindings
  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def emptyStringNode(): Node

    Permalink

    Creates empty text node, which is useful as placeholder.

    Creates empty text node, which is useful as placeholder.

    Definition Classes
    Bindings
  18. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  27. def produce[T](property: properties.seq.ReadableSeqProperty[T, _ <: properties.single.ReadableProperty[T]], customElementsReplace: ReplaceMethod)(builder: (Seq[T]) ⇒ Seq[Node]): Binding

    Permalink

    Use it to bind sequence property into DOM structure, given builder will be used to generate DOM element on every value change.

    Use it to bind sequence property into DOM structure, given builder will be used to generate DOM element on every value change. Notice that on every property change, whole element representing property will be rendered again.

    property

    Property to bind.

    customElementsReplace

    Takes root element, old children and new children. It should return true, if it did not replace elements in DOM. Is such a case the default implementation will replace the elements. Otherwise you have to replace elements in DOM manually.

    builder

    Element builder which will be used to create HTML element. Seq passed to the builder can not be null.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
  28. def produce[T](property: properties.seq.ReadableSeqProperty[T, _ <: properties.single.ReadableProperty[T]])(builder: (Seq[T]) ⇒ Seq[Node]): Binding

    Permalink

    Use it to bind sequence property into DOM structure, given builder will be used to generate DOM element on every value change.

    Use it to bind sequence property into DOM structure, given builder will be used to generate DOM element on every value change. Notice that on every property change, whole element representing property will be rendered again.

    property

    Property to bind.

    builder

    Element builder which will be used to create HTML element. Seq passed to the builder can not be null.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
  29. def produce[T](property: properties.single.ReadableProperty[T], checkNull: Boolean = true)(builder: (T) ⇒ Seq[Node]): Binding

    Permalink

    Use it to bind property into DOM structure, given builder will be used to generate DOM element on every value change.

    Use it to bind property into DOM structure, given builder will be used to generate DOM element on every value change. If property value is null, empty text node will be added as placeholder.

    property

    Property to bind.

    checkNull

    If it is true, then null value of property will result in rendering empty text node. If it is false, then null value has to be handled by builder.

    builder

    Element builder which will be used to create HTML element.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
  30. def produceWithNested[T](property: properties.seq.ReadableSeqProperty[T, _ <: properties.single.ReadableProperty[T]], customElementsReplace: ReplaceMethod)(builder: (Seq[T], (Binding) ⇒ Binding) ⇒ Seq[Node]): Binding

    Permalink

    Use it to bind sequence property into DOM structure, given builder will be used to generate DOM element on every value change.

    Use it to bind sequence property into DOM structure, given builder will be used to generate DOM element on every value change. Notice that on every property change, whole element representing property will be rendered again.

    The builder takes nested bindings interceptor - it should be used if you want to create another binding inside this builder. This prevents memory leaks by killing nested bindings on property change.

    property

    Property to bind.

    customElementsReplace

    Takes root element, old children and new children. It should return true, if it did not replace elements in DOM. Is such a case the default implementation will replace the elements. Otherwise you have to replace elements in DOM manually.

    builder

    Element builder which will be used to create HTML element. Seq passed to the builder can not be null.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
  31. def produceWithNested[T](property: properties.seq.ReadableSeqProperty[T, _ <: properties.single.ReadableProperty[T]])(builder: (Seq[T], (Binding) ⇒ Binding) ⇒ Seq[Node]): Binding

    Permalink

    Use it to bind sequence property into DOM structure, given builder will be used to generate DOM element on every value change.

    Use it to bind sequence property into DOM structure, given builder will be used to generate DOM element on every value change. Notice that on every property change, whole element representing property will be rendered again.

    The builder takes nested bindings interceptor - it should be used if you want to create another binding inside this builder. This prevents memory leaks by killing nested bindings on property change.

    property

    Property to bind.

    builder

    Element builder which will be used to create HTML element. Seq passed to the builder can not be null.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
  32. def produceWithNested[T](property: properties.single.ReadableProperty[T], customElementsReplace: ReplaceMethod, checkNull: Boolean)(builder: (T, (Binding) ⇒ Binding) ⇒ Seq[Node]): Binding

    Permalink

    Use it to bind property into DOM structure, given builder will be used to generate DOM element on every value change.

    Use it to bind property into DOM structure, given builder will be used to generate DOM element on every value change. If property value is null, empty text node will be added as placeholder.

    The builder takes nested bindings interceptor - it should be used if you want to create another binding inside this builder. This prevents memory leaks by killing nested bindings on property change.

    For example:

      produceWithNested(property) { case (data, nested) =>
        div(data,
          nested(produce(anotherProperty) { innerData => span(innerData).render })
        ).render
      }
    

    property

    Property to bind.

    customElementsReplace

    Takes root element, old children and new children. It should return true, if it did not replace elements in DOM. Is such a case the default implementation will replace the elements. Otherwise you have to replace elements in DOM manually.

    checkNull

    If it is true, then null value of property will result in rendering empty text node. If it is false, then null value has to be handled by builder.

    builder

    Element builder which will be used to create HTML element.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
  33. def produceWithNested[T](property: properties.single.ReadableProperty[T], checkNull: Boolean = true)(builder: (T, (Binding) ⇒ Binding) ⇒ Seq[Node]): Binding

    Permalink

    Use it to bind property into DOM structure, given builder will be used to generate DOM element on every value change.

    Use it to bind property into DOM structure, given builder will be used to generate DOM element on every value change. If property value is null, empty text node will be added as placeholder.

    The builder takes nested bindings interceptor - it should be used if you want to create another binding inside this builder. This prevents memory leaks by killing nested bindings on property change.

    For example:

      produceWithNested(property) { case (data, nested) =>
        div(data,
          nested(produce(anotherProperty) { innerData => span(innerData).render })
        ).render
      }
    

    property

    Property to bind.

    checkNull

    If it is true, then null value of property will result in rendering empty text node. If it is false, then null value has to be handled by builder.

    builder

    Element builder which will be used to create HTML element.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
  34. def queuedNode(component: ⇒ Seq[Node], timeout: Int = 0): Modifier[Element]

    Permalink

    Renders component with provided timeout.

    Renders component with provided timeout. It's useful to render heavy components after displaying the main view.

    Definition Classes
    Bindings
  35. def repeat[T, E <: properties.single.ReadableProperty[T]](property: properties.seq.ReadableSeqProperty[T, E], customElementsReplace: ReplaceMethod = ..., customElementsInsert: InsertMethod = DOMManipulator.DefaultElementInsert)(builder: (E) ⇒ Seq[Node]): Binding

    Permalink

    Use it to bind sequence property into DOM structure.

    Use it to bind sequence property into DOM structure. This method cares about adding new elements which appears in sequence and also removes those which were removed. You only need to provide builder which is used to create HTML element for each sequence member.
    Note: This will handle only structure changes, if you want to handle concrete subproperties changes, you should use another binding method inside builder.

    property

    Property to bind.

    customElementsReplace

    Takes root element, old children and new children. It should return true, if it did not replace elements in DOM. Is such a case the default implementation will replace the elements. Otherwise you have to replace elements in DOM manually.

    customElementsInsert

    Takes root element, ref node and new children. It should return true, if it does not insert elements in DOM. Is such a case the default implementation will insert the elements. Otherwise you have to insert elements in DOM manually.

    builder

    Builder which is used for every element.

    returns

    Modifier for repeat logic.

    Definition Classes
    Bindings
  36. def repeatWithIndex[T, E <: properties.single.ReadableProperty[T]](property: properties.seq.ReadableSeqProperty[T, E], customElementsReplace: ReplaceMethod = ..., customElementsInsert: InsertMethod = DOMManipulator.DefaultElementInsert)(builder: (E, properties.single.ReadableProperty[Int], (Binding) ⇒ Binding) ⇒ Seq[Node]): Binding

    Permalink

    Use it to bind sequence property into DOM structure.

    Use it to bind sequence property into DOM structure. This method cares about adding new elements which appears in sequence and also removes those which were removed. You only need to provide builder which is used to create HTML element for each sequence member. This modifier provides also property with element index in sequence.
    Note: This will handle only structure changes, if you want to handle concrete subproperties changes, you should use another binding method inside builder.

    The builder takes nested bindings interceptor - it should be used if you want to create another binding inside this builder. This prevents memory leaks by killing nested bindings on property change.

    property

    Property to bind.

    customElementsReplace

    Takes root element, old children and new children. It should return true, if it did not replace elements in DOM. Is such a case the default implementation will replace the elements. Otherwise you have to replace elements in DOM manually.

    customElementsInsert

    Takes root element, ref node and new children. It should return true, if it does not insert elements in DOM. Is such a case the default implementation will insert the elements. Otherwise you have to insert elements in DOM manually.

    builder

    Builder which is used for every element.

    returns

    Modifier for repeat logic.

    Definition Classes
    Bindings
  37. def repeatWithNested[T, E <: properties.single.ReadableProperty[T]](property: properties.seq.ReadableSeqProperty[T, E], customElementsReplace: ReplaceMethod = ..., customElementsInsert: InsertMethod = DOMManipulator.DefaultElementInsert)(builder: (E, (Binding) ⇒ Binding) ⇒ Seq[Node]): Binding

    Permalink

    Use it to bind sequence property into DOM structure.

    Use it to bind sequence property into DOM structure. This method cares about adding new elements which appears in sequence and also removes those which were removed. You only need to provide builder which is used to create HTML element for each sequence member.
    Note: This will handle only structure changes, if you want to handle concrete subproperties changes, you should use another binding method inside builder.

    The builder takes nested bindings interceptor - it should be used if you want to create another binding inside this builder. This prevents memory leaks by killing nested bindings on property change.

    property

    Property to bind.

    customElementsReplace

    Takes root element, old children and new children. It should return true, if it did not replace elements in DOM. Is such a case the default implementation will replace the elements. Otherwise you have to replace elements in DOM manually.

    customElementsInsert

    Takes root element, ref node and new children. It should return true, if it does not insert elements in DOM. Is such a case the default implementation will insert the elements. Otherwise you have to insert elements in DOM manually.

    builder

    Builder which is used for every element.

    returns

    Modifier for repeat logic.

    Definition Classes
    Bindings
  38. implicit def seqFromElement(el: Element): Seq[Element]

    Permalink
    Definition Classes
    Bindings
  39. implicit def seqFromNode(el: Node): Seq[Node]

    Permalink
    Definition Classes
    Bindings
  40. implicit def seqNodeFromOpt[T](el: Opt[T])(implicit ev: (T) ⇒ Modifier[Element]): Modifier[Element]

    Permalink
    Definition Classes
    Bindings
  41. def showIf(property: properties.single.ReadableProperty[Boolean], customElementsReplace: ReplaceMethod)(elements: Seq[Node]): Binding

    Permalink

    Shows provided DOM elements only if property value is true.

    Shows provided DOM elements only if property value is true.

    property

    Property to check.

    customElementsReplace

    Takes root element, old children and new children. It should return true, if it did not replace elements in DOM. Is such a case the default implementation will replace the elements. Otherwise you have to replace elements in DOM manually.

    elements

    Elements to show if property value is true.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
  42. def showIf(property: properties.single.ReadableProperty[Boolean])(elements: Seq[Node]): Binding

    Permalink

    Shows provided DOM elements only if property value is true.

    Shows provided DOM elements only if property value is true.

    property

    Property to check.

    elements

    Elements to show if property value is true.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
  43. def showIfElse(property: properties.single.ReadableProperty[Boolean], customElementsReplace: ReplaceMethod)(elements: Seq[Node], elseElements: Seq[Node]): Binding

    Permalink

    Switches provided DOM elements depending on property value.

    Switches provided DOM elements depending on property value.

    property

    Property to check.

    customElementsReplace

    Takes root element, old children and new children. It should return true, if it did not replace elements in DOM. Is such a case the default implementation will replace the elements. Otherwise you have to replace elements in DOM manually.

    elements

    Elements to show if property value is true.

    elseElements

    Elements to show if property value is false.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
  44. def showIfElse(property: properties.single.ReadableProperty[Boolean])(elements: Seq[Node], elseElements: Seq[Node]): Binding

    Permalink

    Switches provided DOM elements depending on property value.

    Switches provided DOM elements depending on property value.

    property

    Property to check.

    elements

    Elements to show if property value is true.

    elseElements

    Elements to show if property value is false.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
  45. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  46. implicit def toAttrOps(attr: Attr): AttrOps

    Permalink
    Definition Classes
    Bindings
  47. implicit def toAttrPairOps(attr: AttrPair[Element, _]): AttrPairOps

    Permalink
    Definition Classes
    Bindings
  48. implicit def toPropertyOps[T](property: properties.single.ReadableProperty[T]): PropertyOps[T]

    Permalink
    Definition Classes
    Bindings
  49. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  50. def valid[A](property: properties.single.ReadableProperty[A])(completeBuilder: (properties.ValidationResult) ⇒ Seq[Node], progressBuilder: (Future[properties.ValidationResult]) ⇒ Seq[Node] = null, errorBuilder: (Throwable) ⇒ Seq[Node] = null): Binding

    Permalink

    Use in order to add validation logic over property.

    Use in order to add validation logic over property. As this modifier listens on property validation results, user is able to customize what HTML elements should be shown.

    property

    Property to bind.

    completeBuilder

    Builder which is called when validation process is completed. It will give an access to validation results.

    progressBuilder

    Builder which is called when validation process is started. It will also give you an access to future of validation results.

    errorBuilder

    Builder which is called, when validation process fails.

    returns

    Modifier for validation logic.

    Definition Classes
    Bindings
  51. def validWithNested[A](property: properties.single.ReadableProperty[A])(completeBuilder: (properties.ValidationResult, (Binding) ⇒ Binding) ⇒ Seq[Node], progressBuilder: (Future[properties.ValidationResult], (Binding) ⇒ Binding) ⇒ Seq[Node] = null, errorBuilder: (Throwable, (Binding) ⇒ Binding) ⇒ Seq[Node] = null, customElementsReplace: ReplaceMethod = ...): Binding

    Permalink

    Use in order to add validation logic over property.

    Use in order to add validation logic over property. As this modifier listens on property validation results, user is able to customize what HTML elements should be shown.

    The builders take nested bindings interceptor - it should be used if you want to create another binding inside this builder. This prevents memory leaks by killing nested bindings on property change.

    property

    Property to bind.

    completeBuilder

    Builder which is called when validation process is completed. It will give an access to validation results.

    progressBuilder

    Builder which is called when validation process is started. It will also give you an access to future of validation results.

    errorBuilder

    Builder which is called, when validation process fails.

    customElementsReplace

    Takes root element, old children and new children. It should return true, if it did not replace elements in DOM. Is such a case the default implementation will replace the elements. Otherwise you have to replace elements in DOM manually.

    returns

    Modifier for validation logic.

    Definition Classes
    Bindings
  52. final def wait(): Unit

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

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

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

Deprecated Value Members

  1. def bindAttribute[T](property: properties.single.ReadableProperty[T])(updater: (T, Element) ⇒ Any): Binding

    Permalink

    Use it to update DOM elements, on every property change.

    Use it to update DOM elements, on every property change.

    property

    Property to listen.

    updater

    Element attribute updater.

    returns

    Modifier for bounded property.

    Definition Classes
    Bindings
    Annotations
    @deprecated
    Deprecated

    (Since version 0.4.0) Use Attr.bind, AttrPair.attrIf or Property.reactiveApply instead.

  2. def bindValidation[A](property: properties.single.ReadableProperty[A], initBuilder: (Future[properties.ValidationResult]) ⇒ Seq[Element], completeBuilder: (properties.ValidationResult) ⇒ Seq[Element], errorBuilder: (Throwable) ⇒ Seq[Element]): Binding

    Permalink

    Use in order to add validation logic over property.

    Use in order to add validation logic over property. As this modifier listens on property validation results, user is able to customize what HTML elements should be shown.

    property

    Property to bind.

    initBuilder

    Builder which is called when validation process is started. It will also give you an access to future of validation results.

    completeBuilder

    Builder which is called when validation process is completed. It will give an access to validation results.

    errorBuilder

    Builder which is called, when validation process fails.

    returns

    Modifier for validation logic.

    Definition Classes
    Bindings
    Annotations
    @deprecated
    Deprecated

    (Since version 0.4.0) Use valid instead.

Inherited from Bindings

Inherited from AnyRef

Inherited from Any

Ungrouped