API Docs for: 3.17.2
Show:

ValueChange Class

Defined in: event-valuechange/js/event-valuechange.js:19
Module: event-valuechange

Provides the implementation for the synthetic valuechange event. This class isn't meant to be used directly, but is public to make monkeypatching possible.

Usage:

YUI().use('event-valuechange', function (Y) {
    Y.one('#my-input').on('valuechange', function (e) {
        Y.log('previous value: ' + e.prevVal);
        Y.log('new value: ' + e.newVal);
    });
});

Item Index

Methods

Properties

Methods

_isEditable

(
  • node
)
protected static

Defined in event-valuechange/js/event-valuechange.js:306

Check to see if a node has editable content or not.

TODO: Add additional checks to get it to work for child nodes that inherit "contenteditable" from parent nodes. This may be too computationally intensive to be placed inside of the _poll loop, however.

Parameters:

_onBlur

(
  • e
  • notifier
)
protected static

Defined in event-valuechange/js/event-valuechange.js:330

Stops polling when a node's blur event fires.

Parameters:

_onFocus

(
  • e
  • notifier
)
protected static

Defined in event-valuechange/js/event-valuechange.js:343

Resets a node's history and starts polling when a focus event occurs.

Parameters:

_onKeyDown

(
  • e
  • notifier
)
protected static

Defined in event-valuechange/js/event-valuechange.js:369

Starts polling when a node receives a keyDown event.

Parameters:

_onKeyUp

(
  • e
  • notifier
)
protected static

Defined in event-valuechange/js/event-valuechange.js:382

Starts polling when an IME-related keyUp event occurs on a node.

Parameters:

_onMouseDown

(
  • e
  • notifier
)
protected static

Defined in event-valuechange/js/event-valuechange.js:402

Starts polling when a node receives a mouseDown event.

Parameters:

_onSubscribe

(
  • node
  • sub
  • notifier
  • [filter]
)
protected static

Defined in event-valuechange/js/event-valuechange.js:415

Called when the valuechange event receives a new subscriber.

Child nodes that aren't initially available when this subscription is called will still fire the valuechange event after their data is collected when the delegated focus event is captured. This includes elements that haven't been inserted into the DOM yet, as well as elements that aren't initially contenteditable.

Parameters:

_onUnsubscribe

(
  • node
  • subscription
  • notifier
)
protected static

Defined in event-valuechange/js/event-valuechange.js:494

Called when the valuechange event loses a subscriber.

Parameters:

_poll

(
  • node
  • options
)
protected static

Defined in event-valuechange/js/event-valuechange.js:71

Called at an interval to poll for changes to the value of the specified node.

Parameters:

  • node Node

    Node to poll.

  • options Object

    Options object.

    • [e] EventFacade optional

      Event facade of the event that initiated the polling.

_refreshTimeout

(
  • node
  • notifier
)
protected static

Defined in event-valuechange/js/event-valuechange.js:160

Restarts the inactivity timeout for the specified node.

Parameters:

_startPolling

(
  • node
  • notifier
  • options
)
protected static

Defined in event-valuechange/js/event-valuechange.js:191

Begins polling for changes to the value property of the specified node. If polling is already underway for the specified node, it will not be restarted unless the force option is true

Parameters:

  • node Node

    Node to watch.

  • notifier SyntheticEvent.Notifier
  • options Object

    Options object.

    • [e] EventFacade optional

      Event facade of the event that initiated the polling.

    • [force=false] Boolean optional

      If true, polling will be restarted even if we're already polling this node.

_stopPolling

(
  • node
  • [notifier]
)
protected static

Defined in event-valuechange/js/event-valuechange.js:257

Stops polling for changes to the specified node's value attribute.

Parameters:

  • node Node

    Node to stop polling on.

  • [notifier] SyntheticEvent.Notifier optional

    Notifier to remove from the node. If not specified, all notifiers will be removed.

_stopTimeout

(
  • node
)
protected static

Defined in event-valuechange/js/event-valuechange.js:291

Clears the inactivity timeout for the specified node, if any.

Parameters:

Properties

POLL_INTERVAL

Number static

Defined in event-valuechange/js/event-valuechange.js:46

Interval (in milliseconds) at which to poll for changes to the value of an element with one or more valuechange subscribers when the user is likely to be interacting with it.

Default: 50

TIMEOUT

Number static

Defined in event-valuechange/js/event-valuechange.js:58

Timeout (in milliseconds) after which to stop polling when there hasn't been any new activity (keypresses, mouse clicks, etc.) on an element.

Default: 10000