de.hybris.platform.printcockpit.pagemanagment

Interface PagePlanner

All Known Implementing Classes:

AbstractPagePlanner, DefaultDynamicModePagePlanner, DefaultFixedModePagePlanner

public interface PagePlanner

Helper class for managing PageModel's properties and it's Placements.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PagePlanner.CanAddResult Result class for several PagePlanner methods.

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.
void	assignGridElementIdsToPlacements(PageModel page) Assigns proper gridElementIds and page numbers to placements, based on their order in collection
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 newGrid)
boolean	canChangeGridForPage(PageModel page, GridModel newGrid)
boolean	canChangePageMode(PageModel page, PageMode newMode)
void	handleChangeAlternativeGridForPage(PageModel page, GridModel newGrid) 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	handleChangeGridMode(PageModel page, GridMode newGridMode) Changes GridMode for the given page and assigns proper page numbers / grid element id's if needed.
void	handleChangePageMode(PageModel page, PageMode newMode) Sets the PageMode on the page and if needed truncates the data (Placements) to fit the new grid.
boolean	isPageStartLeft(PageModel page) Determines whether the first page is a left page (in the meaning of two page printout).

Method Detail

canAddNewPlacement

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.

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

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.

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

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.

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

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

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

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

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

canChangeGridForPage

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.

handleChangeGridForPage

void handleChangeGridForPage(PageModel page,
                             GridModel newGrid)

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

canChangePageMode

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.

handleChangePageMode

void handleChangePageMode(PageModel page,
                          PageMode newMode)

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

canChangeAlternativeGridForPage

boolean canChangeAlternativeGridForPage(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 as an alternative grid without data loss.

handleChangeAlternativeGridForPage

void handleChangeAlternativeGridForPage(PageModel page,
                                        GridModel newGrid)

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

newGrid - GridModel to be set

isPageStartLeft

boolean isPageStartLeft(PageModel page)

Determines whether the first page is a left page (in the meaning of two page printout). For pages starting from left side alternative grid is the first one in the sequence.

Parameters:

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

Returns:

true if the page starts from left page in case of a double page print out.

handleChangeGridMode

void handleChangeGridMode(PageModel page,
                          GridMode newGridMode)

Changes GridMode for the given page and assigns proper page numbers / grid element id's if needed.

Parameters:

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

newGridMode - GridMode to be set

assignGridElementIdsToPlacements

void assignGridElementIdsToPlacements(PageModel page)

Assigns proper gridElementIds and page numbers to placements, based on their order in collection

Parameters:

page - represents page model