de.hybris.platform.printcockpit.view.browser.publication

Class PreviewLayoutContainer

java.lang.Object

de.hybris.platform.printcockpit.view.layouts.AbstractContainer

de.hybris.platform.printcockpit.view.browser.publication.PreviewLayoutContainer

All Implemented Interfaces:

LayoutElementRenderer, DataTransferAcceptor, DataTransferProvider

public class PreviewLayoutContainer
extends AbstractContainer
implements DataTransferProvider, LayoutElementRenderer

Responsible for rendering view. Handles previewPages and placements selections in preview area, (html) previewPage size/appearance and chapters stripes if used in multi pages structure view

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PreviewLayoutContainer.DropPosition
static class	PreviewLayoutContainer.PreviewLayoutDropLocation

Nested classes/interfaces inherited from class de.hybris.platform.printcockpit.view.layouts.AbstractContainer

AbstractContainer.EmptySpaceDropLocation

Field Summary

Fields

Modifier and Type	Field and Description
static String	BROWSER_ARG
static String	TYPED_ITEM_ARG

Fields inherited from class de.hybris.platform.printcockpit.view.layouts.AbstractContainer

dataTransferHandler

Constructor Summary

Constructors

Constructor and Description
PreviewLayoutContainer(Component divArea, boolean chainedPages)

Method Summary

Modifier and Type	Method and Description
protected void	adjustPageContainers()
void	chanegPreviewImages(List<String> urls)
protected void	checkUniqueListener(ListSelectionModel model)
protected List<Component>	clear(PreviewSlot slot)
protected void	clearAllPlacementsSelections()
protected void	clearAllPreviewPageContainersSelections()
void	clearPreviewPage(PreviewElementUpdate change)
protected void	clearSelection(PreviewSlot slot)
protected void	clearSelection(PreviewSlot from, PreviewSlot to)
void	clearSlot(PreviewElementUpdate change)
protected void	containerClicked()
protected Component	createPageBox(PreviewPage page, int position)
protected Component	createPageComponent(PreviewPage previewPage, int pagePos) Creates page component with header and footer
protected Component	createSlotBox(PreviewSlot previewSlot)
protected void	desktopRemoved()
Object	exportData(Component component)
protected List<Component>	getAllPageComponents()
PreviewSlot	getFirstInsertableSlot()
protected int	getListPosition(PreviewSlot slot)
DataTransferLocation	getLocation(Component component)
PreviewPage	getMinSelectedPreviewPage()
PreviewSlot	getMinSelectedSlot()
protected PreviewPage	getPageAt(int pagePos)
protected Component	getPageComponent(int pageIndex, boolean withHF)
protected Div	getPageContainerComponent(int containerPos)
int	getPageContainerPos(int pagePos)
protected int	getPageInContainerPos(int pagePos)
protected int	getPagePosition(Component comp)
protected int	getPagesPerPageContainer()
ListSelectionModel	getPlacementsSelectionModel()
ListSelectionListener	getPreviewPageContainerSelectionListener()
ListSelectionModel	getPreviewPageContainerSelectionModel()
int	getScale()
List	getSelectedData() returns list of data (TypedObjects(placements) or PreviePages) which has been selected by user: by selecting slots or whole preview pages
protected Component	getSlotComponent(PreviewPage previewPage, int slotIndex)
protected PreviewSlot	getSlotPosition(Component comp)
protected void	handleClick(MouseEvent evt, boolean doubleClick) handles both: clicking at slots and previewPages
void	handleClickAtPageContainer(MouseEvent evt, boolean doubleClick)
void	handleDrop(DropEvent evt)
protected void	initComponent(PreviewLayoutBlock layoutBlock, HtmlBasedComponent comp)
protected void	insertPageComponent(Component pageComponent, int pos)
protected boolean	isSelected(int listPos)
protected boolean	isSelected(PreviewSlot slot)
protected void	markSelected(Component comp, boolean selected)
protected void	markSelected(PreviewSlot slot, boolean selected)
protected void	markSelectedPreviewPageContainer(int position, boolean selected)
protected List<Component>	move(List<Component> toCopy, PreviewSlot slot) Deprecated.
protected List<Component>	move(PreviewSlot from, PreviewSlot to)
boolean	needsUpdate(ItemModel itemModel, Set<PropertyDescriptor> modifiedProperties)
void	pageAdded(PreviewElementUpdate change)
void	pagesRemoved(PreviewElementUpdate change) Removes pages one by one according to given indices in change object
protected void	placementsSelectionModelChanged()
void	reAlignPages()
protected void	removeAllComponents()
protected void	removePageComponent(int pagePos)
protected void	render(Component previewSlotComponent, PreviewSlot previewSlot)
void	renderElement(Object data, Component componentToRender)
protected void	renderPlacementInfoBar(Component previewSlotComponent, PreviewSlot previewSlot)
protected void	renderSlot(PreviewPage page, int slotIndex) Clears and renders the content of one grid element.
protected void	resetSlotComponent(PreviewSlot slot)
protected void	resize() changes size of preview pages according to current scale.
void	resize(double screenWidth, double screenHeight) Resizes all preview pages to given screen size
protected void	resizeAll()
protected int[]	resizePage(int left, int top, PreviewPage previewPage, int pagePos) Resizes page component and it's header and footer
protected int[]	resizePageBox(int left, int top, PreviewPage previewPage, HtmlBasedComponent page)
protected void	resizePageContainerBox(int scaledWidth, HtmlBasedComponent comp)
protected void	resizeSlotBox(PreviewSlot slot, HtmlBasedComponent comp)
protected int	scale(double srcPos)
void	setPlacementsSelectionModel(ListSelectionModel selectionModel)
void	setPreviewModel(PreviewModel previewModel)
void	setPreviewOverlayImages(List<String> urls) Changes previews of pages so that they display generated images over previews with slots
void	setPreviewPageContainerSelectionListener(ListSelectionListener previewPageContainerSelectionListener)
void	setPreviewPageContainerSelectionModel(ListSelectionModel selectionModel)
void	setScale(int scale) Resizes all components
void	setScaleVariable(int scale)
protected void	shiftPageComponent(Component comp, int offset)
void	slotUpdated(PreviewElementUpdate change)
protected boolean	startsRight()
void	syncWithPreviewModel()

