de.hybris.platform.printcockpit.model.layout

Interface LayoutService

All Known Implementing Classes:

LayoutServiceImpl

public interface LayoutService

Method Summary

Modifier and Type	Method and Description
AttributePlaceholderModel	createAttributePlaceholder(PlaceholderTemplateModel template, String qualifier, List<AttributeDescriptorModel> attributePath) Creates a new attribute placeholder.
ClassificationAttributePlaceholderModel	createClassificationAttributePlaceholder(PlaceholderTemplateModel template, String qualifier, ClassAttributeAssignmentModel assignment) Creates a new classification attribute placeholder.
ExpressionPlaceholderModel	createExpressionPlaceholder(PlaceholderTemplateModel template, String qualifer) Creates a new expression placeholder.
PlaceholderTemplateModel	createPlaceholderTemplate(CometConfigurationModel cfg, String type, String code) Creates a new placeholder template.
List<CometConfigurationModel>	getAllCometConfigurations() Finds all comet configurations.
List<MediaModel>	getAlternativeMedias(PlaceholderTemplateModel placeholderTemplate, ItemModel item)
List<HybrisEnumValue>	getAvailableGridModes() Returns all grid mode enums.
List<GridModel>	getAvailableGrids(CometConfigurationModel cfg) Finds all grids within a specified comet configuration.
List<LayoutTemplateModel>	getAvailableLayoutTemplates(CometConfigurationModel cfg, String type) Finds all layout templates applicable to a given type within a specified comet configuration.
List<LayoutTemplateModel>	getAvailableLayoutTemplates(PlaceholderTemplateModel placeholderTemplate) Finds all layout templates applicable to a given PlaceholderTemplate.
List<MasterPageModel>	getAvailableMasterPages(String type) Finds all master pages applicable to a given type.
List<HybrisEnumValue>	getAvailablePageAlignments() Returns all page alignment enums.
List<PageFormatModel>	getAvailablePageFormats() Returns all page formats available within the system.
List<HybrisEnumValue>	getAvailablePageStates() Returns all page states enums.
List<HybrisEnumValue>	getAvailablePageTypes() Returns all page type enums.
List<PlaceholderTemplateModel>	getAvailablePlaceholderTemplates(CometConfigurationModel cfg, String type) Finds all placeholder templates applicable to a given type within a specified comet configuration.
Collection<HybrisEnumValue>	getAvailablePlaceholderTypes() Returns all available placeholder types for PlaceholderModel.getPlaceholderType().
Collection<HybrisEnumValue>	getAvailablePlaceholderValueTypes() Returns all available placeholder value types
List<HybrisEnumValue>	getAvailablePlacementModes()
LayoutTemplateModel	getDefaultLayoutTemplate(PageModel pageModel, PlaceholderTemplateModel placeholderTemplate, PlacementModel placement, ItemModel placedItem, SpreadPosition gridType) Determines the default layout template for a given placeholder template, placement and/or placed item.
PlaceholderTemplateModel	getDefaultPlaceholderTemplate(PageModel pageModel, PlacementModel placement, ItemModel placementItem) Determines the default placeholder template for a given placement and placed item.
HybrisEnumValue	getDefaultPlaceholderType() Returns the default placeholder type when creating a new (unspecified) placeholder.
HybrisEnumValue	getDefaultPlaceholderType(AttributeDescriptorModel attribute) Returns the default placeholder type when creating a new attribute placeholder.
HybrisEnumValue	getDefaultPlaceholderType(ClassAttributeAssignmentModel assignmnet) Returns the default placeholder type when creating a new classification attribute placeholder.
HybrisEnumValue	getDefaultPlaceholderValueType() Returns the default placeholder value type when creating a new (unspecified) placeholder.
HybrisEnumValue	getDefaultPlaceholderValueType(AttributeDescriptorModel attribute) Returns the default placeholder value type when creating a new attribute placeholder.
HybrisEnumValue	getDefaultPlaceholderValueType(ClassAttributeAssignmentModel assignmnet) Returns the default placeholder type when creating a new classification attribute placeholder.
String	getDisplayName(PlacementModel placement) Calculates the dynamic display name of the given placement.
GridModel	getGrid(CometConfigurationModel cfg, int id) Fetches a grid by its id.
int[]	getPageDimensions(PageModel pageModel) Compute width and height only once for all images
String	getPlaceholderSource(PlaceholderModel placeHolder)
Map<String,String>	getPlaceholderValue(PlaceholderTemplateModel template, ItemModel item) Calculates all placeholder values for a placeholder template applied to a item.
String	getPreview(PlacementModel placement) Calculates the dynamic preview for the given placement.
List<LayoutTemplateModel>	getUnassignedLayoutTemplates(CometConfigurationModel cfg) Finds all layout templates which haven't been assigned to any placeholder template yet.
Object	getValue(PlaceholderModel placeholder, PlacementModel placement) Calculates the actual value for a given placeholder applied to a placement.

