AbstractPreviewModel (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.printcockpit.view.layouts.grid.AbstractPreviewModel

All Implemented Interfaces:: GridAwareModel, PreviewModel

Direct Known Subclasses:: DynamicModel, FixedModel

public abstract class AbstractPreviewModel
extends Object
implements PreviewModel, GridAwareModel

Field Summary

Fields
Modifier and Type	Field and Description
`protected GridModel[]`	`grids`
`protected List<List<Integer>>`	`gridsSlotsIDs`
`protected boolean`	`pagesStartLeft`
`protected List<PreviewPage>`	`previewPages` model of PreviewPages and UIplacements = current state of previewPages and their placements
`protected boolean`	`sameGridsSizes` indicates if all grids have the same quantity of slots - it speeds up computations
`protected int`	`totalQaOfPreviewPages` Total quantity of preview pages generated by this preview model for given page model

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractPreviewModel(TypedObject typedPage)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractPreviewModel(TypedObject typedPage)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected List<PreviewElementUpdate>`	`addEmptyPage()` Adds empty previewPage(s) to view if it's necessary e.g.
`void`	`addPreviewModelListener(PreviewModelListener listener)`
`protected GridPreviewPage`	`createNewPage(int pageIndex)`
`TypeService`	`getCockpitTypeService()`
`List<PreviewPage[]>`	`getDoublePages()`
`protected int`	`getGridsCapacity()`
`protected SpreadPosition`	`getGridType(int pageIndex)`
`SpreadPosition`	`getGridType(PlacementModel placement)`
`LayoutService`	`getLayoutService()`
`ModelHelper`	`getModelHelper()`
`ModelService`	`getModelService()`
`protected int[]`	`getNextPageAndSlotId(int pageIndex, int slotIndex)`
`protected PlacementModel`	`getNextPlacement(PreviewSlot slot, Collection<Object> placementsToSkip)`
`protected int`	`getNextPlacementIndex(PreviewSlot slot, Collection<Object> placementsToSkip)`
`protected PreviewSlot`	`getNextSlot(PreviewSlot slot, boolean createNewSlots)`
`protected int[]`	`getPageDimensions(int pageIndex)`
`PageFormatModel`	`getPageFormat()` Returns the publication page format.
`PageModel`	`getPageModel()`
`List<PreviewPage>`	`getPreviewPages()`
`PrintcockpitService`	`getPrintcockpitService()`
`PublicationService`	`getPublicationService()`
`int`	`getSlotsCapacity()`
`protected int`	`getSlotsQuantity(int pageIndex)`
`TypedObject`	`getTypedPage()`
`boolean`	`hasUnequalGrids()`
`void`	`initModel()` Initializes the model with data from Model/typedObjects layer
`protected abstract List<PreviewElementUpdate>`	`initPreviewPagesModel()` creates previewPages with order determined by positionModel implementation (fixed/dynamic/etc) and fills it with placements (again according to positionModel implementation).
`boolean`	`isFixed()`
`boolean`	`isModelInvalid(PageModel page)`
`boolean`	`isPagesStartLeft()`
`boolean`	`isPagesStartsLeft()`
`boolean`	`isShowDoublePages()`
`void`	`notifyListeners(List<PreviewElementUpdate> changes)` Sends given list of changes to every interested listener (e.g.
`void`	`removeLastEmptyPage()` Removes last empty page
`void`	`removePreviewModelListener(PreviewModelListener listener)`
`protected void`	`save(PlacementModel placement, int position)` Saves given placement in current pageModel at given position, if current pageModel contains this placement, it's moved from it's old position to new position
`void`	`setCockpitTypeService(TypeService typeService)`
`void`	`setDefaultTemplate(PageModel pageModel, ItemPlacementModel placement)` Sets default layout template (placeholder group) in given placement.
`void`	`setLayoutService(LayoutService layoutService)`
`void`	`setModelHelper(ModelHelper modelHelper)`
`void`	`setModelService(ModelService modelService)`
`protected void`	`setNotification(Notification notification)`
`void`	`setPrintcockpitService(PrintcockpitService printcockpitService)`
`void`	`setPublicationService(PublicationService publicationService)`
`void`	`setShowDoublePages(boolean show)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.hybris.platform.printcockpit.view.layouts.grid.PreviewModel
addNewEmptyPreviewPage, addPlacements, addPlacements, copyPlacements, copyPlacements, copyPreviewPages, deletePlacements, deletePreviewPages, getPreviewPagesTotalQuantity, movePlacements, movePlacements, movePreviewPages

- Field Detail
  - grids
```
protected GridModel[] grids
```
  - gridsSlotsIDs
```
protected final List<List<Integer>> gridsSlotsIDs
```
  - pagesStartLeft
```
protected boolean pagesStartLeft
```
  - sameGridsSizes
```
protected boolean sameGridsSizes
```
    indicates if all grids have the same quantity of slots - it speeds up computations
  - previewPages
```
protected final List<PreviewPage> previewPages
```
    model of PreviewPages and UIplacements = current state of previewPages and their placements
  - totalQaOfPreviewPages
```
protected int totalQaOfPreviewPages
```
    Total quantity of preview pages generated by this preview model for given page model
- Constructor Detail
  - AbstractPreviewModel
```
protected AbstractPreviewModel(TypedObject typedPage)
```
- Method Detail
  - initModel
```
public final void initModel()
```
    Description copied from interface: PreviewModel
    
    Initializes the model with data from Model/typedObjects layer
    
    Specified by:
    
    initModel in interface PreviewModel
  - getGridsCapacity
```
protected int getGridsCapacity()
```
    Returns:
    
    total capacity of current page grids
  - addEmptyPage
```
protected List<PreviewElementUpdate> addEmptyPage()
```
    Adds empty previewPage(s) to view if it's necessary e.g. when there are no placements or last page is full of placements.
    
    Returns:
    
    list of changes (added pages) or null if no page was added
  - isModelInvalid
```
public boolean isModelInvalid(PageModel page)
```
  - initPreviewPagesModel
```
protected abstract List<PreviewElementUpdate> initPreviewPagesModel()
```
    creates previewPages with order determined by positionModel implementation (fixed/dynamic/etc) and fills it with placements (again according to positionModel implementation). It corrects placements pageNumber and gridElementId attributes according to current grids
  - createNewPage
```
protected GridPreviewPage createNewPage(int pageIndex)
```
  - getSlotsQuantity
```
protected int getSlotsQuantity(int pageIndex)
```
    Returns:
    
    quantity of slots in grid of given page index.
  - getPageModel
```
public PageModel getPageModel()
```
  - getGridType
```
public SpreadPosition getGridType(PlacementModel placement)
```
    Specified by:
    
    getGridType in interface GridAwareModel
    
    Returns:
    
    type of grid (left,right,middle) of page at which the given placement is placed.
  - getGridType
```
protected SpreadPosition getGridType(int pageIndex)
```
    Returns:
    
    grid type which should be used for page with given index
  - getPreviewPages
```
public List<PreviewPage> getPreviewPages()
```
    Specified by:
    
    getPreviewPages in interface PreviewModel
    
    Returns:
    
    list of preview pages
  - addPreviewModelListener
```
public void addPreviewModelListener(PreviewModelListener listener)
```
    Specified by:
    
    addPreviewModelListener in interface PreviewModel
  - removePreviewModelListener
```
public void removePreviewModelListener(PreviewModelListener listener)
```
    Specified by:
    
    removePreviewModelListener in interface PreviewModel
  - notifyListeners
```
public void notifyListeners(List<PreviewElementUpdate> changes)
```
    Description copied from interface: PreviewModel
    
    Sends given list of changes to every interested listener (e.g. view renderers)
    
    Specified by:
    
    notifyListeners in interface PreviewModel
  - hasUnequalGrids
```
public boolean hasUnequalGrids()
```
    Returns:
    
    true if there are two grids (left,right) and each has different number of slots.
  - isFixed
```
public boolean isFixed()
```
    Returns:
    
    true if it's a fixed model
  - getSlotsCapacity
```
public int getSlotsCapacity()
```
    Specified by:
    
    getSlotsCapacity in interface PreviewModel
    
    Returns:
    
    total quantity of slots in all current previewPages (every slot will be counted including already occupied slots)
  - isShowDoublePages
```
public boolean isShowDoublePages()
```
    Specified by:
    
    isShowDoublePages in interface PreviewModel
    
    Returns:
    
    true if doublePages (two previewPages left/right) can be shown
  - setShowDoublePages
```
public void setShowDoublePages(boolean show)
```
    Specified by:
    
    setShowDoublePages in interface PreviewModel
  - getPageFormat
```
public PageFormatModel getPageFormat()
```
    Returns the publication page format.
  - getDoublePages
```
public List<PreviewPage[]> getDoublePages()
```
    Specified by:
    
    getDoublePages in interface PreviewModel
    
    Returns:
    
    previewPages coupled in pairs (model equivalent of view previewPageContainers)
  - isPagesStartLeft
```
public boolean isPagesStartLeft()
```
  - getNextPageAndSlotId
```
protected int[] getNextPageAndSlotId(int pageIndex,
                                     int slotIndex)
```
    Parameters:
    
    pageIndex -
    
    slotIndex -
    
    Returns:
    
    returns next slotId to given one. If given slotIndex is the last one on page then pageIndex is incremented and slotIndex is set to 0;
  - getPublicationService
```
public PublicationService getPublicationService()
```
  - setPublicationService
```
public void setPublicationService(PublicationService publicationService)
```
  - setDefaultTemplate
```
public void setDefaultTemplate(PageModel pageModel,
                               ItemPlacementModel placement)
```
    Description copied from interface: PreviewModel
    
    Sets default layout template (placeholder group) in given placement. It doesn't change anything in underling model
    
    Specified by:
    
    setDefaultTemplate in interface PreviewModel
  - getNextPlacementIndex
```
protected int getNextPlacementIndex(PreviewSlot slot,
                                    Collection<Object> placementsToSkip)
```
  - getNextPlacement
```
protected PlacementModel getNextPlacement(PreviewSlot slot,
                                          Collection<Object> placementsToSkip)
```
    Parameters:
    
    slot -
    
    placementsToSkip -
    
    Returns:
    
    placement at this previewSlot or nearest next placement or null if next placement doesn't exist
  - getNextSlot
```
protected PreviewSlot getNextSlot(PreviewSlot slot,
                                  boolean createNewSlots)
```
    Parameters:
    
    slot -
    
    createNewSlots - - if true new pages/slots will be created (if necessary)
    
    Returns:
    
    next (subsequent) slot to current slot - including occupied. If param createNewSlots is set to true and there are no subsequent slots then new previewPage is created and first slot from that page is returned. It returns null if param createNewSlots is set to false and no subsequent slot is found
  - save
```
protected void save(PlacementModel placement,
                    int position)
```
    Saves given placement in current pageModel at given position, if current pageModel contains this placement, it's moved from it's old position to new position
    
    Parameters:
    
    placement -
    
    position -
  - getTypedPage
```
public TypedObject getTypedPage()
```
    Specified by:
    
    getTypedPage in interface PreviewModel
    
    Returns:
    
    the page used by this model
  - getPageDimensions
```
protected int[] getPageDimensions(int pageIndex)
```
  - isPagesStartsLeft
```
public boolean isPagesStartsLeft()
```
    Specified by:
    
    isPagesStartsLeft in interface PreviewModel
    
    Returns:
    
    true if first page is aligned to left, false otherwise
  - getCockpitTypeService
```
public TypeService getCockpitTypeService()
```
    Returns:
    
    the typeService
  - setCockpitTypeService
```
public void setCockpitTypeService(TypeService typeService)
```
    Parameters:
    
    typeService - the typeService to set
  - getModelService
```
public ModelService getModelService()
```
    Returns:
    
    the modelService
  - setModelService
```
public void setModelService(ModelService modelService)
```
    Parameters:
    
    modelService - the modelService to set
  - getPrintcockpitService
```
public PrintcockpitService getPrintcockpitService()
```
    Returns:
    
    the printcockpitService
  - setPrintcockpitService
```
public void setPrintcockpitService(PrintcockpitService printcockpitService)
```
    Parameters:
    
    printcockpitService - the printcockpitService to set
  - getLayoutService
```
public LayoutService getLayoutService()
```
    Returns:
    
    the layoutService
  - setLayoutService
```
public void setLayoutService(LayoutService layoutService)
```
    Parameters:
    
    layoutService - the layoutService to set
  - removeLastEmptyPage
```
public void removeLastEmptyPage()
```
    Description copied from interface: PreviewModel
    
    Removes last empty page
    
    Specified by:
    
    removeLastEmptyPage in interface PreviewModel
  - getModelHelper
```
public ModelHelper getModelHelper()
```
    Returns:
    
    the modelHelper
  - setModelHelper
```
public void setModelHelper(ModelHelper modelHelper)
```
    Parameters:
    
    modelHelper - the modelHelper to set
  - setNotification
```
protected void setNotification(Notification notification)
```

Class AbstractPreviewModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.hybris.platform.printcockpit.view.layouts.grid.PreviewModel

Field Detail

grids

gridsSlotsIDs

pagesStartLeft

sameGridsSizes

previewPages

totalQaOfPreviewPages

Constructor Detail

AbstractPreviewModel

Method Detail

initModel

getGridsCapacity

addEmptyPage

isModelInvalid

initPreviewPagesModel

createNewPage

getSlotsQuantity

getPageModel

getGridType

getGridType

getPreviewPages

addPreviewModelListener

removePreviewModelListener

notifyListeners

hasUnequalGrids

isFixed

getSlotsCapacity

isShowDoublePages

setShowDoublePages

getPageFormat

getDoublePages

isPagesStartLeft

getNextPageAndSlotId

getPublicationService

setPublicationService

setDefaultTemplate

getNextPlacementIndex

getNextPlacement

getNextSlot

save

getTypedPage

getPageDimensions

isPagesStartsLeft

getCockpitTypeService

setCockpitTypeService

getModelService

setModelService

getPrintcockpitService

setPrintcockpitService

getLayoutService

setLayoutService

removeLastEmptyPage

getModelHelper

setModelHelper

setNotification