Methods inherited from class de.hybris.platform.printcockpit.view.layouts.AbstractContainer

gainFocus, getDataTransferHandler, getMainContainer, getStripesContainer, initMainContainer, isChainedPages, isShowing, isShowPerformanceInfo, onFocusLost, setDataTransferHandler, setShowPerformanceInfo

Methods inherited from class java.lang.Object

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

Field Detail

BROWSER_ARG

public static final String BROWSER_ARG

See Also:

Constant Field Values

TYPED_ITEM_ARG

public static final String TYPED_ITEM_ARG

See Also:

Constant Field Values

Constructor Detail

PreviewLayoutContainer

public PreviewLayoutContainer(Component divArea,
                              boolean chainedPages)

Method Detail

desktopRemoved

protected void desktopRemoved()

Overrides:

desktopRemoved in class AbstractContainer

setPreviewModel

public void setPreviewModel(PreviewModel previewModel)

getScale

public int getScale()

Returns:

scale (in %) in which preview pages of this container are displayed

setScaleVariable

public void setScaleVariable(int scale)

Parameters:

scale - to set, it won't resize any component

setScale

public void setScale(int scale)

Resizes all components

Parameters:

scale - to set given in %, e.g 25 means everything will be reduced to 1/4 of it's original size

adjustPageContainers

protected void adjustPageContainers()

resizeAll

protected void resizeAll()

resize

protected void resize()

changes size of preview pages according to current scale. If this container is a part of multi structure view then chapters strips are also resized

resizePage

protected int[] resizePage(int left,
                           int top,
                           PreviewPage previewPage,
                           int pagePos)

Resizes page component and it's header and footer

syncWithPreviewModel

public void syncWithPreviewModel()

createPageComponent

protected Component createPageComponent(PreviewPage previewPage,
                                        int pagePos)

Creates page component with header and footer

Returns:

Div component which holds header,page,footer

getPlacementsSelectionModel

public ListSelectionModel getPlacementsSelectionModel()

setPlacementsSelectionModel

public void setPlacementsSelectionModel(ListSelectionModel selectionModel)

getPreviewPageContainerSelectionModel

public ListSelectionModel getPreviewPageContainerSelectionModel()

setPreviewPageContainerSelectionModel

public void setPreviewPageContainerSelectionModel(ListSelectionModel selectionModel)

getPreviewPageContainerSelectionListener

public ListSelectionListener getPreviewPageContainerSelectionListener()

setPreviewPageContainerSelectionListener

public void setPreviewPageContainerSelectionListener(ListSelectionListener previewPageContainerSelectionListener)

checkUniqueListener

protected void checkUniqueListener(ListSelectionModel model)

placementsSelectionModelChanged

protected void placementsSelectionModelChanged()

removeAllComponents

protected void removeAllComponents()

insertPageComponent

protected void insertPageComponent(Component pageComponent,
                                   int pos)

removePageComponent

protected void removePageComponent(int pagePos)

renderSlot

protected void renderSlot(PreviewPage page,
                          int slotIndex)

Clears and renders the content of one grid element.

resetSlotComponent

protected void resetSlotComponent(PreviewSlot slot)

move

protected List<Component> move(PreviewSlot from,
                               PreviewSlot to)

move

@Deprecated
protected List<Component> move(List<Component> toCopy,
                                           PreviewSlot slot)

Deprecated.

clear

protected List<Component> clear(PreviewSlot slot)

render

protected void render(Component previewSlotComponent,
                      PreviewSlot previewSlot)

renderPlacementInfoBar

protected void renderPlacementInfoBar(Component previewSlotComponent,
                                      PreviewSlot previewSlot)

resize

public void resize(double screenWidth,
                   double screenHeight)

Resizes all preview pages to given screen size

