dojox/wire/TextAdapter.js

• Provides:

  • dojox.wire.TextAdapter

• Requires:

  • dojox.wire.CompositeWire in common

• dojox.wire.TextAdapter

  • type

    Function

  • chains:
    • dojox.wire.CompositeWire: (prototype)
    • dojox.wire.CompositeWire: (call)
  • parameters:
    • args: (typeof Object)

      Arguments to initialize properties
      segments:
      An array containing child Wires for text segment values

  • summary

    A composite Wire for a concatenated text

  • description

    This class has multiple child Wires for text segment values.
    Wires in 'segments' property are used to get text segments and
    values are concatenated with an optional delimiter string specified
    to 'delimiter' property.

• dojox.wire.TextAdapter._wireClass

  • type

    String

• dojox.wire.TextAdapter.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)

      Arguments to initialize properties
      segments:
      An array containing child Wires for text segment values

  • summary

    Initialize properties

  • description

    If array elements specified in 'segments' are not Wires, Wires
    are created from them as arguments, with 'parent' property set
    to this Wire instance.

• dojox.wire.TextAdapter._getValue

  • parameters:
    • object: (typeof Object||Array)
  • returns

    Object||Array|String

  • summary

    Return a concatenated text

  • description

    This method calls getValue() method of the child Wires wuth
    'object' argument and concatenate the values with 'delimiter'
    property to return.
    arg:
    A root object

  • return_summary

    A concatinated text

  • type

    Function

• dojox.wire.TextAdapter._setValue

  • parameters:
    • object: (typeof Object||Array)
    • value: (typeof String)
  • summary

    Not supported

  • type

    Function

• dojox.wire.TextAdapter._addSegment

  • parameters:
    • text: (typeof String)

      A base text

    • segment: (typeof String)

      A text segment to add

  • returns

    String

  • summary

    Return a concatenated text

  • description

    This method add a text segment specified to 'segment' argument
    to a base text specified to 'text', with 'delimiter' property.

  • return_summary

    A concatinated text

  • type

    Function

• dojox.wire.TextAdapter.delimiter

  • type

    A

  • summary

    delimiter string

• dojox.wire

  • type

    Object

• dojox

  • type

    Object