Package com.broadleafcommerce.advancedcms.admin.web.controller

Class AdminContentItemController

java.lang.Object
org.broadleafcommerce.common.web.controller.BroadleafAbstractController
org.broadleafcommerce.openadmin.web.controller.AdminAbstractController
org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController
com.broadleafcommerce.advancedcms.admin.web.controller.AdminAbstractContentItemController
com.broadleafcommerce.advancedcms.admin.web.controller.AdminContentItemController
@RequestMapping("/content-item") public class AdminContentItemController extends AdminAbstractContentItemController
Author:
Elbert Bautista (elbertbautista)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected ContentZoneService
    contentZoneService
     
    protected org.broadleafcommerce.cms.structure.dao.StructuredContentDao
    dao
     
    protected static final String
    SECTION_KEY
     

    Fields inherited from class com.broadleafcommerce.advancedcms.admin.web.controller.AdminAbstractContentItemController

    contentItemService, IS_MASTER_LABEL, localeService, structuredContentService, widgetService, workflowSandboxItemService, workflowStateManager

    Fields inherited from class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController

    adminUserDao, adornedTargetAutoPopulateExtensionManager, ALTERNATE_ID_PROPERTY, CURRENT_FOLDER_ID, CUSTOM_CRITERIA, duplicator, dynamicEntityDao, genericEntityService, IS_SELECTIZE_REQUEST, LOG, multipleCatalogExtensionManager, rowLevelSecurityService, sandBoxHelper

    Fields inherited from class org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

    adminNavigationService, adminRemoteSecurityService, CURRENT_ADMIN_MODULE_ATTRIBUTE_NAME, CURRENT_ADMIN_SECTION_ATTRIBUTE_NAME, customCriteriaService, DEFAULT_CONTAINER_VIEW, entityConfiguration, entityFormValidator, eps, extensionManager, FILTER_VALUE_SEPARATOR, FILTER_VALUE_SEPARATOR_REGEX, filterProductTypeExtensionManager, formService, MODAL_CONTAINER_VIEW, service, validationService

  • Constructor Summary

    Constructors
    Constructor
    Description
    AdminContentItemController()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    addEntity(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, org.broadleafcommerce.openadmin.web.form.entity.EntityForm entityForm, org.springframework.validation.BindingResult result)
     
    protected void
    addMasterDynamicForms(org.broadleafcommerce.openadmin.web.form.entity.EntityForm form, org.broadleafcommerce.openadmin.web.form.entity.Field widgetField, org.springframework.ui.Model model)
     
    protected void
    createHiddenFieldsOnFieldGroup(String scType, String dynamicPropName, org.broadleafcommerce.openadmin.web.form.entity.FieldGroup fg, String index)
     
    protected org.broadleafcommerce.openadmin.web.form.entity.EntityForm
    getBlankDynamicMasterFieldGroupEntityForm(String scType, Integer index, String groupName, String dynamicPropName, org.broadleafcommerce.openadmin.web.form.entity.DynamicEntityFormInfo info)
    Convenience method to build a blank form for a Master Field Group.
    protected org.broadleafcommerce.openadmin.web.form.entity.DynamicEntityFormInfo
    getDynamicEntityFormInfo(String scType, String dynamicPropName)
     
    String
    getDynamicForm(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String index, String scType, String dynamicPropName)
     
    protected String
    getSectionKey(Map<String,String> pathVars)
     
    Map<String,org.broadleafcommerce.openadmin.dto.DynamicResultSet>
    getViewSubRecords(jakarta.servlet.http.HttpServletRequest request, Map<String,String> pathVars, org.broadleafcommerce.openadmin.dto.ClassMetadata cmd, org.broadleafcommerce.openadmin.dto.Entity entity, List<org.broadleafcommerce.openadmin.dto.SectionCrumb> crumbs)
     
    protected boolean
    hasDynamicFormWithSCType(org.broadleafcommerce.openadmin.web.form.entity.EntityForm form, List<org.broadleafcommerce.cms.structure.domain.StructuredContentType> supportedSCTypes)
     
    protected boolean
    isAdd(org.broadleafcommerce.openadmin.web.form.entity.EntityForm scForm)
     
    protected boolean
    isRemove(org.broadleafcommerce.openadmin.web.form.entity.EntityForm scForm)
     
    protected boolean
    isSCTypeSupported(org.broadleafcommerce.openadmin.web.form.entity.EntityForm scForm, org.broadleafcommerce.openadmin.web.form.entity.Field widgetField)
     
    protected boolean
    isWidgetChanged(org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest ppr, String id, org.broadleafcommerce.openadmin.web.form.entity.EntityForm newEntityForm)
     
    protected void
    markDynamicFormsAsVisible(org.broadleafcommerce.openadmin.web.form.entity.EntityForm form)
     
    protected void
    modifyEntityForm(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id)
     
    protected void
    processFieldGroups(String index, String scType, String dynamicPropName, org.broadleafcommerce.openadmin.web.form.entity.EntityForm dynamicForm)
    Helper method to prepare the Field groups for viewing on the DynamicForm.
    protected void
    removeSCFormEntities(Map<String,String> pathVars, String id, List<org.broadleafcommerce.openadmin.dto.SectionCrumb> sectionCrumbs, org.broadleafcommerce.openadmin.web.form.entity.EntityForm scForm, String dynamicFormName)
     
    String
    saveEntity(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, org.broadleafcommerce.openadmin.web.form.entity.EntityForm entityForm, org.springframework.validation.BindingResult result, org.springframework.web.servlet.mvc.support.RedirectAttributes ra)
     
    protected void
    saveSCForms(List<org.broadleafcommerce.openadmin.web.form.entity.EntityForm> scForms, org.broadleafcommerce.openadmin.web.form.entity.Field widgetField, String id, jakarta.servlet.http.HttpServletRequest request, Map<String,String> pathVars, org.springframework.validation.BindingResult result, boolean isWidgetChanged)
     
    protected boolean
    shouldShowEmptyGroups()
     
    protected Map<String,Boolean>
    validateAndModifyFieldGroupData(org.broadleafcommerce.openadmin.web.form.entity.EntityForm form, org.broadleafcommerce.cms.structure.domain.StructuredContentType type)
     
    protected boolean
    validateCreationOfMasterFieldGroup(org.broadleafcommerce.openadmin.web.form.entity.EntityForm form, Map<String,Boolean> formsWithMasterData, String scType, Map<String,org.broadleafcommerce.openadmin.web.form.entity.EntityForm> dynamicForms)
     
    String
    viewAddEntityForm(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String entityType)
     
    String
    viewEntityForm(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id)
     

    Methods inherited from class com.broadleafcommerce.advancedcms.admin.web.controller.AdminAbstractContentItemController

    addNewOverrideStructuredContent, addNewStructuredContent, addNewStructuredContent, addTranslationPropertyName, containsHiddenFields, convertSCListGridToDynamicForms, createDynamicSCForm, extractSCFormsForPersistence, extractStructuredContentForms, getContentItemName, getFieldName, getSCSectionCrumbs, getSCType, getSCTypesForWidget, getTranslationId, getTranslationPropertyName, preventFieldGroupPersistence, primeFieldGroup, removeMasterGroupsFromDynamicForm, setItemContainerOverrideForEnterprise

    Methods inherited from class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController

    addAddActionIfAllowed, addAuditableDisplayField, addAuditableDisplayFields, addCollectionItem, addCollectionItem, addEmptyCollectionItem, addSelectizeCollectionItem, buildAddCollectionItemModel, buildAuditableDisplayField, buildDirtyList, buildSelectizeCustomCriteria, declareShouldIgnoreAdditionStatusFilter, determineEntityType, duplicateEntity, getCollectionFieldRecords, getCollectionValueDetails, getCurrentFolderId, getCurrentTabName, getCustomCriteria, getErrorDuplicatingResponse, getModalForBlankEntityType, getSelectizeCollectionOptions, initBinder, isAddActionAllowed, isNotReadOnly, modifyEntityForm, postAddSubCollectionEntityHook, postUpdateSubCollectionEntityHook, reinitializeEntityForm, removeCollectionItem, removeCollectionItem, removeEntity, resolveAppropriateEntityView, saveEntityJson, setTypedEntityModelAttributes, setupViewEntityListBasicModel, showAddCollectionItem, showUpdateCollectionItem, showUpdateCollectionItem, showViewCollectionItem, showViewCollectionItem, showViewUpdateCollection, showViewUpdateCollection, showViewUpdateCollection, showViewUpdateCollection, updateCollectionItem, updateCollectionItem, updateCollectionItemSequence, updateCollectionItemSequence, viewCollectionItemDetails, viewCollectionItemTab, viewEntityList, viewEntityListSelectize, viewEntityTab, viewReadOnlyCollectionItemTab

    Methods inherited from class org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

    attachSectionSpecificInfo, attachSectionSpecificInfo, createSectionCrumb, declareForceUseAdditionStatusFilter, extractDynamicFormFields, getAddEntityTypes, getClassNameForSection, getCollectionListGrid, getCollectionListGrid, getCriteria, getDefaultEntityType, getDynamicFieldTemplateForm, getDynamicForm, getEntityForm, getEntityForm, getEntityForm, getFirstId, getLastId, getLowerCount, getMaxIndex, getMaxResults, getPageSize, getPersistencePackageRequest, getSectionCrumbs, getSectionCustomCriteria, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSortDirections, getSortPropertyNames, getStartIndex, getUpperCount, modifyAddEntityForm, modifyCriteria, modifyEntityForm, populateJsonValidationErrors, setModelAttributes, setSpecializedNameForFields, translateErrorMessage

    Methods inherited from class org.broadleafcommerce.common.web.controller.BroadleafAbstractController

    addDeepLink, getContextPath, isAjaxRequest, jsonResponse

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • SECTION_KEY

      protected static final String SECTION_KEY
      See Also:

    • contentZoneService

      protected ContentZoneService contentZoneService

    • dao

      protected org.broadleafcommerce.cms.structure.dao.StructuredContentDao dao

  • Constructor Details

    • AdminContentItemController

      public AdminContentItemController()

  • Method Details

    • shouldShowEmptyGroups

      protected boolean shouldShowEmptyGroups()

    • getSectionKey

      protected String getSectionKey(Map<String,String> pathVars)
      Overrides:
      getSectionKey in class org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

    • viewAddEntityForm

      @RequestMapping(value="/add", method=GET) public String viewAddEntityForm(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, @PathVariable Map<String,String> pathVars, @RequestParam(defaultValue="") String entityType) throws Exception
      Overrides:
      viewAddEntityForm in class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController
      Throws:
      Exception

    • addEntity

      @RequestMapping(value="/add", method=POST) public String addEntity(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, @PathVariable Map<String,String> pathVars, @ModelAttribute("entityForm") org.broadleafcommerce.openadmin.web.form.entity.EntityForm entityForm, org.springframework.validation.BindingResult result) throws Exception
      Overrides:
      addEntity in class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController
      Throws:
      Exception

    • viewEntityForm

      @RequestMapping(value="/{id}", method=GET) public String viewEntityForm(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, @PathVariable Map<String,String> pathVars, @PathVariable("id") String id) throws Exception
      Overrides:
      viewEntityForm in class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController
      Throws:
      Exception

    • getViewSubRecords

      public Map<String,org.broadleafcommerce.openadmin.dto.DynamicResultSet> getViewSubRecords(jakarta.servlet.http.HttpServletRequest request, Map<String,String> pathVars, org.broadleafcommerce.openadmin.dto.ClassMetadata cmd, org.broadleafcommerce.openadmin.dto.Entity entity, List<org.broadleafcommerce.openadmin.dto.SectionCrumb> crumbs) throws Exception
      Overrides:
      getViewSubRecords in class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController
      Throws:
      Exception

    • modifyEntityForm

      protected void modifyEntityForm(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id) throws org.broadleafcommerce.common.exception.ServiceException, Exception
      Throws:
      org.broadleafcommerce.common.exception.ServiceException
      Exception

    • hasDynamicFormWithSCType

      protected boolean hasDynamicFormWithSCType(org.broadleafcommerce.openadmin.web.form.entity.EntityForm form, List<org.broadleafcommerce.cms.structure.domain.StructuredContentType> supportedSCTypes)

    • addMasterDynamicForms

      protected void addMasterDynamicForms(org.broadleafcommerce.openadmin.web.form.entity.EntityForm form, org.broadleafcommerce.openadmin.web.form.entity.Field widgetField, org.springframework.ui.Model model) throws org.broadleafcommerce.common.exception.ServiceException
      Throws:
      org.broadleafcommerce.common.exception.ServiceException

    • markDynamicFormsAsVisible

      protected void markDynamicFormsAsVisible(org.broadleafcommerce.openadmin.web.form.entity.EntityForm form)

    • getBlankDynamicMasterFieldGroupEntityForm

      protected org.broadleafcommerce.openadmin.web.form.entity.EntityForm getBlankDynamicMasterFieldGroupEntityForm(String scType, Integer index, String groupName, String dynamicPropName, org.broadleafcommerce.openadmin.web.form.entity.DynamicEntityFormInfo info) throws org.broadleafcommerce.common.exception.ServiceException
      Convenience method to build a blank form for a Master Field Group.
      Parameters:
      scType -
      index -
      groupName -
      dynamicPropName -
      info -
      Returns:
      Throws:
      org.broadleafcommerce.common.exception.ServiceException

    • validateCreationOfMasterFieldGroup

      protected boolean validateCreationOfMasterFieldGroup(org.broadleafcommerce.openadmin.web.form.entity.EntityForm form, Map<String,Boolean> formsWithMasterData, String scType, Map<String,org.broadleafcommerce.openadmin.web.form.entity.EntityForm> dynamicForms)

    • validateAndModifyFieldGroupData

      protected Map<String,Boolean> validateAndModifyFieldGroupData(org.broadleafcommerce.openadmin.web.form.entity.EntityForm form, org.broadleafcommerce.cms.structure.domain.StructuredContentType type)

    • saveEntity

      @RequestMapping(value="/{id}", method=POST) public String saveEntity(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, @PathVariable Map<String,String> pathVars, @PathVariable("id") String id, @ModelAttribute("entityForm") org.broadleafcommerce.openadmin.web.form.entity.EntityForm entityForm, org.springframework.validation.BindingResult result, org.springframework.web.servlet.mvc.support.RedirectAttributes ra) throws Exception
      Overrides:
      saveEntity in class org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController
      Throws:
      Exception

    • isWidgetChanged

      protected boolean isWidgetChanged(org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest ppr, String id, org.broadleafcommerce.openadmin.web.form.entity.EntityForm newEntityForm)

    • saveSCForms

      protected void saveSCForms(List<org.broadleafcommerce.openadmin.web.form.entity.EntityForm> scForms, org.broadleafcommerce.openadmin.web.form.entity.Field widgetField, String id, jakarta.servlet.http.HttpServletRequest request, Map<String,String> pathVars, org.springframework.validation.BindingResult result, boolean isWidgetChanged) throws org.broadleafcommerce.common.exception.ServiceException
      Throws:
      org.broadleafcommerce.common.exception.ServiceException

    • isAdd

      protected boolean isAdd(org.broadleafcommerce.openadmin.web.form.entity.EntityForm scForm)

    • isRemove

      protected boolean isRemove(org.broadleafcommerce.openadmin.web.form.entity.EntityForm scForm)

    • isSCTypeSupported

      protected boolean isSCTypeSupported(org.broadleafcommerce.openadmin.web.form.entity.EntityForm scForm, org.broadleafcommerce.openadmin.web.form.entity.Field widgetField)

    • removeSCFormEntities

      protected void removeSCFormEntities(Map<String,String> pathVars, String id, List<org.broadleafcommerce.openadmin.dto.SectionCrumb> sectionCrumbs, org.broadleafcommerce.openadmin.web.form.entity.EntityForm scForm, String dynamicFormName) throws org.broadleafcommerce.common.exception.ServiceException
      Throws:
      org.broadleafcommerce.common.exception.ServiceException

    • getDynamicForm

      @RequestMapping(value="/dynamicForm", method=GET) public String getDynamicForm(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, @PathVariable Map<String,String> pathVars, @RequestParam("index") String index, @RequestParam("scType") String scType, @RequestParam(value="dynamicPropName",required=false) String dynamicPropName) throws Exception
      Throws:
      Exception

    • processFieldGroups

      protected void processFieldGroups(String index, String scType, String dynamicPropName, org.broadleafcommerce.openadmin.web.form.entity.EntityForm dynamicForm)
      Helper method to prepare the Field groups for viewing on the DynamicForm.

      Sets the title of the field group. Sets visibility of fields if elgible for viewing. Adds necessary hidden fields.

      Parameters:
      index -
      scType -
      dynamicPropName -
      dynamicForm -

    • getDynamicEntityFormInfo

      protected org.broadleafcommerce.openadmin.web.form.entity.DynamicEntityFormInfo getDynamicEntityFormInfo(String scType, String dynamicPropName)

    • createHiddenFieldsOnFieldGroup

      protected void createHiddenFieldsOnFieldGroup(String scType, String dynamicPropName, org.broadleafcommerce.openadmin.web.form.entity.FieldGroup fg, String index)