com.fatwire.assetapi.fragment

Interface ElementFragment<T extends ElementFragment<T>>

Type Parameters:

T - type parameter for the element fragment implementation.

All Superinterfaces:

Fragment

@Exported
public interface ElementFragment<T extends ElementFragment<T>>
extends Fragment

Represents a fragment that invokes an element. To render an asset using a element, it is required to know the element name using which the asset is to be rendered. Hence, a element fragment instance can be minimally built as:

ElementFragment<?> fragment = FragmentFactory.newElementFragment().useElement("HomePage")

There are multiple ways arguments may be set into the fragment:

• as a name-value pair using ElementFragment.addArgument(String, String)
• as a list of lookup argument names to be looked up from the page context, using ElementFragment.useArguments(String, String...)

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	addArgument(String name, String value) Adds a name-value pair as an argument.
T	scopeAs(Fragment.Scope scope) Sets the manner in which variables in the calling element are available to the called element, and vice versa.
T	useArguments(String variable, String... more) Sets Sites variables as arguments.
T	useElement(String elementName) Sets the element name used by this fragment.

Method Detail

useElement

T useElement(String elementName)

Sets the element name used by this fragment.

Parameters:

elementName - the name of the element used by this fragment.

Returns:

a handle to this builder

useArguments

T useArguments(String variable,
               String... more)

Sets Sites variables as arguments.

Parameters:

variable - a Site variable to add as argument

more - optional more Site variables to add as arguments

Returns:

a handle to this builder

addArgument

T addArgument(String name,
              String value)

Adds a name-value pair as an argument.

Parameters:

name - the name for the argument

value - the value for the argument.

Returns:

a handle to this builder

scopeAs

T scopeAs(Fragment.Scope scope)

Sets the manner in which variables in the calling element are available to the called element, and vice versa. Default value: Fragment.Scope.LOCAL

Parameters:

scope - the scope for the invoking element variables.

Returns:

a handle to this builder

See Also:

Scope