de.hybris.platform.printcockpit.pagemanagment.impl

Class DefaultDynamicModePagePlanner

java.lang.Object

de.hybris.platform.printcockpit.pagemanagment.AbstractPagePlanner

de.hybris.platform.printcockpit.pagemanagment.impl.DefaultDynamicModePagePlanner

All Implemented Interfaces:

PagePlanner

public class DefaultDynamicModePagePlanner
extends AbstractPagePlanner

Nested Class Summary

Nested classes/interfaces inherited from interface de.hybris.platform.printcockpit.pagemanagment.PagePlanner

PagePlanner.CanAddResult

Constructor Summary

Constructors

Constructor and Description
DefaultDynamicModePagePlanner()

Method Summary

Modifier and Type	Method and Description
int	addNewPlacement(PageModel page, PlacementModel placement, int pageNo, int gridElementId) Adds a new placement on a given page and position.
int	addNewPlacements(PageModel page, List<PlacementModel> placements, int pageNo, int gridElementId) Adds new placements starting from the given page and position.
PagePlanner.CanAddResult	canAddNewPlacement(PageModel page, int pageNo, int gridElementId) Determines if a single placement can be put on the given page and grid element on the page.
PagePlanner.CanAddResult	canAddNewPlacements(PageModel page, int pageNo, int gridElementId, int noPlacements) Determines if noPlacements can be put on the given page and grid element on the page.
PagePlanner.CanAddResult	canAddNewPlacements(PageModel page, int pageNo, int gridElementId, int noPlacements, boolean overwrite) Determines if noPlacements can be put on the given page and grid element on the page.
boolean	canChangeAlternativeGridForPage(PageModel page, GridModel altGrid)
boolean	canChangeGridForPage(PageModel page, GridModel newGrid)
boolean	canChangePageMode(PageModel page, PageMode newMode)
void	handleChangeAlternativeGridForPage(PageModel page, GridModel altGrid) Sets the GridModel on the page as an alternative grid and if needed truncates the data (Placements) to fit the new grid.
void	handleChangeGridForPage(PageModel page, GridModel newGrid) Sets the GridModel on the page and if needed truncates the data (Placements) to fit the new grid.
void	handleChangePageMode(PageModel page, PageMode newMode) Sets the PageMode on the page and if needed truncates the data (Placements) to fit the new grid.

Methods inherited from class de.hybris.platform.printcockpit.pagemanagment.AbstractPagePlanner

assignGridElementIdsToPlacements, getModelService, getOrginalValue, handleChangeGridMode, isPageStartLeft, removeCommentsMetadataFromPagesHigherThan, setModelService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultDynamicModePagePlanner

public DefaultDynamicModePagePlanner()

Method Detail

handleChangePageMode

public void handleChangePageMode(PageModel page,
                                 PageMode newMode)

Description copied from interface: PagePlanner

Sets the PageMode on the page and if needed truncates the data (Placements) to fit the new grid.

Parameters:

page - represents the page model, not necessarily a single page in the print out

newMode - PageMode to be set

canChangePageMode

public boolean canChangePageMode(PageModel page,
                                 PageMode newMode)

Parameters:

page - represents the page model, not necessarily a single page in the print out

newMode - PageMode to be set

Returns:

true if the passed PageMode can be set on the given page without data loss.

canAddNewPlacement

public PagePlanner.CanAddResult canAddNewPlacement(PageModel page,
                                                   int pageNo,
                                                   int gridElementId)

Description copied from interface: PagePlanner

Determines if a single placement can be put on the given page and grid element on the page.

Parameters:

page - represents the page model, not necessarily a single page in the print out

pageNo - 0-based page number in the print out

gridElementId - 1-based slot number on the page's grid

Returns:

PagePlanner.CanAddResult

canAddNewPlacements

public PagePlanner.CanAddResult canAddNewPlacements(PageModel page,
                                                    int pageNo,
                                                    int gridElementId,
                                                    int noPlacements)

Description copied from interface: PagePlanner

Determines if noPlacements can be put on the given page and grid element on the page.

Parameters:

page - represents the page model, not necessarily a single page in the print out

pageNo - 0-based page number in the print out

gridElementId - 1-based slot number on the page's grid

noPlacements - number of placements to be added

Returns:

PagePlanner.CanAddResult

canAddNewPlacements

public PagePlanner.CanAddResult canAddNewPlacements(PageModel page,
                                                    int pageNo,
                                                    int gridElementId,
                                                    int noPlacements,
                                                    boolean overwrite)

Description copied from interface: PagePlanner

Determines if noPlacements can be put on the given page and grid element on the page.

Parameters:

page - represents the page model, not necessarily a single page in the print out

pageNo - 0-based page number in the print out

gridElementId - 1-based slot number on the page's grid

noPlacements - number of placements to be added

overwrite - if placements are dropped in insert mode

Returns:

PagePlanner.CanAddResult

addNewPlacement

public int addNewPlacement(PageModel page,
                           PlacementModel placement,
                           int pageNo,
                           int gridElementId)

Description copied from interface: PagePlanner

Adds a new placement on a given page and position.

Parameters:

page - represents the page model, not necessarily a single page in the print out

placement - placement to be added

pageNo - 0-based page number in the print out

gridElementId - 1-based slot number on the page's grid

Returns:

1 if the placement was added successfully 0 otherwise

addNewPlacements

public int addNewPlacements(PageModel page,
                            List<PlacementModel> placements,
                            int pageNo,
                            int gridElementId)

Description copied from interface: PagePlanner

Adds new placements starting from the given page and position.

Parameters:

page - represents the page model, not necessarily a single page in the print out

placements - placements to be added

pageNo - 0-based page number in the print out

gridElementId - 1-based slot number on the page's grid

Returns:

number of successfully added placements

canChangeAlternativeGridForPage

public boolean canChangeAlternativeGridForPage(PageModel page,
                                               GridModel altGrid)

Parameters:

page - represents the page model, not necessarily a single page in the print out

altGrid - GridModel to be set

Returns:

true if the passed GridModel can be set on the given page as an alternative grid without data loss.

handleChangeGridForPage

public void handleChangeGridForPage(PageModel page,
                                    GridModel newGrid)

Description copied from interface: PagePlanner

Sets the GridModel on the page and if needed truncates the data (Placements) to fit the new grid.

Parameters:

page - represents the page model, not necessarily a single page in the print out

newGrid - GridModel to be set

canChangeGridForPage

public boolean canChangeGridForPage(PageModel page,
                                    GridModel newGrid)

Parameters:

page - represents the page model, not necessarily a single page in the print out

newGrid - GridModel to be set

Returns:

true if the passed GridModel can be set on the given page without data loss.

handleChangeAlternativeGridForPage

public void handleChangeAlternativeGridForPage(PageModel page,
                                               GridModel altGrid)

Description copied from interface: PagePlanner

Sets the GridModel on the page as an alternative grid and if needed truncates the data (Placements) to fit the new grid.

Parameters:

page - represents the page model, not necessarily a single page in the print out

altGrid - GridModel to be set