CmsPageBrowserModel (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.cockpit.session.impl.AbstractBrowserModel
- - de.hybris.platform.cockpit.session.impl.AbstractAdvancedBrowserModel
  - - de.hybris.platform.cockpit.session.impl.AbstractSectionBrowserModel
    - - de.hybris.platform.cmscockpit.session.impl.CmsPageBrowserModel

All Implemented Interfaces:

CockpitEventAcceptor, AdvancedBrowserModel, BrowserModel, CockpitListComponent<TypedObject>, CockpitListComponentExt<TypedObject>, SectionBrowserModel, Cloneable
```
public class CmsPageBrowserModel
extends AbstractSectionBrowserModel
implements CockpitEventAcceptor
```
Represents model for "structure" browser. Supported modes:
- flat - flat representation of each content slots
- structure - if template available - we can display structure of page
- drilldown - we can navigate down into page structure
- preview - displays current page preview

Field Summary

Fields
Modifier and Type	Field and Description
`protected CMSAdminComponentService`	`cmsAdminComponentService`
`protected CMSAdminContentSlotService`	`cmsAdminContentSlotService`
`protected CMSAdminSiteService`	`cmsAdminSiteService`
`protected CmsCockpitService`	`cmsCockpitService`
`protected ModelService`	`modelService`
`protected Map<TypedObject,Set<TypedObject>>`	`updateNotificationMap`

Fields inherited from class de.hybris.platform.cockpit.session.impl.AbstractAdvancedBrowserModel
contextItems, LIST_VIEW_CONFIG_CODE, viewMode

Fields inherited from class de.hybris.platform.cockpit.session.impl.AbstractBrowserModel
browserListeners, cacheView, rootType, VIEWMODE_GRID, VIEWMODE_LIST

Constructor Summary

Constructors
Constructor and Description
`CmsPageBrowserModel(CMSAdminSiteService cmsAdminSiteService, CmsCockpitService cmsCockpitService, ModelService modelService, CMSAdminComponentService cmsAdminComponentService, CMSAdminContentSlotService cmsAdminContentSlotService)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addToAdditionalItemChangeUpdateNotificationMap(TypedObject itemToUpdate, Collection<TypedObject> changedItems)`
`void`	`clearSelection(ListBrowserSectionModel browserSectionModel)` Responsible for clearing selection in all sections after change it
`Object`	`clone()`
`protected String`	`computeReadableName(String position)`
`TypedObject`	`contentSlotDefined(ContentSlotNameModel potentateContetSlot)` Deprecated.
`protected ContentEditorBrowserSectionModel`	`createAndInitContentEditorSection(ListBrowserSectionModel simpleElementSection, ListBrowserSectionModel contentElementSection)` Creates and initialize content editor section model
`protected ListBrowserSectionModel`	`createAndInitContentElementSection(ListBrowserSectionModel contentSlotSection)` Creates and initialize content element section model
`protected ListBrowserSectionModel`	`createAndInitContentSlotSection()` Creates and initialize content slot section model
`void`	`createAndInitializeDrilldownView()` Creates and initialize a drilldown view
`void`	`createAndInitializeFlatOrStructureView()` Creates and initialize flat and structure view
`protected ListBrowserSectionModel`	`createAndInitSimpleElementSection(ListBrowserSectionModel contentElementSection)` Creates and initialize simple element section model
`protected ContentEditorBrowserSectionModel`	`createContentElementEditorSection()`
`ContentSlotModel`	`createContentSlotForPage(String position)` Creates a ContentSlotForPage at give position for current page
`protected void`	`createProperViewModel()`
`ContentSlotModel`	`createSlotContentForCurrentPage(String position)` Creates content slot at give position for current page
`AbstractContentBrowser`	`createViewComponent()`
`void`	`deleteCurrentPage()` Deletes current page
`void`	`deleteSlotContentForCurrentPage(String uid)` Removes content slot by given uid
`CatalogVersionModel`	`getActiveCatalogVersion()`
`CMSSiteModel`	`getActiveSite()` Returns current selected site
`List<ObjectType>`	`getAdditableType()`
`Collection<TypedObject>`	`getAdditionalItemsToUpdate(TypedObject changedItem)`
`List<TypedObject>`	`getAllPagesWithSameLabelOrType()`
`List<ContentSlotNameModel>`	`getAvailableSlotsForCurrentPage()`
`List<MainAreaComponentFactory>`	`getAvailableViewModes()`
`protected ContentSlotModel`	`getContentaSlotAtPositionForPage(TypedObject wrappedPageModel, String position)` Checks whether there is already created a content slot for given page at given position.
`ContentEditorBrowserSectionModel`	`getContentEditorSection()`
`ListBrowserSectionModel`	`getContentElementSection()` Returns content element section model
`ListBrowserSectionModel`	`getContentSlotSection()` Returns content slot section model
`protected List<ContentSlotModel>`	`getContentSlotsForCurrentPage()` Returns all content slots that are defined for current page
`protected AbstractPageModel`	`getCurrentCmsPage()`
`TypedObject`	`getCurrentPageObject()` Returns current page
`String`	`getExtendedLabel()`
`GenericRandomNameProducer`	`getGenericRandomNameProducer()`
`String`	`getLabel()`
`List<ContentSlotNameModel>`	`getMissingSlotsForCurrentPage()`
`SectionModelListener`	`getSectionModelListenerForDrilldownView()`
`ListBrowserSectionModel`	`getSimpleElementSection()` Returns simple element section model
`protected TypeService`	`getTypeService()`
`void`	`initialize()`
`boolean`	`isAssignedToPage(ContentSlotModel contentSlot)` Checks whether this content slot belongs to page
`boolean`	`isBackButtonVisible()`
`boolean`	`isStructViewAvailable()` Checks whether structure view for current page is available
`protected CmsPageBrowserModel`	`newCmsPageBrowserModel()`
`protected CmsPageMainAreaEditComponentFactory`	`newCmsPageMainAreaEditComponentFactory()`
`protected CmsPageMainAreaPersonalizeComponentFactory`	`newCmsPageMainAreaPersonalizeComponentFactory()`
`protected CmsPageMainAreaPreviewComponentFactory`	`newCmsPageMainAreaPreviewComponentFactory()`
`void`	`onClose()` Called before this browser is closed.
`void`	`onCockpitEvent(CockpitEvent event)`
`void`	`removeComponentFromSlot(TypedObject parentSlot, TypedObject component)`
`BrowserSectionModel`	`retriveSectionModelByContentSlot(String position)`
`void`	`setArea(UIBrowserArea area)`
`void`	`setCurrentPageObject(TypedObject page)` Sets given page as am active
`void`	`updateItems()`

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractSectionBrowserModel
blacklistItems, getBrowserSectionModel, getBrowserSectionModels, getItem, getItems, getSectionModelListener, getSelectedIndexes, removeItems, setBrowserSectionModels, setSectionModelListener

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractAdvancedBrowserModel
addBrowserModelListener, collapse, doDrop, fireContextItemsChanged, fireContextRootTypeChanged, fireContextSelectionChanged, fireContextViewModeChanged, fireContextVisibilityChanged, fireItemActivated, fireItemsDropped, fireViewModeChanged, getActiveItem, getCompareModel, getContextInitialValueMapping, getContextItems, getContextRootItem, getContextRootType, getContextRootTypePropertyDescriptor, getContextTableModel, getContextViewMode, getLastType, getListViewConfiguration, getSelectedContextIndexes, getTableModel, getViewMode, isCollapsed, isContextItemsMovable, isContextItemsRemovable, isContextPropertyWritable, isContextVisible, isItemsMovable, isItemsRemovable, isPossibleAddContextSubTypes, setActiveItem, setCompareModel, setContextInitialValueMapping, setContextItems, setContextItems, setContextItemsDirectly, setContextItemsMovable, setContextItemsRemovable, setContextRootType, setContextRootTypePropertyDescriptor, setContextTableModel, setContextViewMode, setContextVisible, setContextVisibleDirect, setItemsMovable, setItemsRemovable, setSelectedContextIndexes, setTableModel, setViewMode

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractBrowserModel
clearSelection, fireChanged, fireItemsChanged, fireRootTypeChanged, fireSelectionChanged, focus, getArea, getAvailableBrowserFilters, getBrowserFilter, getBrowserFilterFixed, getCacheView, getRootType, getSelectedItems, getTotalCount, hasStatusBar, isAdvancedHeaderDropdownSticky, isAdvancedHeaderDropdownVisible, isAllMarked, isDuplicatable, isFocused, multiEdit, multiEdit, onHide, onShow, removeBrowserModelListener, setAllMarked, setBrowserFilter, setBrowserFilterFixed, setCacheView, setExtendedLabel, setLabel, setRootType, setSelectedIndexes, setTotalCount

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

Methods inherited from interface de.hybris.platform.cockpit.session.AdvancedBrowserModel
doDrop, getActiveItem, getContextInitialValueMapping, getContextItems, getContextRootItem, getContextRootType, getContextRootTypePropertyDescriptor, getContextTableModel, getContextViewMode, getLastType, getSelectedContextIndexes, getTableModel, getViewMode, isContextItemsMovable, isContextItemsRemovable, isContextVisible, isItemsMovable, isItemsRemovable, setActiveItem, setContextInitialValueMapping, setContextItems, setContextItems, setContextItemsDirectly, setContextItemsMovable, setContextItemsRemovable, setContextRootType, setContextRootTypePropertyDescriptor, setContextTableModel, setContextViewMode, setContextVisible, setContextVisibleDirect, setItemsMovable, setItemsRemovable, setSelectedContextIndexes, setTableModel, setViewMode

Methods inherited from interface de.hybris.platform.cockpit.session.BrowserModel
addBrowserModelListener, collapse, focus, getArea, getAvailableBrowserFilters, getBrowserFilter, getRootType, getSelectedItems, getTotalCount, hasStatusBar, isAdvancedHeaderDropdownSticky, isAdvancedHeaderDropdownVisible, isAllMarked, isCollapsed, isDuplicatable, isFocused, multiEdit, multiEdit, removeBrowserModelListener, setAllMarked, setBrowserFilter, setExtendedLabel, setLabel, setRootType, setSelectedIndexes, setTotalCount

Field Detail

cmsAdminSiteService

protected CMSAdminSiteService cmsAdminSiteService

cmsCockpitService

protected CmsCockpitService cmsCockpitService

modelService
```
protected ModelService modelService
```

cmsAdminComponentService

protected CMSAdminComponentService cmsAdminComponentService

cmsAdminContentSlotService

protected CMSAdminContentSlotService cmsAdminContentSlotService

updateNotificationMap

protected Map<TypedObject,Set<TypedObject>> updateNotificationMap

Constructor Detail

CmsPageBrowserModel

public CmsPageBrowserModel(CMSAdminSiteService cmsAdminSiteService,
                           CmsCockpitService cmsCockpitService,
                           ModelService modelService,
                           CMSAdminComponentService cmsAdminComponentService,
                           CMSAdminContentSlotService cmsAdminContentSlotService)

Method Detail
- getAllPagesWithSameLabelOrType
```
public List<TypedObject> getAllPagesWithSameLabelOrType()
```
- getAvailableViewModes
```
public List<MainAreaComponentFactory> getAvailableViewModes()
```
  Specified by:
  
  getAvailableViewModes in interface AdvancedBrowserModel
  
  Overrides:
  
  getAvailableViewModes in class AbstractAdvancedBrowserModel
- clone
```
public Object clone()
             throws CloneNotSupportedException
```
  Specified by:
  
  clone in interface BrowserModel
  
  Specified by:
  
  clone in class AbstractSectionBrowserModel
  
  Throws:
  
  CloneNotSupportedException
- newCmsPageBrowserModel
```
protected CmsPageBrowserModel newCmsPageBrowserModel()
```
- newCmsPageMainAreaEditComponentFactory
```
protected CmsPageMainAreaEditComponentFactory newCmsPageMainAreaEditComponentFactory()
```
- newCmsPageMainAreaPreviewComponentFactory
```
protected CmsPageMainAreaPreviewComponentFactory newCmsPageMainAreaPreviewComponentFactory()
```
- newCmsPageMainAreaPersonalizeComponentFactory
```
protected CmsPageMainAreaPersonalizeComponentFactory newCmsPageMainAreaPersonalizeComponentFactory()
```
- createViewComponent
```
public AbstractContentBrowser createViewComponent()
```
  Specified by:
  
  createViewComponent in interface BrowserModel
  
  Specified by:
  
  createViewComponent in class AbstractSectionBrowserModel
- initialize
```
public void initialize()
```
  Specified by:
  
  initialize in interface SectionBrowserModel
- setArea
```
public void setArea(UIBrowserArea area)
```
  Specified by:
  
  setArea in interface BrowserModel
  
  Overrides:
  
  setArea in class AbstractBrowserModel
- setCurrentPageObject
```
public void setCurrentPageObject(TypedObject page)
```
  Sets given page as am active
  Note:
  
  Parameters:
  
  page - given page
- getCurrentPageObject
```
public TypedObject getCurrentPageObject()
```
  Returns current page
  Note:
  
  Returns:
  
  current page
- getContentSlotSection
```
public ListBrowserSectionModel getContentSlotSection()
```
  Returns content slot section model
  Note:
  
  Returns:
  
  content slot section model
- getContentElementSection
```
public ListBrowserSectionModel getContentElementSection()
```
  Returns content element section model
  Note:
  
  Returns:
  
  content element section model
- getSimpleElementSection
```
public ListBrowserSectionModel getSimpleElementSection()
```
  Returns simple element section model
  Note:
  
  Returns:
  
  simple element section model
- getContentSlotsForCurrentPage
```
protected List<ContentSlotModel> getContentSlotsForCurrentPage()
```
  Returns all content slots that are defined for current page
  
  Returns:
  
  content slot list
- getMissingSlotsForCurrentPage
```
public List<ContentSlotNameModel> getMissingSlotsForCurrentPage()
```
- getAvailableSlotsForCurrentPage
```
public List<ContentSlotNameModel> getAvailableSlotsForCurrentPage()
```
- createSlotContentForCurrentPage
```
public ContentSlotModel createSlotContentForCurrentPage(String position)
```
  Creates content slot at give position for current page
  
  Parameters:
  
  position - given position on the current page
- createContentSlotForPage
```
public ContentSlotModel createContentSlotForPage(String position)
```
  Creates a ContentSlotForPage at give position for current page
  
  Parameters:
  
  position - given position on the current page
- getContentaSlotAtPositionForPage
```
protected ContentSlotModel getContentaSlotAtPositionForPage(TypedObject wrappedPageModel,
                                                            String position)
```
  Checks whether there is already created a content slot for given page at given position.
  
  Parameters:
  
  wrappedPageModel - wrapped current page
  
  position - position that will be checked
- computeReadableName
```
protected String computeReadableName(String position)
```
- removeComponentFromSlot
```
public void removeComponentFromSlot(TypedObject parentSlot,
                                    TypedObject component)
```
- deleteSlotContentForCurrentPage
```
public void deleteSlotContentForCurrentPage(String uid)
```
  Removes content slot by given uid
  
  Parameters:
  
  uid - identifier of content slot that will be removed
- isStructViewAvailable
```
public boolean isStructViewAvailable()
```
  Checks whether structure view for current page is available
  
  Returns:
  
  true it so otherwise false
- isAssignedToPage
```
public boolean isAssignedToPage(ContentSlotModel contentSlot)
```
  Checks whether this content slot belongs to page
  Note:
  
  Parameters:
  
  contentSlot - given content slot
  
  Returns:
  
  true if so otherwise false
- updateItems
```
public void updateItems()
```
  Specified by:
  
  updateItems in interface BrowserModel
  
  Overrides:
  
  updateItems in class AbstractSectionBrowserModel
- getExtendedLabel
```
public String getExtendedLabel()
```
  Specified by:
  
  getExtendedLabel in interface BrowserModel
  
  Overrides:
  
  getExtendedLabel in class AbstractBrowserModel
- deleteCurrentPage
```
public void deleteCurrentPage()
```
  Deletes current page
  Note:
- getTypeService
```
protected TypeService getTypeService()
```
- getContentEditorSection
```
public ContentEditorBrowserSectionModel getContentEditorSection()
```
- clearSelection
```
public void clearSelection(ListBrowserSectionModel browserSectionModel)
```
  Responsible for clearing selection in all sections after change it
  
  Parameters:
  
  browserSectionModel - - current section model (that fires change selection event)
- getLabel
```
public String getLabel()
```
  Specified by:
  
  getLabel in interface BrowserModel
  
  Overrides:
  
  getLabel in class AbstractBrowserModel
- createAndInitializeDrilldownView
```
public void createAndInitializeDrilldownView()
```
  Creates and initialize a drilldown view
  Note:
- createAndInitializeFlatOrStructureView
```
public void createAndInitializeFlatOrStructureView()
```
  Creates and initialize flat and structure view
  Note: Creates only a model for particular view type and this is why this method is valid for both kind of view (flat, structure)
- getAdditableType
```
public List<ObjectType> getAdditableType()
```
- getActiveSite
```
public CMSSiteModel getActiveSite()
```
  Returns current selected site
  Note:
  
  Returns:
  
  current selected site
- getActiveCatalogVersion
```
public CatalogVersionModel getActiveCatalogVersion()
```
- createAndInitContentSlotSection
```
protected ListBrowserSectionModel createAndInitContentSlotSection()
```
  Creates and initialize content slot section model
  Note:
  
  Returns:
  
  content slot section model
- createAndInitContentElementSection
```
protected ListBrowserSectionModel createAndInitContentElementSection(ListBrowserSectionModel contentSlotSection)
```
  Creates and initialize content element section model
  Note:
  
  Parameters:
  
  contentSlotSection - parent section
  
  Returns:
  
  content element section model
- createAndInitSimpleElementSection
```
protected ListBrowserSectionModel createAndInitSimpleElementSection(ListBrowserSectionModel contentElementSection)
```
  Creates and initialize simple element section model
  Note:
  
  Parameters:
  
  contentElementSection - parent section
  
  Returns:
  
  simple element section model
- createAndInitContentEditorSection
```
protected ContentEditorBrowserSectionModel createAndInitContentEditorSection(ListBrowserSectionModel simpleElementSection,
                                                                             ListBrowserSectionModel contentElementSection)
```
  Creates and initialize content editor section model
  Note:
  
  Parameters:
  
  simpleElementSection - parent section model (exclusive with contentElementSection)
  
  contentElementSection - (exclusive with simpleElementSection) parent section model
  
  Returns:
  
  content editor section
- createContentElementEditorSection
```
protected ContentEditorBrowserSectionModel createContentElementEditorSection()
```
- getCurrentCmsPage
```
protected AbstractPageModel getCurrentCmsPage()
```
- retriveSectionModelByContentSlot
```
public BrowserSectionModel retriveSectionModelByContentSlot(String position)
```
- contentSlotDefined
```
@Deprecated
public TypedObject contentSlotDefined(ContentSlotNameModel potentateContetSlot)
```
  Deprecated.
- getGenericRandomNameProducer
```
public GenericRandomNameProducer getGenericRandomNameProducer()
```
- createProperViewModel
```
protected void createProperViewModel()
```
- onCockpitEvent
```
public void onCockpitEvent(CockpitEvent event)
```
  Specified by:
  
  onCockpitEvent in interface CockpitEventAcceptor
- addToAdditionalItemChangeUpdateNotificationMap
```
public void addToAdditionalItemChangeUpdateNotificationMap(TypedObject itemToUpdate,
                                                           Collection<TypedObject> changedItems)
```
- getAdditionalItemsToUpdate
```
public Collection<TypedObject> getAdditionalItemsToUpdate(TypedObject changedItem)
```
- onClose
```
public void onClose()
```
  Description copied from class: AbstractBrowserModel
  
  Called before this browser is closed.
  
  Overrides:
  
  onClose in class AbstractBrowserModel
- getSectionModelListenerForDrilldownView
```
public SectionModelListener getSectionModelListenerForDrilldownView()
```
- isBackButtonVisible
```
public boolean isBackButtonVisible()
```

Class CmsPageBrowserModel

Field Summary

Fields inherited from class de.hybris.platform.cockpit.session.impl.AbstractAdvancedBrowserModel

Fields inherited from class de.hybris.platform.cockpit.session.impl.AbstractBrowserModel

Constructor Summary

Method Summary

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractSectionBrowserModel

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractAdvancedBrowserModel

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractBrowserModel

Methods inherited from class java.lang.Object

Methods inherited from interface de.hybris.platform.cockpit.session.AdvancedBrowserModel

Methods inherited from interface de.hybris.platform.cockpit.session.BrowserModel

Field Detail

cmsAdminSiteService

cmsCockpitService

modelService

cmsAdminComponentService

cmsAdminContentSlotService

updateNotificationMap

Constructor Detail

CmsPageBrowserModel

Method Detail

getAllPagesWithSameLabelOrType

getAvailableViewModes

clone

newCmsPageBrowserModel

newCmsPageMainAreaEditComponentFactory

newCmsPageMainAreaPreviewComponentFactory

newCmsPageMainAreaPersonalizeComponentFactory

createViewComponent

initialize

setArea

setCurrentPageObject

getCurrentPageObject

getContentSlotSection

getContentElementSection

getSimpleElementSection

getContentSlotsForCurrentPage

getMissingSlotsForCurrentPage

getAvailableSlotsForCurrentPage

createSlotContentForCurrentPage

createContentSlotForPage

getContentaSlotAtPositionForPage

computeReadableName

removeComponentFromSlot

deleteSlotContentForCurrentPage

isStructViewAvailable

isAssignedToPage

updateItems

getExtendedLabel

deleteCurrentPage

getTypeService

getContentEditorSection

clearSelection

getLabel

createAndInitializeDrilldownView

createAndInitializeFlatOrStructureView

getAdditableType

getActiveSite

getActiveCatalogVersion

createAndInitContentSlotSection

createAndInitContentElementSection

createAndInitSimpleElementSection

createAndInitContentEditorSection

createContentElementEditorSection

getCurrentCmsPage

retriveSectionModelByContentSlot

contentSlotDefined

getGenericRandomNameProducer

createProperViewModel

onCockpitEvent

addToAdditionalItemChangeUpdateNotificationMap

getAdditionalItemsToUpdate

onClose

getSectionModelListenerForDrilldownView

isBackButtonVisible