net.sourceforge.czt.animation.gui.history

Class HistorySupport

java.lang.Object

net.sourceforge.czt.animation.gui.history.HistorySupport

All Implemented Interfaces:

History

Direct Known Subclasses:

BasicHistory, FakeHistory

public abstract class HistorySupport
extends Object
implements History

Basic History Interface that provides the traditional back/forward mechanism.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	initSchema_
protected Map<ZLocator,ZValue>	inputs_
protected PropertyChangeSupport	propertyChangeSupport Support class for property change listeners on currentSolution and currentSolutionSet.
protected String	stateSchema_

Constructor Summary

Constructors

Constructor and Description
HistorySupport() Basic constructor.
HistorySupport(String stateSchema, String initSchema) Sets the properties keeping track of state and initialisation schema names, and activates the initialisation schema.

Method Summary

Modifier and Type	Method and Description
void	activateSchema(String schemaName) Performs an operation from the current solution.
void	addInput(ZLocator variable, BeanContext beanContext, String beanName, String property) Convenience function for adding values into the inputs.
void	addInput(ZLocator variable, Object bean, String property) Convenience function for adding values into the inputs.
void	addInput(ZLocator variable, ZValue value) Convenience function for adding values into the inputs.
void	addPropertyChangeListener(PropertyChangeListener listener) Function for adding property change listeners.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Function for adding property change listeners.
ZBinding	getCurrentSolution() Returns the current solution in the current solution set.
abstract SolutionSet	getCurrentSolutionSet() Returns the current solution set.
String	getInitSchema() Getter for the name of the initialisation schema.
Map<ZLocator,ZValue>	getInputs() Getter function for the map from locators, and the object.property to bind them to.
PropertyChangeListener[]	getPropertyChangeListeners() Getter function for property change listeners.
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName) Getter function for property change listeners.
String	getStateSchema() Getter for the name of the state schema.
boolean	hasCurrentSolution() Returns true if there is a current solution.
boolean	hasListeners(String propertyName) Check if a property has property change listeners.
boolean	hasNextSolution()
boolean	hasPreviousSolution()
void	nextSolution() Moves to the next solution in the current set.
void	previousSolution() Moves to the previous solution in the current set.
void	removePropertyChangeListener(PropertyChangeListener listener) Function for removing property change listeners.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Function for removing property change listeners.
void	setInitSchema(String schemaName) Setter for the name of the initialisation schema.
void	setStateSchema(String schemaName) Setter for the name of the state schema.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.czt.animation.gui.history.History

getPositionLabel

Field Detail

initSchema_

protected String initSchema_

stateSchema_

protected String stateSchema_

inputs_

protected Map<ZLocator,ZValue> inputs_

propertyChangeSupport

protected PropertyChangeSupport propertyChangeSupport

Support class for property change listeners on currentSolution and currentSolutionSet.

Constructor Detail

HistorySupport

public HistorySupport()

Basic constructor. An initialisation schema must be set before the history can be used.

See Also:

History.activateSchema(String)

HistorySupport

public HistorySupport(String stateSchema,
                      String initSchema)

Sets the properties keeping track of state and initialisation schema names, and activates the initialisation schema.

Parameters:

stateSchema - The name of the state schema.

initSchema - The name of the initialisation schema.

See Also:

History.activateSchema(String)

Method Detail

getInitSchema

public String getInitSchema()

Description copied from interface: History

Getter for the name of the initialisation schema.

Specified by:

getInitSchema in interface History

setInitSchema

public void setInitSchema(String schemaName)

Description copied from interface: History

Setter for the name of the initialisation schema.

Specified by:

setInitSchema in interface History

getStateSchema

public String getStateSchema()

Description copied from interface: History

Getter for the name of the state schema.

Specified by:

getStateSchema in interface History

setStateSchema

public void setStateSchema(String schemaName)

Description copied from interface: History

Setter for the name of the state schema.

Specified by:

setStateSchema in interface History

getCurrentSolutionSet

public abstract SolutionSet getCurrentSolutionSet()

Description copied from interface: History

Returns the current solution set.

Specified by:

getCurrentSolutionSet in interface History

Returns:

the current solution set, or null if the initialisation schema hasn't been set up yet.

getCurrentSolution

public ZBinding getCurrentSolution()

Description copied from interface: History

Returns the current solution in the current solution set.

Specified by:

getCurrentSolution in interface History

Returns:

The current solution (or null if there's no solution).

hasCurrentSolution

public boolean hasCurrentSolution()

Description copied from interface: History

Returns true if there is a current solution.

Specified by:

hasCurrentSolution in interface History

Returns:

true if there is a current solution, false if there is no solution.

getInputs

public Map<ZLocator,ZValue> getInputs()

Getter function for the map from locators, and the object.property to bind them to.

Specified by:

getInputs in interface History

addInput

public void addInput(ZLocator variable,
                     ZValue value)

Convenience function for adding values into the inputs.

Specified by:

addInput in interface History

Parameters:

variable - Location of variable to bind to value.

value - Value to bind variable to.

addInput

public void addInput(ZLocator variable,
                     Object bean,
                     String property)

Convenience function for adding values into the inputs.

Specified by:

addInput in interface History

Parameters:

variable - Location of variable to bind to value.

bean - Java bean containing the property to set the variable to.

property - Name of property in bean to set variable to.

addInput

public void addInput(ZLocator variable,
                     BeanContext beanContext,
                     String beanName,
                     String property)

Convenience function for adding values into the inputs.

Specified by:

addInput in interface History

Parameters:

variable - Location of variable to bind to value.

beanContext - Context containing the bean to get the value from.

beanName - Name of the java bean to get the value from.

property - Name of property in bean to set variable to.

activateSchema

public void activateSchema(String schemaName)

Description copied from interface: History

Performs an operation from the current solution. First call to activateSchema must be to set the initialisation schema.

Specified by:

activateSchema in interface History

hasNextSolution

public boolean hasNextSolution()

Returns:

true if there is another solution in the current set after the current one.

nextSolution

public void nextSolution()

Moves to the next solution in the current set.

hasPreviousSolution

public boolean hasPreviousSolution()

Returns:

true if there is another solution in the current set before the current one.

previousSolution

public void previousSolution()

Moves to the previous solution in the current set.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: History

Function for adding property change listeners.

Specified by:

addPropertyChangeListener in interface History

See Also:

PropertyChangeSupport

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: History

Function for removing property change listeners.

Specified by:

removePropertyChangeListener in interface History

See Also:

PropertyChangeSupport

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

Description copied from interface: History

Getter function for property change listeners.

Specified by:

getPropertyChangeListeners in interface History

See Also:

PropertyChangeSupport

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

Description copied from interface: History

Function for adding property change listeners.

Specified by:

addPropertyChangeListener in interface History

See Also:

PropertyChangeSupport

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

Description copied from interface: History

Function for removing property change listeners.

Specified by:

removePropertyChangeListener in interface History

See Also:

PropertyChangeSupport

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

Description copied from interface: History

Getter function for property change listeners.

Specified by:

getPropertyChangeListeners in interface History

See Also:

PropertyChangeSupport

hasListeners

public boolean hasListeners(String propertyName)

Description copied from interface: History

Check if a property has property change listeners.

Specified by:

hasListeners in interface History

See Also:

PropertyChangeSupport