dojox/wire/ml/Action.js

• Provides:

  • dojox.wire.ml.ActionFilter

• Requires:

  • dijit._Widget in common
  • dijit._Container in common
  • dojox.wire.Wire in common
  • dojox.wire.ml.util in common

• dojox.wire.ml.Action

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Container.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Container: (call)
  • summary

    A base widget to "run" a task on an event or a topic

  • description

    This widget represents a controller task to be run when an event
    (a function) or a topic is issued.
    Sub-classes must implement _run() method to implement their tasks.
    'trigger' specifies an event scope, an ID of a widget or an DOM
    element, or its property with the optional dotted notation.
    If this widget has child ActionFilter widgets, their filter()
    methods are called with the arguments to the event or the topic.
    If one of filter() methods returns false, run() won't be invoked.
    This widget also can serve as a composite task to run child
    Actions on an event or a topic specified to this widget.

• dojox.wire.ml.Action.trigger

  • type

    An

  • summary

    event scope

• dojox.wire.ml.Action.triggerEvent

  • type

    An

  • summary

    event (function) name

• dojox.wire.ml.Action.triggerTopic

  • type

    A

  • summary

    topic name

• dojox.wire.ml.Action.postCreate

  • summary

    Call _connect()

  • description

    See _connect().

  • type

    Function

• dojox.wire.ml.Action._connect

  • summary

    Connect run() method to an event or a topic

  • description

    If 'triggerEvent' and 'trigger' are specified, connect() is
    used to set up run() to be called on the event.
    If 'triggerTopic' is specified, subscribe() is used to set up
    run() to be called on the topic.

  • type

    Function

• dojox.wire.ml.Action._triggerHandle

  • type

    Object

• dojox.wire.ml.Action._disconnect

  • summary

    Disconnect run() method from an event or a topic

  • description

    If 'triggerEvent' and 'trigger' are specified, disconnect() is
    used to set up run() not to be called on the event.
    If 'triggerTopic' is specified, unsubscribe() is used to set up
    run() not to be called on the topic.

  • type

    Function

• dojox.wire.ml.Action.run

  • summary

    Run a task

  • description

    This method calls filter() method of child ActionFilter
    widgets.
    If one of them returns false, this method returns.
    Otherwise, _run() method is called.

  • type

    Function

• dojox.wire.ml.Action._run

  • summary

    Call run() methods of child Action widgets

  • description

    If this widget has child Action widgets, their run() methods
    are called.

  • type

    Function

• dojox.wire.ml.Action.uninitialize

  • summary

    Over-ride of base widget unitialize function to do some connection cleanup.

  • type

    Function

• dojox.wire.ml.ActionFilter

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Widget: (call)
  • summary

    A widget to define a filter for the parent Action to run

  • description

    This base class checks a required property specified with
    'required' attribute.
    If 'message' is specified, the message is set to a property
    specified with 'error'.
    Subclasses may implement their own filter() method.

• dojox.wire.ml.ActionFilter.required

  • type

    A

  • summary

    property required

• dojox.wire.ml.ActionFilter.requiredValue

  • type

    Optional.

  • summary

    A specific value the property is required to have.  If this isn't provided
    than any non-false/non-null value of the required propery will cause this filter
    to pass.

• dojox.wire.ml.ActionFilter.type

  • type

    Optional.

  • summary

    A specific type to compare the values as (if requiredValue is set)
    Valid values for type are boolean, int, string.  Default is string.

• dojox.wire.ml.ActionFilter.message

  • type

    An

  • summary

    error message to emit if the filter doesn't execute due to property mismatch.

• dojox.wire.ml.ActionFilter.error

  • type

    A

  • summary

    property to store an error due to property mismatch.

• dojox.wire.ml.ActionFilter.filter

  • returns

    Boolean|boolean

  • summary

    Check if a required property is specified.  Also, if provided, check to see
    if the required property contains a specific value.

  • description

    If a value is undefined for a property, specified with
    'required', this method returns false.
    If the value for a property is defined, but there isn't a requiredValue for it
    then any non-false value will cause the method to return true.
    if requiredValue is set, then filter compares that value with the value from
    the required property and returns true if and only if they match.
    The type option just allows for a way to convert the required property values
    into a proper form for comparison (boolean, number, etc).
    If 'message' is specified, it is set to a proeprty specified
    with 'error' or shown with alert().
    If 'required' starts with "arguments", a property of
    the method arguments are checked.

  • return_summary

    True if a required property is specified (and if requiredValue is specified,
    that they match), otherwise false

  • type

    Function

• dojox.wire.ml

  • type

    Object

• dojox.wire

  • type

    Object

• dojox

  • type

    Object