Oracle JEWT 4.2.10

oracle.bali.ewt.wizard.dWizard
Class SequenceSeries

java.lang.Object
  |
  +--oracle.bali.ewt.wizard.dWizard.SequenceSeries
All Implemented Interfaces:
WizardSequence

public class SequenceSeries
extends java.lang.Object
implements WizardSequence

The SequenceSeries class links an array of WizardSequences together into a single, seamless sequence.

SequenceSeries can contain NullSequences, but they cannot contain null WizardSequences. Instances of NullSequence will be skipped.

WizardSequences cannot be shared among multiple running wizards, but they can be shared among multiple wizards as long as no two will be running (i.e., visible) at the same time.

See Also:
DWizard, ArraySequence, NullSequence

Constructor Summary
SequenceSeries()
          Creates an empty SequenceSeries object.
SequenceSeries(WizardSequence[] series)
          Creates a SequenceSeries object.
 
Method Summary
 WizardPage getCurrentPage()
          Returns the current page of the wizard sequence.
 WizardPage getNextPage()
          Returns the page immediately after the current page, or null if there are no more pages.
 int getPageCount()
          Returns the number of pages in this sequence.
 WizardPage getPreviousPage()
          Returns the page immediately before the current page, or null if there are no more pages.
 WizardSequence[] getSeries()
          Get the array of WizardSequence objects.
 void goBackwards()
          Moves the sequence back to its previous page.
 void goForward()
          Advances the sequence to its next page.
 void goToFirstPage()
          Returns the sequence to its first page.
 void goToLastPage()
          Returns the sequence to its last page.
 void setSeries(WizardSequence[] series)
          Set the array of WizardSequence objects.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SequenceSeries

public SequenceSeries()
Creates an empty SequenceSeries object.

SequenceSeries

public SequenceSeries(WizardSequence[] series)
Creates a SequenceSeries object.
Parameters:
series - an array of sequence objects
Method Detail

setSeries

public void setSeries(WizardSequence[] series)
Set the array of WizardSequence objects. If the SequenceSeries object has already been set on a DWizard clients must call DWizard.restart() after calling this method.

getSeries

public WizardSequence[] getSeries()
Get the array of WizardSequence objects.

goToFirstPage

public void goToFirstPage()
Returns the sequence to its first page. Moves to the first page of the first sequence.
Specified by:
goToFirstPage in interface WizardSequence

goToLastPage

public void goToLastPage()
Returns the sequence to its last page. Moves to the last page of the last sequence.
Specified by:
goToLastPage in interface WizardSequence

goForward

public void goForward()
Advances the sequence to its next page.
Specified by:
goForward in interface WizardSequence
Throws:
java.util.NoSuchElementException - if there are no more pages

goBackwards

public void goBackwards()
Moves the sequence back to its previous page.
Specified by:
goBackwards in interface WizardSequence
Throws:
java.util.NoSuchElementException - if there are no more pages

getNextPage

public WizardPage getNextPage()
Returns the page immediately after the current page, or null if there are no more pages.
Specified by:
getNextPage in interface WizardSequence

getPreviousPage

public WizardPage getPreviousPage()
Returns the page immediately before the current page, or null if there are no more pages.
Specified by:
getPreviousPage in interface WizardSequence

getCurrentPage

public WizardPage getCurrentPage()
Returns the current page of the wizard sequence.
Specified by:
getCurrentPage in interface WizardSequence

getPageCount

public int getPageCount()
Returns the number of pages in this sequence.
Specified by:
getPageCount in interface WizardSequence

Oracle JEWT 4.2.10