API Reference 0.3.24dart_web_toolkit_uiTakesValueEditor<T>

TakesValueEditor<T> class

Adapts the {@link TakesValue} interface to the Editor framework.

@param <T> the type of value to be edited

class TakesValueEditor<T> implements LeafValueEditor<T> {

 final TakesValue<T> _peer;

 /**
  * Returns a new ValueEditor that modifies the given {@link TakesValue} peer
  * instance.
  *
  * @param peer a {@link TakesValue} instance
  * @return a TakesValueEditor instance of the same type as its peer
  */
 factory TakesValueEditor.of(TakesValue val) {
   return new TakesValueEditor(val);
 }

 /**
  * Returns a new ValueEditor that modifies the given {@link TakesValue} peer
  * instance.
  *
  * @param peer a {@link TakesValue} instance
  */
 TakesValueEditor(this._peer);

 //*****************************
 // Implementation of TakesValue
 //*****************************

 /**
  * Returns the current value.
  *
  * @return the value as an object of type V
  * @see #setValue
  */
 T getValue() {
   return _peer.getValue();
 }

 /**
  * Sets the value.
  * Fires [ValueChangeEvent] when
  * fireEvents is true and the new value does not equal the existing value.
  *
  * @param value a value object of type V
  * @see #getValue()
  * @param fireEvents fire events if true and value is new
  */
 void setValue(T val, [bool fireEvents = false]) {
   _peer.setValue(val);
 }
}

Subclasses

ValueBoxEditor<T>

Implements

LeafValueEditor<T>

Constructors

new TakesValueEditor(TakesValue<T> _peer) #

Returns a new ValueEditor that modifies the given {@link TakesValue} peer instance.

@param peer a {@link TakesValue} instance

TakesValueEditor(this._peer);

factory TakesValueEditor.of(TakesValue val) #

Returns a new ValueEditor that modifies the given {@link TakesValue} peer instance.

@param peer a {@link TakesValue} instance @return a TakesValueEditor instance of the same type as its peer

factory TakesValueEditor.of(TakesValue val) {
 return new TakesValueEditor(val);
}

Methods

T getValue() #

Returns the current value.

@return the value as an object of type V @see #setValue

T getValue() {
 return _peer.getValue();
}

void setValue(T val, [bool fireEvents = false]) #

Sets the value. Fires ValueChangeEvent when fireEvents is true and the new value does not equal the existing value.

@param value a value object of type V @see #getValue() @param fireEvents fire events if true and value is new

void setValue(T val, [bool fireEvents = false]) {
 _peer.setValue(val);
}