com.foreach.across.modules.webcms.domain.component.container

Class ContainerWebCmsComponentModel

java.lang.Object

com.foreach.across.modules.webcms.domain.component.model.WebCmsComponentModel

com.foreach.across.modules.webcms.domain.component.container.ContainerWebCmsComponentModel

All Implemented Interfaces:

com.foreach.across.modules.web.ui.ViewElement, WebCmsDomainBound, WebCmsObject

public class ContainerWebCmsComponentModel
extends WebCmsComponentModel

Represents a collection of other WebCmsComponentModels.

Since:

0.0.1

Author:

Arne Vandamme

Nested Class Summary

Nested classes/interfaces inherited from interface com.foreach.across.modules.web.ui.ViewElement

com.foreach.across.modules.web.ui.ViewElement.Wither<T extends com.foreach.across.modules.web.ui.ViewElement>, com.foreach.across.modules.web.ui.ViewElement.WitherGetter<T extends com.foreach.across.modules.web.ui.ViewElement,U>, com.foreach.across.modules.web.ui.ViewElement.WitherRemover<T extends com.foreach.across.modules.web.ui.ViewElement>, com.foreach.across.modules.web.ui.ViewElement.WitherSetter<T extends com.foreach.across.modules.web.ui.ViewElement>

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUPPORTS_MARKUP_ATTRIBUTE If the WebCmsComponentType has this attribute set to true then markup on the container will be used for rendering if it is set.
static String	TYPE_DYNAMIC
static String	TYPE_FIXED

Fields inherited from class com.foreach.across.modules.webcms.domain.component.model.WebCmsComponentModel

METADATA_CLASS_ATTRIBUTE, TEMPLATE_ATTRIBUTE, TYPE_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
	ContainerWebCmsComponentModel(WebCmsComponent component)
	ContainerWebCmsComponentModel(WebCmsComponent component, Collection<WebCmsComponentModel> components)
protected	ContainerWebCmsComponentModel(WebCmsComponentModel template)
	ContainerWebCmsComponentModel(WebCmsComponentType containerType)

Method Summary

Modifier and Type	Method and Description
void	addMember(WebCmsComponentModel componentModel) Add a member to the list.
ContainerWebCmsComponentModel	asComponentTemplate() Convert the current model to a templated version: keep all properties but create a new backing component.
WebCmsComponentModel	getMember(@NonNull String name)
<U extends WebCmsComponentModel> U	getMember(String name, @NonNull Class<U> expectedType)
boolean	hasMarkup() You can always set markup on the container but the value of isMarkupSupported() will determine if it will be used for rendering or not.
boolean	isEmpty() Base implementation that can be used to check if the component contains any relevant data.
boolean	isFixed()
boolean	isMarkupSupported()
int	size()

Methods inherited from class com.foreach.across.modules.webcms.domain.component.model.WebCmsComponentModel

cloneMetadata, equals, getComponentType, getCustomTemplate, getDomain, getElementType, getMetadata, getName, getObjectId, getOwnerObjectId, getSortIndex, getTitle, hashCode, hasMetadata, hasOwner, isNew, setComponent, setDomain, setName, setObjectId, setOwner, setOwnerObjectId, setSortIndex, setTitle, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.foreach.across.modules.web.ui.ViewElement

get, matches, predicateFor, remove, set, with

Methods inherited from interface com.foreach.across.modules.webcms.domain.WebCmsObject

forObjectId

Field Detail

TYPE_DYNAMIC

public static final String TYPE_DYNAMIC

See Also:

Constant Field Values

TYPE_FIXED

public static final String TYPE_FIXED

See Also:

Constant Field Values

SUPPORTS_MARKUP_ATTRIBUTE

public static final String SUPPORTS_MARKUP_ATTRIBUTE

If the WebCmsComponentType has this attribute set to true then markup on the container will be used for rendering if it is set.

See Also:

Constant Field Values

Constructor Detail

ContainerWebCmsComponentModel

public ContainerWebCmsComponentModel(WebCmsComponentType containerType)

ContainerWebCmsComponentModel

public ContainerWebCmsComponentModel(WebCmsComponent component,
                                     Collection<WebCmsComponentModel> components)

ContainerWebCmsComponentModel

public ContainerWebCmsComponentModel(WebCmsComponent component)

ContainerWebCmsComponentModel

protected ContainerWebCmsComponentModel(WebCmsComponentModel template)

Method Detail

addMember

public void addMember(WebCmsComponentModel componentModel)

Add a member to the list.

Parameters:

componentModel - new member

getMember

public <U extends WebCmsComponentModel> U getMember(String name,
                                                    @NonNull
                                                    @NonNull Class<U> expectedType)

Parameters:

name - of the component

expectedType - to coerce to

Returns:

member with the given name or null if not found

getMember

public WebCmsComponentModel getMember(@NonNull
                                      @NonNull String name)

Parameters:

name - of the component

Returns:

member with the given name or null if not found

size

public int size()

Returns:

number of members in this container

isEmpty

public boolean isEmpty()

Description copied from class: WebCmsComponentModel

Base implementation that can be used to check if the component contains any relevant data.

Specified by:

isEmpty in class WebCmsComponentModel

Returns:

true if container has no members

isFixed

public boolean isFixed()

Returns:

true if the container does not allow dynamic adding/sorting of members

hasMarkup

public boolean hasMarkup()

You can always set markup on the container but the value of isMarkupSupported() will determine if it will be used for rendering or not. This method simply indicates if markup has been set.

Returns:

true if markup is set on this container

isMarkupSupported

public boolean isMarkupSupported()

Returns:

true if the container supports markup for rendering - this is determined by the component type

See Also:

SUPPORTS_MARKUP_ATTRIBUTE

asComponentTemplate

public ContainerWebCmsComponentModel asComponentTemplate()

Description copied from class: WebCmsComponentModel

Convert the current model to a templated version: keep all properties but create a new backing component.

Specified by:

asComponentTemplate in class WebCmsComponentModel

Returns:

templated version of this model - attached to a new backing component

See Also:

WebCmsComponent.asTemplate(), WebCmsComponentModel.cloneMetadata(WebCmsComponentModel)