Package repast.simphony.visualization

Class IntervalLayoutUpdater

java.lang.Object

repast.simphony.visualization.AbstractLayoutUpdater

repast.simphony.visualization.IntervalLayoutUpdater

All Implemented Interfaces:

LayoutUpdater

public class IntervalLayoutUpdater
extends AbstractLayoutUpdater

A layout updater that will update the layout at some specified interval, or if objects have been added, removed or moved. updateItemsLocation() will return true if the layout has been updated.

Version:

$Revision: 1.1 $ $Date: 2006/01/06 22:35:19 $

Author:

Nick Collier

Nested Class Summary

Nested classes/interfaces inherited from interface repast.simphony.visualization.LayoutUpdater

LayoutUpdater.Condition

Field Summary

Fields inherited from class repast.simphony.visualization.AbstractLayoutUpdater

conditions, layout

Constructor Summary

Constructors

Constructor	Description
IntervalLayoutUpdater(Layout layout, int interval)	Creates an IntervalLayoutUpdater to manage the specified layout and update at the specified interval.

Method Summary

Modifier and Type	Method	Description
boolean	getDoSetLocationForAdded()
boolean	getUpdateItemsLocation()
void	update()	Update the layout.

Methods inherited from class repast.simphony.visualization.AbstractLayoutUpdater

addTriggerCondition, getLayout, hasCondition, setLayout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntervalLayoutUpdater

public IntervalLayoutUpdater(Layout layout,
                             int interval)

Creates an IntervalLayoutUpdater to manage the specified layout and update at the specified interval.

Parameters:

layout -

interval -

Method Detail

getDoSetLocationForAdded

public boolean getDoSetLocationForAdded()

Returns:

true if new items should get their location set when they are added to the display, otherwise false.

getUpdateItemsLocation

public boolean getUpdateItemsLocation()

Returns:

true if the visual items need to have the location updated during this update cycle, otherwise false.

update

public void update()

Update the layout. The layout will be updated if the interval has been reached or if the an added, moved, or removed condition has been triggered.