io.guise.framework.controller.SequenceTaskController Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
/*
* Copyright © 2000-2008 GlobalMentor, Inc. null if no action should be pending confirmation.
*/
public void setConfirmingActionPrototype(final ActionPrototype newConfirmingActionPrototype) {
final ActionPrototype oldConfirmingActionPrototype = confirmingActionProtype; //get the action currently waiting for confirmation
if(oldConfirmingActionPrototype != newConfirmingActionPrototype) { //if the pending action is really changing
//TODO fix confirmTimer.stop(); //stop any confirmations currently pending
confirmingActionProtype = newConfirmingActionPrototype; //update the confirming action prototype
if(newConfirmingActionPrototype != null) { //if there is a new action waiting to be confirmed
//TODO fix confirmTimer.restart(); //start the confirmation countdown
}
//TODO fix updateStatus(); //update the status to show whether an action is waiting to be confirmed
}
}
/** Whether each navigation of the sequence must be confirmed. */
private boolean confirmNavigation = false;
/** @return true if each navigation should be confirmed. */
public boolean isConfirmNavigation() {
return confirmNavigation;
}
/**
* Sets whether each navigation must be confirmed. This is a bound property of type {@link Boolean}.
* @param newConfirmNavigation true if each navigation must be confirmed.
* @see #CONFIRM_NAVIGATION_PROPERTY
*/
public void setConfirmNavigation(final boolean newConfirmNavigation) {
final boolean oldConfirmNavigation = confirmNavigation; //get the current index
if(newConfirmNavigation != oldConfirmNavigation) { //if the confirm navigation is really changing
confirmNavigation = newConfirmNavigation; //actually change the value
firePropertyChange(CONFIRM_NAVIGATION_PROPERTY, oldConfirmNavigation, newConfirmNavigation);
}
}
/** The sequence task being controlled. */
private final SequenceTask task;
/** @return The sequence task being controlled. */
public SequenceTask getTask() {
return task;
}
/**
* Sequence task constructor. This controller listens to bound properties of the task.
* @param task The sequence task being controlled.
* @throws NullPointerException if the given task is null.
*/
public SequenceTaskController(final SequenceTask task) {
this.task = requireNonNull(task, "Task cannot be null.");
startActionPrototype = new AbstractActionPrototype(LABEL_START, GLYPH_START) {
@Override
protected void action(final int force, final int option) {
if(!isConfirmNavigation() || getConfirmingActionPrototype() == startActionPrototype) { //if this action is waiting to be confirmed
getTask().goStart(); //start the sequence
setConfirmingActionPrototype(null); //show that we're not waiting for confirmation on anything
} else { //if we should confirm this action
setConfirmingActionPrototype(startActionPrototype); //perform this action subject to confirmation
}
};
};
previousActionPrototype = new AbstractActionPrototype(LABEL_PREVIOUS, GLYPH_PREVIOUS) {
@Override
protected void action(final int force, final int option) {
if(!isConfirmNavigation() || getConfirmingActionPrototype() == previousActionPrototype) { //if this action is waiting to be confirmed
try {
getTask().goPrevious(); //go to the previous step
} catch(final PropertyVetoException propertyVetoException) {
throw new IllegalStateException(propertyVetoException);
}
setConfirmingActionPrototype(null); //show that we're not waiting for confirmation on anything
} else { //if we should confirm this action
setConfirmingActionPrototype(previousActionPrototype); //perform this action subject to confirmation
}
};
};
nextActionPrototype = new AbstractActionPrototype(LABEL_NEXT, GLYPH_NEXT) {
@Override
protected void action(final int force, final int option) {
if(!isConfirmNavigation() || getConfirmingActionPrototype() == nextActionPrototype) { //if this action is waiting to be confirmed
try {
getTask().goNext(); //go to the next step
} catch(final PropertyVetoException propertyVetoException) {
throw new IllegalStateException(propertyVetoException);
}
setConfirmingActionPrototype(null); //show that we're not waiting for confirmation on anything
} else { //if we should confirm this action
setConfirmingActionPrototype(nextActionPrototype); //perform this action subject to confirmation
}
};
};
finishActionPrototype = new AbstractActionPrototype(LABEL_FINISH, GLYPH_FINISH) {
@Override
protected void action(final int force, final int option) {
if(!isConfirmNavigation() || getConfirmingActionPrototype() == finishActionPrototype) { //if this action is waiting to be confirmed
getTask().goFinish(); //try to finish the sequence
setConfirmingActionPrototype(null); //show that we're not waiting for confirmation on anything
} else { //if we should confirm this action
setConfirmingActionPrototype(finishActionPrototype); //perform this action subject to confirmation
}
}
};
advanceActionPrototype = new ProxyActionPrototype(startActionPrototype); //the advance action prototype will initially proxy the start action prototype
confirmActionPrototype = new AbstractActionPrototype(LABEL_CONFIRM, GLYPH_CONFIRM) {
@Override
protected void action(final int force, final int option) {
final ActionPrototype confirmingActionProtype = getConfirmingActionPrototype(); //see if there is an action waiting to be confirmed
if(confirmingActionProtype != null) { //if there is an action waiting to be confirmed
//TODO fix confirmTimer.stop(); //the action is confirmed; suspend waiting for confirmation
confirmingActionProtype.performAction(); //perform the confirming action
}
}
};
/*TODO fix
confirmTimer=new Timer(CONFIRM_DELAY, new ActionListener() { //create a new action listener that will remove any confirming action after a delay
public void actionPerformed(final ActionEvent actionEvent) {setConfirmingActionPrototype(null);} //if the timer runs out, show that there is no confirmation action
});
confirmTimer.setRepeats(false); //we only have one waiting period for confirmation
*/
confirmingActionProtype = null; //there is currently no action being confirmed
task.addPropertyChangeListener(Task.STATE_PROPERTY, new AbstractGenericPropertyChangeListener() { //update the controller when the status changes
@Override
public void propertyChange(final GenericPropertyChangeEvent genericPropertyChangeEvent) {
update();
}
});
task.addPropertyChangeListener(SequenceTask.SEQUENCE_INDEX_PROPERTY, new AbstractGenericPropertyChangeListener() { //update the controller when the sequence index changing
@Override
public void propertyChange(final GenericPropertyChangeEvent genericPropertyChangeEvent) {
update();
}
});
update(); //update the controller with the initial state
}
/**
* Updates the condition of the controller based upon the state. This method is a convenience method for complex components that would like to perform
* wholesale updates any prototypes, enabled/disabled status, proxied actions, etc. This implementation updates the states of action prototypes.
*/
protected void update() {
final SequenceTask task = getTask(); //get the task
final TaskState taskState = task.getState(); //get the state of the task
getStartActionPrototype().setEnabled(taskState == TaskState.UNSTARTED); //only allow starting if we haven't started, yet
getPreviousActionPrototype().setEnabled(task.hasPrevious()); //only allow going backwards if we have a previous step
getNextActionPrototype().setEnabled(task.hasNext()); //only allow going backwards if we have a next step
getFinishActionPrototype().setEnabled(taskState == TaskState.INCOMPLETE && !task.hasNext()); //only allow finishing if the task is in progress and there is no next step
getConfirmActionPrototype().setEnabled(isConfirmNavigation() && getConfirmingActionPrototype() != null); //only allow confirmation if confirmation is enabled and there is an action waiting to be confirmed
if(taskState != TaskState.UNSTARTED) { //if we've already started
//determine if advancing should go to the next item in the sequence or finish
getAdvanceActionPrototype().setProxiedPrototype(task.hasNext() ? getNextActionPrototype() : getFinishActionPrototype());
}
final ActionPrototype confirmingActionPrototype = getConfirmingActionPrototype(); //see if there is an action waiting to be confirmed
if(confirmingActionPrototype != null) { //if there is an action waiting to be confirmed
confirmingActionPrototype.setEnabled(false); //disable the confirming action, because it will be accessed indirectly through the confirmation action
}
}
}