Parameters:

screenWidth - of screen or used area

screenHeight - of screen or used area

scale

protected int scale(double srcPos)

resizePageContainerBox

protected void resizePageContainerBox(int scaledWidth,
                                      HtmlBasedComponent comp)

resizePageBox

protected int[] resizePageBox(int left,
                              int top,
                              PreviewPage previewPage,
                              HtmlBasedComponent page)

Returns:

width and height of page in current scale

resizeSlotBox

protected void resizeSlotBox(PreviewSlot slot,
                             HtmlBasedComponent comp)

initComponent

protected void initComponent(PreviewLayoutBlock layoutBlock,
                             HtmlBasedComponent comp)

shiftPageComponent

protected void shiftPageComponent(Component comp,
                                  int offset)

createPageBox

protected Component createPageBox(PreviewPage page,
                                  int position)

createSlotBox

protected Component createSlotBox(PreviewSlot previewSlot)

getSlotPosition

protected PreviewSlot getSlotPosition(Component comp)

getPagePosition

protected int getPagePosition(Component comp)

getPageContainerComponent

protected Div getPageContainerComponent(int containerPos)

getPagesPerPageContainer

protected int getPagesPerPageContainer()

startsRight

protected boolean startsRight()

getPageContainerPos

public int getPageContainerPos(int pagePos)

getPageInContainerPos

protected int getPageInContainerPos(int pagePos)

getPageComponent

protected Component getPageComponent(int pageIndex,
                                     boolean withHF)

Parameters:

pageIndex - is the index of previepage within previewPages list and not the index of page (zk)component

withHF - if true component with header,page and footer is returned, if false only page is returned

Returns:

zk component representing previewPage

getAllPageComponents

protected List<Component> getAllPageComponents()

getSlotComponent

protected Component getSlotComponent(PreviewPage previewPage,
                                     int slotIndex)

setPreviewOverlayImages

public void setPreviewOverlayImages(List<String> urls)

Changes previews of pages so that they display generated images over previews with slots

getPageAt

protected PreviewPage getPageAt(int pagePos)

getListPosition

protected int getListPosition(PreviewSlot slot)

isSelected

protected boolean isSelected(PreviewSlot slot)

isSelected

protected boolean isSelected(int listPos)

clearSelection

protected void clearSelection(PreviewSlot slot)

clearSelection

protected void clearSelection(PreviewSlot from,
                              PreviewSlot to)

clearAllPlacementsSelections

protected void clearAllPlacementsSelections()

clearAllPreviewPageContainersSelections

protected void clearAllPreviewPageContainersSelections()

getSelectedData

public List getSelectedData()

returns list of data (TypedObjects(placements) or PreviePages) which has been selected by user: by selecting slots or whole preview pages

getMinSelectedSlot

public PreviewSlot getMinSelectedSlot()

Returns:

previewSlot of first slot in selection

getMinSelectedPreviewPage

public PreviewPage getMinSelectedPreviewPage()

Returns:

previewPage of first page in selection

getFirstInsertableSlot

public PreviewSlot getFirstInsertableSlot()

markSelected

protected void markSelected(PreviewSlot slot,
                            boolean selected)

markSelected

protected void markSelected(Component comp,
                            boolean selected)

markSelectedPreviewPageContainer

protected void markSelectedPreviewPageContainer(int position,
                                                boolean selected)

containerClicked

protected void containerClicked()

Overrides:

containerClicked in class AbstractContainer

handleClick

protected void handleClick(MouseEvent evt,
                           boolean doubleClick)

handles both: clicking at slots and previewPages

handleDrop

public void handleDrop(DropEvent evt)

handleClickAtPageContainer

public void handleClickAtPageContainer(MouseEvent evt,
                                       boolean doubleClick)

getLocation

public DataTransferLocation getLocation(Component component)

Specified by:

getLocation in interface DataTransferAcceptor

Overrides:

getLocation in class AbstractContainer

exportData

public Object exportData(Component component)

Specified by:

exportData in interface DataTransferProvider

renderElement

public void renderElement(Object data,
                          Component componentToRender)

Specified by:

renderElement in interface LayoutElementRenderer

clearSlot

public void clearSlot(PreviewElementUpdate change)

clearPreviewPage

public void clearPreviewPage(PreviewElementUpdate change)

pageAdded

public void pageAdded(PreviewElementUpdate change)

slotUpdated

public void slotUpdated(PreviewElementUpdate change)

reAlignPages

public void reAlignPages()

pagesRemoved

public void pagesRemoved(PreviewElementUpdate change)

Removes pages one by one according to given indices in change object

Parameters:

change -

needsUpdate

public boolean needsUpdate(ItemModel itemModel,
                           Set<PropertyDescriptor> modifiedProperties)

Parameters:

itemModel - - page,chapter or publication which has changed

modifiedProperties - - properties of given itemModel that has changed

Returns:

true if underling structure model needs update because page (that this model represents) has change or chapter/publication of this page has changed

chanegPreviewImages

public void chanegPreviewImages(List<String> urls)