de.hybris.platform.printcockpit.view.layouts.grid

Interface PreviewModel

All Known Implementing Classes:

AbstractPagePreviewModel, AbstractPreviewModel, DoublePageModel, DynamicModel, FixedModel, NonSequencePagePreviewModel, SinglePageModel

public interface PreviewModel

methods for manipulation of placements and previewPages

Method Summary

Modifier and Type	Method and Description
void	addNewEmptyPreviewPage(int destinationIndex)
void	addPlacements(Collection<Object> placementsOrProducts, PreviewPage dropPage, boolean overwrite) Adds new placements to model (e.g.
void	addPlacements(Collection<Object> placementsOrProducts, PreviewSlot dropSlot, boolean overwrite) Adds new placements or products to model (e.g.
void	addPreviewModelListener(PreviewModelListener l)
void	copyPlacements(Collection placementsToCopy, PreviewPage copyToPage)
void	copyPlacements(Collection placementsToCopy, PreviewSlot copyToSlot)
void	copyPreviewPages(Collection<PreviewPage> pagesToCopy, int copyToPageIndex)
void	deletePlacements(Collection<PlacementModel> placementsToDelete) performs placements deletion, notifies any sub layer and returns info what has changed (class responsible for rendering view should use this information to do view changes)
void	deletePreviewPages(Collection<PreviewPage> pagesToDelete) performs previewPages deletion, notifies any sub layer and returns info what has changed (class responsible for rendering view should use this information to do view changes)
List<PreviewPage[]>	getDoublePages()
List<PreviewPage>	getPreviewPages()
int	getPreviewPagesTotalQuantity()
int	getSlotsCapacity()
TypedObject	getTypedPage()
void	initModel() Initializes the model with data from Model/typedObjects layer
boolean	isPagesStartsLeft()
boolean	isShowDoublePages()
void	movePlacements(Collection<Object> placementsToMove, PreviewPage moveToPage, boolean overwrite)
void	movePlacements(Collection<Object> placementsToMove, PreviewSlot moveToSlot, boolean overwrite)
void	movePreviewPages(Collection<PreviewPage> pagesToMove, int moveToPageIndex, boolean overwrite)
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 l)
void	setDefaultTemplate(PageModel pageModel, ItemPlacementModel placement) Sets default layout template (placeholder group) in given placement.
void	setShowDoublePages(boolean show)

Method Detail

addNewEmptyPreviewPage

void addNewEmptyPreviewPage(int destinationIndex)

deletePreviewPages

void deletePreviewPages(Collection<PreviewPage> pagesToDelete)

performs previewPages deletion, notifies any sub layer and returns info what has changed (class responsible for rendering view should use this information to do view changes)

deletePlacements

void deletePlacements(Collection<PlacementModel> placementsToDelete)

performs placements deletion, notifies any sub layer and returns info what has changed (class responsible for rendering view should use this information to do view changes)

copyPlacements

void copyPlacements(Collection placementsToCopy,
                    PreviewSlot copyToSlot)

Parameters:

placementsToCopy -

copyToSlot - destination slot

movePlacements

void movePlacements(Collection<Object> placementsToMove,
                    PreviewSlot moveToSlot,
                    boolean overwrite)

Parameters:

placementsToMove -

moveToSlot - destination slot

overwrite -

copyPlacements

void copyPlacements(Collection placementsToCopy,
                    PreviewPage copyToPage)

Parameters:

placementsToCopy -

copyToPage - destination page

movePlacements

void movePlacements(Collection<Object> placementsToMove,
                    PreviewPage moveToPage,
                    boolean overwrite)

Parameters:

placementsToMove -

moveToPage - destination page

overwrite -

addPlacements

void addPlacements(Collection<Object> placementsOrProducts,
                   PreviewPage dropPage,
                   boolean overwrite)

Adds new placements to model (e.g. placements from other publications or catalogs)

Parameters:

placementsOrProducts -

dropPage -

overwrite -

addPlacements

void addPlacements(Collection<Object> placementsOrProducts,
                   PreviewSlot dropSlot,
                   boolean overwrite)

Adds new placements or products to model (e.g. placements from other publications or catalogs)

Parameters:

placementsOrProducts -

dropSlot -

overwrite -

copyPreviewPages

void copyPreviewPages(Collection<PreviewPage> pagesToCopy,
                      int copyToPageIndex)

Parameters:

pagesToCopy -

copyToPageIndex - destination page index

movePreviewPages

void movePreviewPages(Collection<PreviewPage> pagesToMove,
                      int moveToPageIndex,
                      boolean overwrite)

Parameters:

pagesToMove -

moveToPageIndex - destination page index

overwrite -

getPreviewPages

List<PreviewPage> getPreviewPages()

Returns:

list of preview pages

setDefaultTemplate

void setDefaultTemplate(PageModel pageModel,
                        ItemPlacementModel placement)

Sets default layout template (placeholder group) in given placement. It doesn't change anything in underling model

Parameters:

placement -

notifyListeners

void notifyListeners(List<PreviewElementUpdate> changes)

Sends given list of changes to every interested listener (e.g. view renderers)

Parameters:

changes -

addPreviewModelListener

void addPreviewModelListener(PreviewModelListener l)

removePreviewModelListener

void removePreviewModelListener(PreviewModelListener l)

getSlotsCapacity

int getSlotsCapacity()

Returns:

total quantity of slots in all current previewPages (every slot will be counted including already occupied slots)

isShowDoublePages

boolean isShowDoublePages()

Returns:

true if doublePages (two previewPages left/right) can be shown

setShowDoublePages

void setShowDoublePages(boolean show)

Parameters:

show -

getDoublePages

List<PreviewPage[]> getDoublePages()

Returns:

previewPages coupled in pairs (model equivalent of view previewPageContainers)

initModel

void initModel()

Initializes the model with data from Model/typedObjects layer

getPreviewPagesTotalQuantity

int getPreviewPagesTotalQuantity()

Returns:

Total quantity (regardless of current navigable page) of previewPages generated by this previewModel for given pageModel (list of placements).

getTypedPage

TypedObject getTypedPage()

Returns:

page which is used in this model represented as typedObject

isPagesStartsLeft

boolean isPagesStartsLeft()

Returns:

true if first page is aligned to left, false otherwise

removeLastEmptyPage

void removeLastEmptyPage()

Removes last empty page