\FrontEndEditorPreviousAndNextSequencer
this class can be extended for building a custom sequence it knows about the record being edited.
You start with an array sequence (ArrayOfClassesToSequence)
You may also add in a Class+ (creates one class)
or Class++ where the user is kept asked to add more until there are enough.
Synopsis
class FrontEndEditorPreviousAndNextSequencer
extends ViewableData
{
- // members
- private static string $singular_name = 'Please override';
- private static string $plural_name = 'Please override';
- protected null|ArrayList $_allPages = NULL;
- protected $currentRecordBeingEdited = NULL;
- private static integer $_count_get_current_record = 0;
- private static array $_child_object_cache = ;
- protected static $_root_parent_cache = NULL;
- // methods
- public abstract string Title()
- public abstract void i18n_singular_name()
- public abstract void i18n_plural_name()
- public abstract array ArrayOfClassesToSequence()
- public abstract void StartSequence()
- public bool PrepareForNextPage()
- public bool prepareAddAnother()
- public abstract FrontEndEditable|null AddAnotherOfThisClass()
- public string Link()
- public bool canView()
- public string getPageLink()
- public ArrayList AllPages()
- public void CountForClassName()
- public int CurrentRecordPositionInSequence()
- public void HasPreviousPage()
- public FrontEndEditable|null PreviousPageObject()
- public void HasNextPage()
- public FrontEndEditable|null NextPageObject()
- public FrontEndEditorPreviousAndNextSequencer setCurrentRecordBeingEdited()
- public FrontEndEditable|null getCurrentRecordBeingEdited()
- public int TotalNumberOfPages()
- public bool MustAddAnotherOfThisClass()
- public bool CanAddAnotherOfThisClass()
- public ArrayList FrontEndFindChildObjects()
- protected FrontEndEditable|false FrontEndRootParentObject()
- public FrontEndEditable|int getPageItem()
- public int getPageNumber()
- protected void FrontEndUID()
- protected string createStatement()
- protected void editStatement()
Hierarchy
Extends
- ViewableData
Members
private
- $_child_object_cache
- $_count_get_current_record
- $plural_name
- $singular_name
protected
- $_allPages — null|ArrayList
- $_root_parent_cache
- $currentRecordBeingEdited
Methods
protected
public
- AddAnotherOfThisClass() — It is very like you will need to extend this method!
- AllPages() — You may want to customise this method It requires the current record being edited ...
- ArrayOfClassesToSequence() — <code> This is the key method you need to extend ...
- CanAddAnotherOfThisClass() — can we add another child for this Class?
- CountForClassName()
- CurrentRecordPositionInSequence() — first position = 1 last position = pages.count
- FrontEndFindChildObjects() — returns a datalist of objects of a particular class (e.g. Page will include HomePage) that share a particular root parent.
- HasNextPage()
- HasPreviousPage()
- Link()
- MustAddAnotherOfThisClass() — do we have to add another child for this Class?
- NextPageObject()
- PrepareForNextPage() — Get ready to edit the next one Returns true if it is all go.
- PreviousPageObject()
- StartSequence() — This method must set the first record being edited...
- Title() — e.g. Enter Rates
- TotalNumberOfPages()
- canView() — This is for the whole sequence, not just one of the steps ....
- getCurrentRecordBeingEdited()
- getPageItem()
- getPageLink() — this is the key function where you calculate the next step.
- getPageNumber()
- i18n_plural_name()
- i18n_singular_name()
- prepareAddAnother() — Returns true if it is all go.
- setCurrentRecordBeingEdited()