Package repast.simphony.visualization

Interface LayoutUpdater

All Known Implementing Classes:

AbstractLayoutUpdater, AddedRemovedLayoutUpdater, IntervalLayoutUpdater, MovedLayoutUpdater, UpdateLayoutUpdater

public interface LayoutUpdater

Version:

$Revision$ $Date$

Author:

Nick Collier

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	LayoutUpdater.Condition	Conditions that determine whether not the updater should update.

Method Summary

Modifier and Type	Method	Description
void	addTriggerCondition(LayoutUpdater.Condition condition)	Adds a trigger condition to the current set.
boolean	getDoSetLocationForAdded()
Layout	getLayout()	Gets the layout whose updates this updater manages.
boolean	getUpdateItemsLocation()
void	setLayout(Layout layout)	Sets the layout whose updates this updater manages.
void	update()	Update the layout.

Method Details

getLayout

Layout getLayout()

Gets the layout whose updates this updater manages.

Returns:

the layout whose updates this updater manages.

setLayout

void setLayout(Layout layout)

Sets the layout whose updates this updater manages.

Parameters:

layout -

addTriggerCondition

void addTriggerCondition(LayoutUpdater.Condition condition)

Adds a trigger condition to the current set. This layout updater will update or not in response to whatever its current condition is.

Parameters:

condition -

getUpdateItemsLocation

boolean getUpdateItemsLocation()

Returns:

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

getDoSetLocationForAdded

boolean getDoSetLocationForAdded()

Returns:

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

update

void update()

Update the layout. The layout will be updated or not depedending on the current trigger condition.