Method Detail

createAttributePlaceholder

AttributePlaceholderModel createAttributePlaceholder(PlaceholderTemplateModel template,
                                                     String qualifier,
                                                     List<AttributeDescriptorModel> attributePath)

Creates a new attribute placeholder. This instance exist in memory only and must be saved together with its template!

Parameters:

template - the enclosing template

qualifier - the qualifier

attributePath - the attribute descriptor path

createClassificationAttributePlaceholder

ClassificationAttributePlaceholderModel createClassificationAttributePlaceholder(PlaceholderTemplateModel template,
                                                                                 String qualifier,
                                                                                 ClassAttributeAssignmentModel assignment)

Creates a new classification attribute placeholder. This instance exist in memory only and must be saved together with its template!

Parameters:

template - the enclosing template

qualifier - TODO

assignment - the class-attribute assignment

createExpressionPlaceholder

ExpressionPlaceholderModel createExpressionPlaceholder(PlaceholderTemplateModel template,
                                                       String qualifer)

Creates a new expression placeholder. This instance exist in memory only and must be saved together with its template!

Parameters:

template - the enclosing placeholder template

qualifer - the qualifier

createPlaceholderTemplate

PlaceholderTemplateModel createPlaceholderTemplate(CometConfigurationModel cfg,
                                                   String type,
                                                   String code)

Creates a new placeholder template. This instance exist in memory only and must be saved explicitly!

Parameters:

cfg - the enclosing comet configuration

type - the associated composed type

code - the code

getAllCometConfigurations

List<CometConfigurationModel> getAllCometConfigurations()

Finds all comet configurations.

getAlternativeMedias

List<MediaModel> getAlternativeMedias(PlaceholderTemplateModel placeholderTemplate,
                                      ItemModel item)

getAvailableGridModes

List<HybrisEnumValue> getAvailableGridModes()

Returns all grid mode enums.

getAvailablePlacementModes

List<HybrisEnumValue> getAvailablePlacementModes()

Returns:

all possible placement mode enums for page

getAvailableGrids

List<GridModel> getAvailableGrids(CometConfigurationModel cfg)

Finds all grids within a specified comet configuration.

Parameters:

cfg - the comet configuration

getAvailableLayoutTemplates

List<LayoutTemplateModel> getAvailableLayoutTemplates(CometConfigurationModel cfg,
                                                      String type)

Finds all layout templates applicable to a given type within a specified comet configuration.

Parameters:

cfg - the comet configuration

type - the type to match

getAvailableLayoutTemplates

List<LayoutTemplateModel> getAvailableLayoutTemplates(PlaceholderTemplateModel placeholderTemplate)

Finds all layout templates applicable to a given PlaceholderTemplate.

Parameters:

placeholderTemplate - the placeholderTemplate to match

getAvailableMasterPages

List<MasterPageModel> getAvailableMasterPages(String type)

Finds all master pages applicable to a given type.

Parameters:

type - the type to match.

getAvailablePageAlignments

List<HybrisEnumValue> getAvailablePageAlignments()

Returns all page alignment enums.

getAvailablePageFormats

List<PageFormatModel> getAvailablePageFormats()

Returns all page formats available within the system.

getAvailablePageStates

