Package com.globalmentor.model

Interface SequenceTask

All Superinterfaces:

PropertyBindable, PropertyConstrainable, Task

All Known Implementing Classes:

AbstractSequenceTask

public interface SequenceTask
extends Task

A task performed in a sequence.

Author:

Garret Wilson

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SEQUENCE_INDEX_PROPERTY	The bound, constrained property of the sequence index, of type Integer.

Fields inherited from interface com.globalmentor.model.Task

STATE_PROPERTY

Method Summary

Modifier and Type	Method	Description
int	getSequenceIndex()	Returns the index in the sequence.
void	goFinish()	Verifies the contents and finishes the sequence.
void	goFirst()	Goes to the first step in the sequence.
void	goNext()	Goes to the next step in the sequence.
void	goPrevious()	Goes to the previous step in the sequence.
void	goStart()	Starts the sequence by going to the first step in the sequence.
boolean	hasNext()	Determines if there is a next step in the sequence.
boolean	hasPrevious()	Determines if there is a previous step in the sequence.

Methods inherited from interface com.globalmentor.beans.PropertyBindable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface com.globalmentor.beans.PropertyConstrainable

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, hasVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface com.globalmentor.model.Task

getState

Field Detail

SEQUENCE_INDEX_PROPERTY

static final java.lang.String SEQUENCE_INDEX_PROPERTY

The bound, constrained property of the sequence index, of type Integer.

Method Detail

getSequenceIndex

int getSequenceIndex()

Returns the index in the sequence. This is a constrained property of type Integer.

Returns:

The index in the sequence, or -1 if the sequence has not started.

goStart

void goStart()

Starts the sequence by going to the first step in the sequence.

goFirst

void goFirst()
      throws java.beans.PropertyVetoException

Goes to the first step in the sequence.

Throws:

java.beans.PropertyVetoException - if the sequence index change has been vetoed.

hasPrevious

boolean hasPrevious()

Determines if there is a previous step in the sequence.

Returns:

true if there is a previous step before the current one.

goPrevious

void goPrevious()
         throws java.beans.PropertyVetoException

Goes to the previous step in the sequence. If there is no previous component, no action occurs.

Throws:

java.beans.PropertyVetoException - if the sequence index change has been vetoed.

See Also:

hasPrevious()

hasNext

boolean hasNext()

Determines if there is a next step in the sequence.

Returns:

true if there is a next step after the current one.

goNext

void goNext()
     throws java.beans.PropertyVetoException

Goes to the next step in the sequence. If there is no next step, no action occurs.

Throws:

java.beans.PropertyVetoException - if the sequence index change has been vetoed.

See Also:

hasNext()

goFinish

void goFinish()

Verifies the contents and finishes the sequence.