com.fatwire.assetapi.fragment

Interface EditableTemplateFragment<T extends EditableTemplateFragment<T>>

Type Parameters:

T - type parameter for the template fragment implementation

All Superinterfaces:

Fragment, TemplateFragment<T>

@Exported
public interface EditableTemplateFragment<T extends EditableTemplateFragment<T>>
extends TemplateFragment<T>

Represents a fragment that invokes a template in editable mode. This type of fragments behave similar to the TemplateFragment, and has some additional behavior which are necessary for its editable nature. An editable template fragment instance can be minimally built as:

 EditableTemplateFragment<?> fragment = FragmentFactory.newEditableTemplateFragment()
                .useTemplate("/HomePage")
                .forAsset("MyAssetType", "1934567890")
 

The editable fragment supports editing an asset which is different from the asset specified using TemplateFragment.forAsset(String, String). This is possible by using the EditableTemplateFragment.editAsset(String, String, String) method. However, if the asset is not specified (when EditableTemplateFragment.editField(String) is used instead), then the asset used by the fragment (whether specified using TemplateFragment.forAsset(String, String) or looked up from the page context) is the asset to be edited. The field of an editable asset has to be an asset reference field:

• a flex attribute of type asset
• an asset association. In this case, the expected syntax is Association-named:nameOfAssociation
• a flex parent asset field. In this case, the expected syntax is Group_nameOfParentDefinition
• ManualRecs, if the edited asset is a static recommendation

The context is determined by a Sites variable called context, which is automatically managed by Sites, i.e. every fragment updates the current context by appending:

• the parent context
• the asset being rendered and the template used to render it, as a string of the form <c>:<cid>:<tname>

(they are separated by a semicolon).

Note: the context variable is initially empty, and must be properly initialized in layout templates. For example:

 <ics:setvar name="context" value='<%=ics.GetVar("c") + ":" + ics.GetVar("cid") + ":SectionLayout"%>' />

If context is set to a constant: fragment.forContext("Global"), the slot shows the same presentation data across all web pages using the fragment.

Nested Class Summary

Nested classes/interfaces inherited from interface com.fatwire.assetapi.fragment.Fragment

Fragment.Scope, Fragment.Style

Method Summary

Modifier and Type	Method and Description
T	addButtons(String button, String... more) Sets buttons to show on the insite overlay.
T	addEditorRoles(String role, String... more) Sets roles allowed to modify slot presentation.
T	addLegalTypes(String type, String... more) Sets asset types which are allowed to be dropped in this slot.
T	editAsset(AssetId assetId, String field) Sets the field of the specified asset to edit.
T	editAsset(AssetId assetId, String field, int index) Sets the field of the specified asset to edit.
T	editAsset(String assetType, Long assetId, String field) Sets the field of the specified asset to edit.
T	editAsset(String assetType, Long assetId, String field, int index) Sets the field of the specified asset to edit.
T	editAsset(String assetType, String assetId, String field) Sets the field of the specified asset to edit.
T	editAsset(String assetType, String assetId, String field, int index) Sets the field of the specified asset to edit.
T	editField(String field) Sets the field of the asset specified by TemplateFragment.forAsset(String, String) to edit.
T	editField(String field, int index) Sets the index of the specified multi-valued field of the asset specified by TemplateFragment.forAsset(String, String) to edit.
T	forContext(String context) Sets the context to use for this fragment.
T	setEmptyText(String emptyText) Sets the text to be rendered inside empty slots.
T	setSlotname(String slotname) Sets (and hence enables) presentation-editing mode for the specified slot name.
T	setStyles(String styles) Sets additional CSS classes to add to the slot, whenever CSS rules need to be adjusted Note: This method does not validate the syntax for the CSS string.
T	setTitle(String title) Sets the slot title rendered in slot overlays.
T	setVariant(String variant) Sets the templates which can be selected as an alternative to the template specified using TemplateFragment.useTemplate(String).

Methods inherited from interface com.fatwire.assetapi.fragment.TemplateFragment

addArgument, forAsset, forAsset, forAsset, inSite, invokeFrom, resolveDevice, setArguments, useArguments, useDevice, useStyle, useTemplate

Method Detail

setEmptyText

T setEmptyText(String emptyText)

Sets the text to be rendered inside empty slots.

Parameters:

emptyText - the text to set

Returns:

a handle to this builder

setTitle

T setTitle(String title)

Sets the slot title rendered in slot overlays.

Parameters:

title - the title to set

Returns:

a handle to this builder

setStyles

T setStyles(String styles)

Sets additional CSS classes to add to the slot, whenever CSS rules need to be adjusted Note: This method does not validate the syntax for the CSS string.

Parameters:

styles - the CSS styles to set

Returns:

a handle to this builder

