org.barrelorgandiscovery.gui.wizard

Interface Step

All Known Implementing Classes:

BasePanelStep, JChooseFolderStep, JMergeImagesStep, JOutputFolderChooserStep, JScanOrMergeStep, JScanParameterStep, JScanStep, JVideoInput, PanelStep, StepChooseEdges, StepChooseFilesAndInstrument, StepChooseMachine, StepChooseOrientationAndBeginning, StepMatchCenter, StepModelChooseChoice, StepPlanning, StepResume, StepViewAndEditBook, StepViewAndEditDisk

public interface Step

Wizard step, implement an action in the wizard, all implementation of step, must derive from JComponent, for the display

Method Summary

Modifier and Type	Method and Description
void	activate(java.io.Serializable state, WizardStates allStepsStates, StepStatusChangedListener stepListener) activate the step, the serializable state is the current state of the step,
java.lang.String	getDetails() get a small explaination of the step
java.lang.String	getId() get id of the step (for state persistance)
java.lang.String	getLabel() Current step label
javax.swing.Icon	getPageImage() get the step icon, if return null, the default image is used
Step	getParentStep() get the parent step
boolean	isStepCompleted() can we go to the next element, in other terms, do we have all the elements to go further
void	setParentStep(Step parent) set the parent step
java.io.Serializable	unActivateAndGetSavedState() unactivate the wizzard, and save the step state in the given state

Method Detail

getId

java.lang.String getId()

get id of the step (for state persistance)

Returns:

getParentStep

Step getParentStep()

get the parent step

Returns:

setParentStep

void setParentStep(Step parent)

set the parent step

Parameters:

parent -

getLabel

java.lang.String getLabel()

Current step label

activate

void activate(java.io.Serializable state,
              WizardStates allStepsStates,
              StepStatusChangedListener stepListener)
       throws java.lang.Exception

activate the step, the serializable state is the current state of the step,

Parameters:

state - the initial state to fill the panel

allStepsStates - get all the steps permitting to gather information about previous panels

stepListener - a listener that must be called for status changed

Throws:

java.lang.Exception

unActivateAndGetSavedState

java.io.Serializable unActivateAndGetSavedState()
                                         throws java.lang.Exception

unactivate the wizzard, and save the step state in the given state

Throws:

java.lang.Exception

isStepCompleted

boolean isStepCompleted()

can we go to the next element, in other terms, do we have all the elements to go further

Returns:

getDetails

java.lang.String getDetails()

get a small explaination of the step

Returns:

getPageImage

javax.swing.Icon getPageImage()

get the step icon, if return null, the default image is used

Returns: