| Modifier and Type | Method and Description |
|---|---|
protected WebCmsComponentModel |
WebCmsComponentImporter.createDto(WebCmsDataEntry data,
WebCmsComponentModel itemToUpdate,
WebCmsDataAction action,
Map<String,Object> dataValues) |
protected WebCmsComponentModel |
WebCmsComponentImporter.prepareForSaving(WebCmsComponentModel itemToBeSaved,
WebCmsDataEntry data)
Override if you want to post process an item before saving.
|
protected WebCmsComponentModel |
WebCmsComponentImporter.retrieveExistingInstance(WebCmsDataEntry data) |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
WebCmsComponentImporter.applyDataValues(Map<String,Object> values,
WebCmsComponentModel dto) |
protected WebCmsComponentModel |
WebCmsComponentImporter.createDto(WebCmsDataEntry data,
WebCmsComponentModel itemToUpdate,
WebCmsDataAction action,
Map<String,Object> dataValues) |
protected void |
WebCmsComponentImporter.deleteInstance(WebCmsComponentModel instance,
WebCmsDataEntry data) |
protected WebCmsComponentModel |
WebCmsComponentImporter.prepareForSaving(WebCmsComponentModel itemToBeSaved,
WebCmsDataEntry data)
Override if you want to post process an item before saving.
|
protected void |
WebCmsComponentImporter.saveDto(WebCmsComponentModel itemToSave,
WebCmsDataAction action,
WebCmsDataEntry data) |
protected void |
WebCmsComponentImporter.validate(WebCmsComponentModel itemToBeSaved,
org.springframework.validation.Errors errors) |
| Constructor and Description |
|---|
UnknownWebCmsComponentModelException(WebCmsComponentModel componentModel) |
| Modifier and Type | Class and Description |
|---|---|
class |
ContainerWebCmsComponentModel
Represents a collection of other
WebCmsComponentModels. |
| Modifier and Type | Method and Description |
|---|---|
<U extends WebCmsComponentModel> |
ContainerWebCmsComponentModel.getMember(String name,
@NonNull Class<U> expectedType) |
| Modifier and Type | Method and Description |
|---|---|
WebCmsComponentModel |
ContainerWebCmsComponentModel.getMember(@NonNull String name) |
| Modifier and Type | Method and Description |
|---|---|
void |
ContainerWebCmsComponentModel.addMember(WebCmsComponentModel componentModel)
Add a member to the list.
|
boolean |
ContainerWebCmsComponentModelAdminRenderer.supports(WebCmsComponentModel componentModel) |
boolean |
ContainerWebCmsComponentModelWriter.supports(WebCmsComponentModel componentModel) |
| Constructor and Description |
|---|
ContainerWebCmsComponentModel(WebCmsComponentModel template) |
| Constructor and Description |
|---|
ContainerWebCmsComponentModel(WebCmsComponent component,
Collection<WebCmsComponentModel> components) |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractWebCmsComponentModelReader<T extends WebCmsComponentModel>
Base class that builds the metadata for a
WebCmsComponentModel and supports component template. |
class |
AbstractWebCmsComponentModelWriter<T extends WebCmsComponentModel>
Base class with override-able methods for component model persistence.
|
interface |
WebCmsComponentModelReader<T extends WebCmsComponentModel> |
interface |
WebCmsComponentModelWriter<T extends WebCmsComponentModel> |
| Modifier and Type | Method and Description |
|---|---|
<U extends WebCmsComponentModel> |
WebCmsComponentModelService.buildModelForComponent(WebCmsComponent component,
Class<U> expectedType)
Build the
WebCmsComponentModel for a particular WebCmsComponent entity. |
<U extends WebCmsComponentModel> |
WebCmsComponentModelService.createComponentModel(String componentTypeKey,
Class<U> expectedType)
Create a new component model for a specific component type.
|
<U extends WebCmsComponentModel> |
WebCmsComponentModelService.createComponentModel(String componentTypeKey,
WebCmsDomain domain,
Class<U> expectedType)
Create a new component model for a specific component type on the specified domain.
|
<U extends WebCmsComponentModel> |
WebCmsComponentModelService.createComponentModel(WebCmsComponentType componentType,
Class<U> expectedType)
Create a new component model for a specific component type, on the current domain.
|
<U extends WebCmsComponentModel> |
WebCmsComponentModelService.getComponentModel(String objectId,
Class<U> expectedType)
Get the component model for a specific
WebCmsComponent identified by its object id. |
<U extends WebCmsComponentModel> |
WebCmsComponentModelService.getComponentModelByName(String componentName,
WebCmsObject owner,
Class<U> expectedType)
Get a single
WebCmsComponentModel by name. |
<U extends WebCmsComponentModel> |
WebCmsComponentModelService.getComponentModelByNameAndDomain(String componentName,
WebCmsObject owner,
WebCmsDomain domain,
Class<U> expectedType)
Get a single
WebCmsComponentModel for a specific owner by name and domain. |
| Modifier and Type | Method and Description |
|---|---|
abstract WebCmsComponentModel |
WebCmsComponentModel.asComponentTemplate()
Convert the current model to a templated version: keep all properties but create a new backing component.
|
WebCmsComponentModel |
WebCmsComponentModelService.buildModelForComponent(WebCmsComponent component)
Build the
WebCmsComponentModel for a particular WebCmsComponent entity. |
WebCmsComponentModel |
WebCmsComponentModelHierarchy.get(String componentName)
Get the component by name by traversing the entire hierarchy bottom up.
|
WebCmsComponentModel |
WebCmsComponentModelSet.get(String name)
Gets the component with that name.
|
WebCmsComponentModel |
WebCmsComponentModelHierarchy.get(String componentName,
boolean searchParentScopes)
Get the component by name and optionally traverse the hierarchy.
|
WebCmsComponentModel |
WebCmsComponentModelService.getComponentModel(String objectId)
Get the component model for a specific
WebCmsComponent identified by its object id. |
WebCmsComponentModel |
WebCmsComponentModelService.getComponentModelByName(String componentName,
WebCmsObject owner)
Get a single
WebCmsComponentModel for a specific owner by name. |
WebCmsComponentModel |
WebCmsComponentModelService.getComponentModelByNameAndDomain(String componentName,
WebCmsObject owner,
WebCmsDomain domain)
Get a single
WebCmsComponentModel for a specific owner by name and domain. |
WebCmsComponentModel |
WebCmsComponentModelHierarchy.getFromScope(String componentName,
String scopeName)
Get the component by name from the specific scope.
|
WebCmsComponentModel |
WebCmsComponentModelHierarchy.getFromScope(String componentName,
String scopeName,
boolean searchParentScopes)
Get the component by name from a specific scope.
|
WebCmsComponentModel |
WebCmsComponentModelSet.remove(String name)
Removes the component registered with that name.
|
| Modifier and Type | Method and Description |
|---|---|
Collection<WebCmsComponentModel> |
WebCmsComponentModelService.getComponentModelsForOwner(WebCmsObject object)
Return all components owned by the
WebCmsObject on the current domain, according to their sort order. |
Collection<WebCmsComponentModel> |
WebCmsComponentModelService.getComponentModelsForOwner(WebCmsObject object,
WebCmsDomain domain)
Return all components owned by the
WebCmsObject on the specific domain, according to their sort order. |
| Modifier and Type | Method and Description |
|---|---|
void |
WebCmsComponentModelSet.add(WebCmsComponentModel componentModel)
Add a component to the ordered list.
|
protected static Object |
WebCmsComponentModel.cloneMetadata(WebCmsComponentModel componentModel)
Attempt to forcibly clone the metadata of a
WebCmsComponentModel. |
void |
WebCmsComponentModelSet.put(@NonNull String name,
WebCmsComponentModel componentModel)
Register a component under a specific name in the set.
|
boolean |
WebCmsComponentModelSet.remove(@NonNull WebCmsComponentModel componentModel)
Removes the component model.
|
WebCmsComponent |
WebCmsComponentModelService.save(WebCmsComponentModel componentModel)
Save a
WebCmsComponentModel to the repository. |
boolean |
WebCmsComponentModelWriter.supports(WebCmsComponentModel componentModel) |
| Constructor and Description |
|---|
WebCmsComponentModel(WebCmsComponentModel template)
Base constructor for
asComponentTemplate() calls, uses the parent component as template
and attempts to convert the metadata to a new instance. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
WebCmsComponentAutoCreateStrategy<T extends WebCmsComponentModel> |
| Modifier and Type | Method and Description |
|---|---|
WebCmsComponentModel |
WebCmsComponentAutoCreateService.buildComponent(WebCmsComponentAutoCreateTask task)
Builds the component model represented by a single task, but does not save it.
|
WebCmsComponentModel |
WebCmsComponentAutoCreateService.createComponent(WebCmsComponentAutoCreateTask task)
Create all components represented by a single task.
|
WebCmsComponentModel |
WebCmsComponentAutoCreateQueue.getComponentCreated(String taskId) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
WebCmsComponentAutoCreateStrategy.supports(WebCmsComponentModel componentModel,
WebCmsComponentAutoCreateTask task) |
| Modifier and Type | Class and Description |
|---|---|
class |
PlaceholderWebCmsComponentModel |
| Modifier and Type | Method and Description |
|---|---|
boolean |
PlaceholderWebCmsComponentModelWriter.supports(WebCmsComponentModel componentModel) |
| Modifier and Type | Class and Description |
|---|---|
class |
ProxyWebCmsComponentModel
Represents a component that renders as a different component.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ProxyWebCmsComponentModel.setTarget(WebCmsComponentModel target)
Target component model that is proxied by this component.
|
boolean |
ProxyWebCmsComponentModelWriter.supports(WebCmsComponentModel componentModel) |
| Constructor and Description |
|---|
ProxyWebCmsComponentModel(WebCmsComponentModel template) |
ProxyWebCmsComponentModel(WebCmsComponent component,
WebCmsComponentModel target) |
| Modifier and Type | Class and Description |
|---|---|
class |
TextWebCmsComponentModel
Represents a text component that can be either plain text, rich text or markup (defined by
TextWebCmsComponentModel.MarkupType. |
| Modifier and Type | Method and Description |
|---|---|
boolean |
TextWebCmsComponentModelWriter.supports(WebCmsComponentModel componentModel) |
boolean |
TextWebCmsComponentModelAdminRenderer.supports(WebCmsComponentModel componentModel) |
| Constructor and Description |
|---|
TextWebCmsComponentModel(WebCmsComponentModel template) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
WebCmsComponentModelContentAdminRenderer<T extends WebCmsComponentModel> |
interface |
WebCmsComponentModelMembersAdminRenderer<T extends WebCmsComponentModel> |
interface |
WebCmsComponentModelMetadataAdminRenderer<T extends WebCmsComponentModel,U> |
| Modifier and Type | Method and Description |
|---|---|
Optional<com.foreach.across.modules.web.ui.ViewElementBuilder> |
WebCmsComponentModelAdminRenderService.createContentViewElementBuilder(WebCmsComponentModel componentModel,
String controlNamePrefix) |
WebCmsComponentModelFormElementBuilder |
WebCmsComponentModelAdminRenderService.createFormElement(WebCmsComponentModel componentModel,
String controlNamePrefix) |
Optional<com.foreach.across.modules.web.ui.ViewElementBuilder> |
WebCmsComponentModelAdminRenderService.createMembersViewElementBuilder(WebCmsComponentModel componentModel,
String controlNamePrefix) |
Optional<com.foreach.across.modules.web.ui.ViewElementBuilder> |
WebCmsComponentModelAdminRenderService.createMetadataViewElementBuilder(WebCmsComponentModel componentModel,
String controlNamePrefix) |
com.foreach.across.modules.web.ui.ViewElementBuilder |
WebCmsComponentModelAdminRenderService.createSettingsViewElementBuilder(WebCmsComponentModel componentModel,
String controlNamePrefix) |
boolean |
WebCmsComponentModelMembersAdminRenderer.supports(WebCmsComponentModel componentModel) |
boolean |
WebCmsComponentModelContentAdminRenderer.supports(WebCmsComponentModel componentModel) |
boolean |
WebCmsComponentModelMetadataAdminRenderer.supports(WebCmsComponentModel componentModel,
Object metadata) |
| Constructor and Description |
|---|
WebCmsComponentModelFormElementBuilder(WebCmsComponentModel componentModel) |
| Modifier and Type | Class and Description |
|---|---|
class |
ImageWebCmsComponentModel |
| Modifier and Type | Method and Description |
|---|---|
boolean |
ImageWebCmsComponentModelWriter.supports(WebCmsComponentModel componentModel) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
ImageWebComponentModelAdminRenderer.supports(WebCmsComponentModel componentModel) |
boolean |
ImageWebCmsComponentModelRenderer.supports(WebCmsComponentModel componentModel) |
| Modifier and Type | Method and Description |
|---|---|
WebCmsComponentModel |
WebCmsRenderUtilityService.component(String componentName)
Retrieve a component by name from the default scope.
|
WebCmsComponentModel |
WebCmsRenderUtilityService.componentFromScope(String componentName,
String scopeName)
Retrieve a component by name from the specified scope.
|
WebCmsComponentModel |
WebCmsRenderUtilityService.componentFromScope(String componentName,
String scopeName,
boolean searchParentScopes)
Retrieve a component by name from the specified scope.
|
WebCmsComponentModel |
WebCmsRenderUtilityService.member(String componentName,
WebCmsComponentModel container)
Retrieve a container member by name.
|
| Modifier and Type | Method and Description |
|---|---|
List<WebCmsComponentModel> |
WebCmsRenderUtilityService.members(WebCmsComponentModel container)
Retrieve the member components of a container.
|
| Modifier and Type | Method and Description |
|---|---|
WebCmsComponentModel |
WebCmsRenderUtilityService.member(String componentName,
WebCmsComponentModel container)
Retrieve a container member by name.
|
List<WebCmsComponentModel> |
WebCmsRenderUtilityService.members(WebCmsComponentModel container)
Retrieve the member components of a container.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
WebCmsComponentContentMarkerRenderer<T extends WebCmsComponentModel>
API for rendering a content marker to the output.
|
interface |
WebCmsComponentModelRenderer<T extends WebCmsComponentModel>
API for rendering a
WebCmsComponentModel in a Thymeleaf template. |
| Modifier and Type | Method and Description |
|---|---|
boolean |
WebCmsComponentModelRenderer.supports(WebCmsComponentModel componentModel)
Can this renderer write this component model?
|
boolean |
WebCmsComponentContentMarkerRenderer.supports(WebCmsComponentModel componentModel,
WebCmsContentMarker marker)
Can this renderer write this component model?
|
void |
WebCmsComponentContentModelWriter.writeHtml(WebCmsComponentModel componentModel,
String text,
boolean parseMarkers,
com.foreach.across.modules.web.thymeleaf.ThymeleafModelBuilder model)
Write raw unescaped text (HTML) to the Thymeleaf output.
|
void |
WebCmsComponentContentModelWriter.writeText(WebCmsComponentModel componentModel,
String text,
boolean escapeXml,
boolean parseMarkers,
com.foreach.across.modules.web.thymeleaf.ThymeleafModelBuilder model)
Write text to the Thymeleaf output.
|
void |
WebCmsComponentContentModelWriter.writeText(WebCmsComponentModel componentModel,
String text,
boolean parseMarkers,
com.foreach.across.modules.web.thymeleaf.ThymeleafModelBuilder model)
Write escaped text to the Thymeleaf output.
|
Copyright © 2020. All rights reserved.