addButtons

T addButtons(String button,
             String... more)

Sets buttons to show on the insite overlay.

Parameters:

button - a button to show

more - optional more buttons to show.

Returns:

a handle to this builder

addEditorRoles

T addEditorRoles(String role,
                 String... more)

Sets roles allowed to modify slot presentation. For content editing, normal asset privileges apply.

Parameters:

role - a role to allow for modifying slot presentation

more - optional more roles to allow

Returns:

a handle to this builder

addLegalTypes

T addLegalTypes(String type,
                String... more)

Sets asset types which are allowed to be dropped in this slot. Subtypes can be specified as: assetType:subtype, or assetType:*

Parameters:

type - an asset type to be allowed

more - optional more asset types to allow

Returns:

a handle to this builder

editField

T editField(String field)

Sets the field of the asset specified by TemplateFragment.forAsset(String, String) to edit. The field has to be an asset reference field. Use this method for single-valued fields only. For multi-valued fields, use EditableTemplateFragment.editField(String, int)

Parameters:

field - the asset reference field

Returns:

a handle to this builder

editField

T editField(String field,
            int index)

Sets the index of the specified multi-valued field of the asset specified by TemplateFragment.forAsset(String, String) to edit. The field has to be an asset reference field. Use this method for multi-valued fields only. For single-valued fields, use EditableTemplateFragment.editField(String)

Parameters:

field - the asset reference field

index - the index in ordered sequence of values in the multi-valued field

Returns:

a handle to this builder

editAsset

T editAsset(String assetType,
            String assetId,
            String field)

Sets the field of the specified asset to edit. The field has to be an asset reference field. Use this method for single-valued fields only. For multi-valued fields, use EditableTemplateFragment.editAsset(String, String, String, int)

Parameters:

assetType - the type of the asset to edit

assetId - the id of the asset to edit

field - the asset reference field

Returns:

a handle to this builder

editAsset

T editAsset(String assetType,
            Long assetId,
            String field)

Sets the field of the specified asset to edit. The field has to be an asset reference field. Use this method for single-valued fields only. For multi-valued fields, use EditableTemplateFragment.editAsset(String, String, String, int)

Parameters:

assetType - the type of the asset to edit

assetId - the id of the asset to edit

field - the asset reference field

Returns:

a handle to this builder

editAsset

T editAsset(AssetId assetId,
            String field)

Sets the field of the specified asset to edit. The field has to be an asset reference field. Use this method for single-valued fields only. For multi-valued fields, use EditableTemplateFragment.editAsset(String, String, String, int)

Parameters:

assetId - the id of the asset to edit

field - the asset reference field

Returns:

a handle to this builder

editAsset

T editAsset(String assetType,
            String assetId,
            String field,
            int index)

Sets the field of the specified asset to edit. The field has to be an asset reference field. Use this method for multi-valued fields only. For single-valued fields, use EditableTemplateFragment.editField(String)

Parameters:

assetType - the type of the asset to edit

assetId - the id of the asset to edit

field - the asset reference field

index - the index in ordered sequence of values in the multi-valued field

Returns:

a handle to this builder

editAsset

T editAsset(String assetType,
            Long assetId,
            String field,
            int index)

Sets the field of the specified asset to edit. The field has to be an asset reference field. Use this method for multi-valued fields only. For single-valued fields, use EditableTemplateFragment.editField(String)

Parameters:

assetType - the type of the asset to edit

assetId - the id of the asset to edit

field - the asset reference field

index - the index in ordered sequence of values in the multi-valued field

Returns:

a handle to this builder

editAsset

T editAsset(AssetId assetId,
            String field,
            int index)

Sets the field of the specified asset to edit. The field has to be an asset reference field. Use this method for multi-valued fields only. For single-valued fields, use EditableTemplateFragment.editField(String)

Parameters:

assetId - the id of the asset to edit

field - the asset reference field

index - the index in ordered sequence of values in the multi-valued field

Returns:

a handle to this builder

setSlotname

T setSlotname(String slotname)

Sets (and hence enables) presentation-editing mode for the specified slot name. This attribute defines an identifier for the "slot" that is being filled with the template set using TemplateFragment.useTemplate(String). The slot name should be unique across all templates.

Parameters:

slotname - the slot name

Returns:

a handle to this builder

setVariant

T setVariant(String variant)

Sets the templates which can be selected as an alternative to the template specified using TemplateFragment.useTemplate(String). This restriction is allowed only when presentation editing mode is enabled (using EditableTemplateFragment.setSlotname(String)).

Parameters:

variant - the regular expression which specifies which templates can be selected

Returns:

a handle to this builder

forContext

T forContext(String context)

Sets the context to use for this fragment.

Parameters:

context - the context to set.

Returns:

a handle to this builder