| com.jgoodies.binding.value.AbstractValueModel
 com.jgoodies.binding.extras.DelayedWriteValueModel
| DelayedWriteValueModel | | final public class DelayedWriteValueModel extends AbstractValueModel (Code) | | A ValueModel that deferres write-access for a specified delay.
Useful to coalesce frequent changes. For example if a heavy computation
shall be performed only for a "stable" selection after a series of
quick selection changes.
Wraps a given subject ValueModel and returns the subject value or
the value to be set as this model's value. Observes subject value changes
and forwards them to listeners of this model. If a value is set to this
model, a Swing Timer is used to delay the value commit to the subject.
A previously started timer - if any - will be stopped before.
TODO: Describe how and when listeners get notified about the delayed change.
TODO: Write about the recommended delay time - above the double-click time
and somewhere below a second, e.g. 100ms to 200ms.
TODO: Write about a slightly different commit handling. The current
implementation defers the commit until the value is stable for the
specified delay; it's a DelayUntilStableForXXXmsValueModel. Another
feature is to delay for a specified time but ensure that some commits
and change notifications happen. The latter is a CoalescingWriteValueModel.
TODO: Summarize the differences between the DelayedReadValueModel, the
DelayedWriteValueModel, and this DelayedPropertyChangeHandler.
author:
Karsten Lentzsch
version:
$Revision: 1.11 $
See Also: DelayedReadValueModel
See Also: DelayedPropertyChangeHandler
See Also: javax.swing.Timer |
| Constructor Summary | |
| public | DelayedWriteValueModel(ValueModel subject, int delay)
Constructs a DelayedWriteValueModel for the given subject ValueModel
and the specified Timer delay in milliseconds with coalescing disabled. | | public | DelayedWriteValueModel(ValueModel subject, int delay, boolean coalesce)
Constructs a DelayedWriteValueModel for the given subject ValueModel
and the specified Timer delay in milliseconds with coalescing disabled. |
| Method Summary | |
| public int | getDelay()
Returns the delay, in milliseconds, that is used to defer value commits. | | public Object | getValue()
Returns the subject's value or in case of a pending commit,
the pending new value. | | public boolean | isCoalesce()
Returns if this model coalesces all pending changes or not. | | public void | setCoalesce(boolean b)
Sets if this model shall coalesce all pending changes or not. | | public void | setDelay(int delay)
Sets the delay, in milliseconds, that is used to defer value commits. | | public void | setValue(Object newValue)
Sets the given new value after this model's delay. | | public void | stop()
Stops a running timer - if any. |
| DelayedWriteValueModel | | public DelayedWriteValueModel(ValueModel subject, int delay)(Code) | | Constructs a DelayedWriteValueModel for the given subject ValueModel
and the specified Timer delay in milliseconds with coalescing disabled.
Parameters:
subject - the underlying (or wrapped) ValueModel
Parameters:
delay - the milliseconds to wait before a changeshall be committed
throws:
IllegalArgumentException - if the delay is negative |
| DelayedWriteValueModel | | public DelayedWriteValueModel(ValueModel subject, int delay, boolean coalesce)(Code) | | Constructs a DelayedWriteValueModel for the given subject ValueModel
and the specified Timer delay in milliseconds with coalescing disabled.
Parameters:
subject - the underlying (or wrapped) ValueModel
Parameters:
delay - the milliseconds to wait before a changeshall be committed
Parameters:
coalesce - true to coalesce all pending changes,false to fire changes with the delay when an updatehas been received
throws:
IllegalArgumentException - if the delay is negative
See Also: DelayedWriteValueModel.setCoalesce(boolean) |
| getDelay | | public int getDelay()(Code) | | Returns the delay, in milliseconds, that is used to defer value commits.
the delay, in milliseconds, that is used to defer value commits
See Also: DelayedWriteValueModel.setDelay |
| getValue | | public Object getValue()(Code) | | Returns the subject's value or in case of a pending commit,
the pending new value.
the subject's current or future value. |
| isCoalesce | | public boolean isCoalesce()(Code) | | Returns if this model coalesces all pending changes or not.
true if all pending changes will be coalesced,false if pending changes are fired with a delaywhen an update has been received.
See Also: DelayedWriteValueModel.setCoalesce(boolean) |
| setCoalesce | | public void setCoalesce(boolean b)(Code) | | Sets if this model shall coalesce all pending changes or not.
In this case, a change event will be fired first,
if no updates have been received for this model's delay.
If coalesce is false, a change event will be fired
with this model's delay when an update has been received.
The default value is false.
Note that this value is not the #coalesce value
of this model's internal Swing timer.
Parameters:
b - true to coalesce,false to fire separate changes |
| setDelay | | public void setDelay(int delay)(Code) | | Sets the delay, in milliseconds, that is used to defer value commits.
Parameters:
delay - the delay, in milliseconds, that is used to defer value commits
See Also: DelayedWriteValueModel.getDelay |
| setValue | | public void setValue(Object newValue)(Code) | | Sets the given new value after this model's delay.
Does nothing if the new value and the latest pending value are the same.
TODO: Describe how and when listeners get notified about the
delayed value change.
Parameters:
newValue - the value to set |
| stop | | public void stop()(Code) | | Stops a running timer - if any. The last pending change
won't be performed by the ValueUpdateListener.
since:
1.2 |
| Fields inherited from com.jgoodies.binding.value.AbstractValueModel | final public static String PROPERTYNAME_VALUE(Code)(Java Doc)
|
|
|