List<HybrisEnumValue> getAvailablePageStates()

Returns all page states enums.

getAvailablePageTypes

List<HybrisEnumValue> getAvailablePageTypes()

Returns all page type enums.

getAvailablePlaceholderTemplates

List<PlaceholderTemplateModel> getAvailablePlaceholderTemplates(CometConfigurationModel cfg,
                                                                String type)

Finds all placeholder templates applicable to a given type within a specified comet configuration.

Parameters:

cfg - the comet configuration

type - the type to match

getAvailablePlaceholderTypes

Collection<HybrisEnumValue> getAvailablePlaceholderTypes()

Returns all available placeholder types for PlaceholderModel.getPlaceholderType().

getAvailablePlaceholderValueTypes

Collection<HybrisEnumValue> getAvailablePlaceholderValueTypes()

Returns all available placeholder value types

getDefaultLayoutTemplate

LayoutTemplateModel getDefaultLayoutTemplate(PageModel pageModel,
                                             PlaceholderTemplateModel placeholderTemplate,
                                             PlacementModel placement,
                                             ItemModel placedItem,
                                             SpreadPosition gridType)

Determines the default layout template for a given placeholder template, placement and/or placed item.

Parameters:

pageModel -

placeholderTemplate -

placement -

placedItem -

gridType -

getDefaultPlaceholderTemplate

PlaceholderTemplateModel getDefaultPlaceholderTemplate(PageModel pageModel,
                                                       PlacementModel placement,
                                                       ItemModel placementItem)

Determines the default placeholder template for a given placement and placed item.

Parameters:

placement - the placement to place the item into

placementItem - the placed item

getDefaultPlaceholderType

HybrisEnumValue getDefaultPlaceholderType()

Returns the default placeholder type when creating a new (unspecified) placeholder.

getDefaultPlaceholderType

HybrisEnumValue getDefaultPlaceholderType(AttributeDescriptorModel attribute)

Returns the default placeholder type when creating a new attribute placeholder.

getDefaultPlaceholderType

HybrisEnumValue getDefaultPlaceholderType(ClassAttributeAssignmentModel assignmnet)

Returns the default placeholder type when creating a new classification attribute placeholder.

getDefaultPlaceholderValueType

HybrisEnumValue getDefaultPlaceholderValueType()

Returns the default placeholder value type when creating a new (unspecified) placeholder.

getDefaultPlaceholderValueType

HybrisEnumValue getDefaultPlaceholderValueType(AttributeDescriptorModel attribute)

Returns the default placeholder value type when creating a new attribute placeholder.

getDefaultPlaceholderValueType

HybrisEnumValue getDefaultPlaceholderValueType(ClassAttributeAssignmentModel assignmnet)

Returns the default placeholder type when creating a new classification attribute placeholder.

getDisplayName

String getDisplayName(PlacementModel placement)

Calculates the dynamic display name of the given placement.

getGrid

GridModel getGrid(CometConfigurationModel cfg,
                  int id)

Fetches a grid by its id.

getPlaceholderSource

String getPlaceholderSource(PlaceholderModel placeHolder)

getPlaceholderValue

Map<String,String> getPlaceholderValue(PlaceholderTemplateModel template,
                                       ItemModel item)

Calculates all placeholder values for a placeholder template applied to a item.

Parameters:

template - the placeholder template to get values for

item - the item to read values from

getPreview

String getPreview(PlacementModel placement)

Calculates the dynamic preview for the given placement.

Returns:

the preview hmtl text

getUnassignedLayoutTemplates

List<LayoutTemplateModel> getUnassignedLayoutTemplates(CometConfigurationModel cfg)

Finds all layout templates which haven't been assigned to any placeholder template yet.

Parameters:

cfg -

getValue

Object getValue(PlaceholderModel placeholder,
                PlacementModel placement)

Calculates the actual value for a given placeholder applied to a placement.

Parameters:

placeholder - the placeholder which describes the value

placement - the placement which holds the data item

getPageDimensions

int[] getPageDimensions(PageModel pageModel)

Compute width and height only once for all images

Returns:

page width and height [px,px]