External Flyer
An external flyer is a flyer that is designed to display external component in its content. The content of the flyer should be provided by the external flyer developer. The flyer component is constructed automatically and the content is revealed inside.
In the following figure you can see an external flyer containing Simple External Box content.
In the following figure you can see an external flyer containing Advanced External Box content.
To add an external flyer into the application you need:
- to declare your flyer in the Layout XML File
- a developed external component used as flyer’s content
Packaging and Deploying the Component
The external components (boxes) used within the external flyer content have to be previously packaged and deployed.
Running the New Component
The external flyer is configured through external flyer section in Layout XML File. The external flyers definitions could be part of the home page, configuration pages or summary page. The definition is made by <externalFlyer> tag. Once the flyer is configured an OPEN_FLYER action should be added that references the defined external flyer by its name. The name of the flyer should be unique within the page.
The external flyer can also be opened via an OPEN_FLYER action from a productListBox in a Catalog. The definition of the externalFlyer in the layout of the Catalog is then the same as the one described below.
<actionBox mode="on" cssName="otherActionsActionBox" hzAlignment="left"
vtAlignment="up" widthPercent="20" heightPercent="100" autosize="off">
<action
actionName="OPEN_FLYER(flyerName=config.externalFlyer)"
alignment="left" resourceName="action.otherActions"
translationName="action.otherActions" url="" />
</actionBox>
<externalFlyer name="config.externalFlyer" mode="on" tileName=".extSelct"
flyerCssName="externalFlyer" cssName="vtExtSel" hzPosition="center"
vtPosition="middle" hzSize="300" vtSize="130"
titleResourceName="action.openExternalFlyer"
titleTranslationName="externalFlyer.title">
<param name="imgPreviousOn" value="vtExtlSel.previousOn"/>
<param name="imgPreviousOff" value="vtExtlSel.previousOff"/>
<param name="imgNextOn" value="vtExtlSel.nextOn"/>
<param name="imgNextOff" value="vtExtlSel.nextOff"/>
<param name="titleTranslationName" value="vtExtlSel.title"/>
<param name="titleTranslationTotalNum" value="vtExtlSel.totalNumDescr"/>
</externalFlyer>
External flyer’s attributes:
- name – identifier of the flyer, which should be unique within the page flyer names
- tileName – the name of the tile definition that will be included as external flyer’s content
- mode – shows whether the flyer definition is on or off.
- flyerCssName – an identifier of the CSS file used by the flyer component
- cssName – an identifier of the CSS file used by the content of the flyer(external component CSS file)
- hzPosition – gives the horizontal position of the flyer in the screen (left|center|right)
- vtPosition – gives the vertical position of the flyer in the screen (up|middle|down)
- hzSize – gives in pixels the horizontal size of the flyer
- vtSize – gives in pixels the vertical size of the flyer
- tileTranslationName – identifier of the translation used to give the title of the box
- tileResourceName – identifier of the resource to be displayed in the title of the box
External flyer’s parameters - name/value pairs used by the external flyer content.