\FrontEndEditorPreviousAndNextProvider
this class manages the previous and next step it provides functions that are independent from the sequencer being used so that it can run any type of sequence.
Synopsis
class FrontEndEditorPreviousAndNextProvider
extends Object
{
- // members
- private static FrontEndEditorPreviousAndNextProvider $_me_cached = NULL;
- protected string $sequencerClassName = '';
- private static $_my_sequencer = NULL;
- // methods
- public static FrontEndEditorPreviousAndNextProvider inst()
- public ArrayList ListOfSequences()
- public void ArrayOfClassesToSequence()
- public FrontEndEditorPreviousAndNextProvider setSequenceProvider()
- public FrontEndEditorPreviousAndNextProvider setCurrentRecordBeingEdited()
- public FrontEndEditable|null getCurrentRecordBeingEdited()
- public bool InSequence()
- public bool NotInSequence()
- public bool HasSequencer()
- public bool HasCurrentRecordBeingEdited()
- public FrontEndEditorPreviousAndNextSequencer getSequencer()
- protected string getClassName()
- public FrontEndEditorPreviousAndNextProvider StartSequence()
- public FrontEndEditorPreviousAndNextProvider setPage()
- public string Link()
- public string getPageLink()
- public int CurrentRecordPositionInSequence()
- public int TotalNumberOfPages()
- public ArrayList AllPages()
- public FrontEndEditable|null AddAnotherOfThisClass()
- public bool HasNextPage()
- public string NextPageLink()
- public FrontEndEditable|null NextPageObject()
- public string goNextPage()
- public string goAddAnother()
- public bool HasPreviousPage()
- public string PreviousLink()
- public FrontEndEditable|null PreviousPageObject()
- public bool canGoPreviousOrNextPage()
- public bool canGoPreviousPage()
- public bool canGoNextPage()
- public string goPreviousPage()
- protected FrontEndEditable|null CanAddAnotherOfThisClass()
- protected FrontEndEditable|null getPageItem()
- protected int getPageNumber()
- protected void FrontEndUID()
- public mixed runOnSequencer()
- public void debug()
Hierarchy
Extends
- Object
Members
private
- $_me_cached
—
FrontEndEditorPreviousAndNextProvider
cached variable for a singleton pattern - $_my_sequencer
protected
- $sequencerClassName — string
Methods
protected
public
- AddAnotherOfThisClass()
- AllPages()
- ArrayOfClassesToSequence()
- CurrentRecordPositionInSequence() — returns 1 - [ number of pages in sequence]
- HasCurrentRecordBeingEdited()
- HasNextPage() — is there another page to work through?
- HasPreviousPage() — is there a previous page to work through?
- HasSequencer() — a sequencer has been set ...
- InSequence()
- Link()
- ListOfSequences() — returns a list of sequences available to the current member
- NextPageLink()
- NextPageObject()
- NotInSequence()
- PreviousLink()
- PreviousPageObject()
- StartSequence() — to kick start a new sequence this method must set the first record being edited.
- TotalNumberOfPages()
- canGoNextPage()
- canGoPreviousOrNextPage()
- canGoPreviousPage()
- debug()
- getCurrentRecordBeingEdited()
- getPageLink()
- getSequencer()
- goAddAnother()
- goNextPage()
- goPreviousPage()
- inst() — returns a singleton
- runOnSequencer() — run a method in the sequencer ..
- setCurrentRecordBeingEdited()
- setPage() — force to go to a new page you either pass the new record or the relative position of the new page (e.g. -1 / 1, 2)
- setSequenceProvider()