public interface LayoutService
| 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.
|
AttributePlaceholderModel createAttributePlaceholder(PlaceholderTemplateModel template, String qualifier, List<AttributeDescriptorModel> attributePath)
template - the enclosing templatequalifier - the qualifierattributePath - the attribute descriptor pathClassificationAttributePlaceholderModel createClassificationAttributePlaceholder(PlaceholderTemplateModel template, String qualifier, ClassAttributeAssignmentModel assignment)
template - the enclosing templatequalifier - TODOassignment - the class-attribute assignmentExpressionPlaceholderModel createExpressionPlaceholder(PlaceholderTemplateModel template, String qualifer)
template - the enclosing placeholder templatequalifer - the qualifierPlaceholderTemplateModel createPlaceholderTemplate(CometConfigurationModel cfg, String type, String code)
cfg - the enclosing comet configurationtype - the associated composed typecode - the codeList<CometConfigurationModel> getAllCometConfigurations()
List<MediaModel> getAlternativeMedias(PlaceholderTemplateModel placeholderTemplate, ItemModel item)
List<HybrisEnumValue> getAvailableGridModes()
List<HybrisEnumValue> getAvailablePlacementModes()
List<GridModel> getAvailableGrids(CometConfigurationModel cfg)
cfg - the comet configurationList<LayoutTemplateModel> getAvailableLayoutTemplates(CometConfigurationModel cfg, String type)
cfg - the comet configurationtype - the type to matchList<LayoutTemplateModel> getAvailableLayoutTemplates(PlaceholderTemplateModel placeholderTemplate)
placeholderTemplate - the placeholderTemplate to matchList<MasterPageModel> getAvailableMasterPages(String type)
type - the type to match.List<HybrisEnumValue> getAvailablePageAlignments()
List<PageFormatModel> getAvailablePageFormats()
List<HybrisEnumValue> getAvailablePageStates()
List<HybrisEnumValue> getAvailablePageTypes()
List<PlaceholderTemplateModel> getAvailablePlaceholderTemplates(CometConfigurationModel cfg, String type)
cfg - the comet configurationtype - the type to matchCollection<HybrisEnumValue> getAvailablePlaceholderTypes()
PlaceholderModel.getPlaceholderType().Collection<HybrisEnumValue> getAvailablePlaceholderValueTypes()
LayoutTemplateModel getDefaultLayoutTemplate(PageModel pageModel, PlaceholderTemplateModel placeholderTemplate, PlacementModel placement, ItemModel placedItem, SpreadPosition gridType)
pageModel - placeholderTemplate - placement - placedItem - gridType - PlaceholderTemplateModel getDefaultPlaceholderTemplate(PageModel pageModel, PlacementModel placement, ItemModel placementItem)
placement - the placement to place the item intoplacementItem - the placed itemHybrisEnumValue getDefaultPlaceholderType()
HybrisEnumValue getDefaultPlaceholderType(AttributeDescriptorModel attribute)
HybrisEnumValue getDefaultPlaceholderType(ClassAttributeAssignmentModel assignmnet)
HybrisEnumValue getDefaultPlaceholderValueType()
HybrisEnumValue getDefaultPlaceholderValueType(AttributeDescriptorModel attribute)
HybrisEnumValue getDefaultPlaceholderValueType(ClassAttributeAssignmentModel assignmnet)
String getDisplayName(PlacementModel placement)
GridModel getGrid(CometConfigurationModel cfg, int id)
String getPlaceholderSource(PlaceholderModel placeHolder)
Map<String,String> getPlaceholderValue(PlaceholderTemplateModel template, ItemModel item)
template - the placeholder template to get values foritem - the item to read values fromString getPreview(PlacementModel placement)
List<LayoutTemplateModel> getUnassignedLayoutTemplates(CometConfigurationModel cfg)
cfg - Object getValue(PlaceholderModel placeholder, PlacementModel placement)
placeholder - the placeholder which describes the valueplacement - the placement which holds the data itemint[] getPageDimensions(PageModel pageModel)
Copyright © 2017 SAP SE. All Rights Reserved.