net.sourceforge.czt.animation.gui.history

Interface History

All Known Implementing Classes:

BasicHistory, BirthdayBookFullHistory, BirthdayBookHistory, FakeHistory, HistorySupport, ZLiveHistory

public interface History

Interface that all animation history objects derive from.

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.
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.
String	getPositionLabel() Gives a label identifying the position in the history for use in GUI display.
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.
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.

Method Detail

getInitSchema

String getInitSchema()

Getter for the name of the initialisation schema.

setInitSchema

void setInitSchema(String schemaName)

Setter for the name of the initialisation schema.

getStateSchema

String getStateSchema()

Getter for the name of the state schema.

setStateSchema

void setStateSchema(String schemaName)

Setter for the name of the state schema.

getCurrentSolutionSet

SolutionSet getCurrentSolutionSet()

Returns the current solution set.

Returns:

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

getCurrentSolution

ZBinding getCurrentSolution()

Returns the current solution in the current solution set.

Returns:

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

hasCurrentSolution

boolean hasCurrentSolution()

Returns true if there is a current solution.

Returns:

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

getInputs

Map<ZLocator,ZValue> getInputs()

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

addInput

void addInput(ZLocator variable,
              ZValue value)

Convenience function for adding values into the inputs.

Parameters:

variable - Location of variable to bind to value.

value - Value to bind variable to.

addInput

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

Convenience function for adding values into the inputs.

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

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

Convenience function for adding values into the inputs.

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

void activateSchema(String schemaName)

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

Parameters:

compositionText - describes the operation to perform.

Throws:

??? - if first call wasn't an initialisation operation.

??? - if ???

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

Function for adding property change listeners.

See Also:

PropertyChangeSupport

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

Function for removing property change listeners.

See Also:

PropertyChangeSupport

getPropertyChangeListeners

PropertyChangeListener[] getPropertyChangeListeners()

Getter function for property change listeners.

See Also:

PropertyChangeSupport

addPropertyChangeListener

void addPropertyChangeListener(String propertyName,
                               PropertyChangeListener listener)

Function for adding property change listeners.

See Also:

PropertyChangeSupport

removePropertyChangeListener

void removePropertyChangeListener(String propertyName,
                                  PropertyChangeListener listener)

Function for removing property change listeners.

See Also:

PropertyChangeSupport

getPropertyChangeListeners

PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

Getter function for property change listeners.

See Also:

PropertyChangeSupport

hasListeners

boolean hasListeners(String propertyName)

Check if a property has property change listeners.

See Also:

PropertyChangeSupport

getPositionLabel

String getPositionLabel()

Gives a label identifying the position in the history for use in GUI display.