org.broadleafcommerce.cms.admin.web.controller

Class AdminPageController

java.lang.Object

org.broadleafcommerce.common.web.controller.BroadleafAbstractController

org.broadleafcommerce.openadmin.web.controller.AdminAbstractController

org.broadleafcommerce.openadmin.web.controller.entity.AdminBasicEntityController

org.broadleafcommerce.cms.admin.web.controller.AdminPageController

@Controller(value="blAdminPageController")
@RequestMapping(value="/pages")
public class AdminPageController
extends AdminBasicEntityController

Handles admin operations for the Page entity. This entity has fields that are dependent on the value of the Page.getPageTemplate() field, and as such, it deviates from the typical AdminAbstractEntityController.

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field and Description
static String	SECTION_KEY

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

hideTopLevelErrors, LOG, sandBoxHelper

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

adminNavigationService, adminRemoteSecurityService, CURRENT_ADMIN_MODULE_ATTRIBUTE_NAME, CURRENT_ADMIN_SECTION_ATTRIBUTE_NAME, entityConfiguration, entityFormValidator, extensionManager, FILTER_VALUE_SEPARATOR, FILTER_VALUE_SEPARATOR_REGEX, formService, mainEntityActionsExtensionManager, service

Constructor Summary

Constructors

Constructor and Description
AdminPageController()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addOnChangeTrigger(EntityForm ef)
protected void	attachSectionSpecificInfo(PersistencePackageRequest ppr, Map<String,String> pathVars) A hook method that is invoked every time the #getSectionPersistencePackageRequest(String) method is invoked.
protected DynamicEntityFormInfo	getDynamicForm(EntityForm ef, String id)
String	getDynamicForm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String propertyName, String propertyTypeId)
protected String	getSectionKey(Map<String,String> pathVars) This method is used to determine the current section key.
String	saveEntity(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id, EntityForm entityForm, org.springframework.validation.BindingResult result, org.springframework.web.servlet.mvc.support.RedirectAttributes ra) Attempts to save the given entity.
String	viewEntityForm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model, Map<String,String> pathVars, String id) Renders the main entity form for the specified entity

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

addAddActionIfAllowed, addCollectionItem, addEntity, buildAddCollectionItemModel, buildDirtyList, getCollectionFieldRecords, getCollectionValueDetails, initBinder, isAddActionAllowed, populateJsonValidationErrors, removeCollectionItem, removeCollectionItem, removeEntity, saveEntityJson, showAddCollectionItem, showUpdateCollectionItem, showUpdateCollectionItem, showViewCollectionItem, showViewCollectionItem, showViewUpdateCollection, showViewUpdateCollection, showViewUpdateCollection, showViewUpdateCollection, translateErrorMessage, updateCollectionItem, updateCollectionItem, updateCollectionItemSequence, updateCollectionItemSequence, viewAddEntityForm, viewCollectionItemDetails, viewEntityList

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

attachSectionSpecificInfo, extractDynamicFormFields, getAddEntityTypes, getBlankDynamicFieldTemplateForm, getBlankDynamicFieldTemplateForm, getBlankDynamicMasterFieldGroupTemplateForm, getBlankDynamicMasterFieldGroupTemplateForm, getClassNameForSection, getCollectionListGrid, getCollectionListGrid, getCriteria, getDefaultEntityType, getDynamicFieldTemplateForm, getDynamicForm, getEntityForm, getEntityForm, getMaxIndex, getSectionCrumbs, getSectionCustomCriteria, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSectionPersistencePackageRequest, getSortDirections, getSortPropertyNames, getStartIndex, modifyAddEntityForm, modifyEntityForm, setModelAttributes

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 Detail

SECTION_KEY

public static final String SECTION_KEY

See Also:

Constant Field Values

Constructor Detail

AdminPageController

public AdminPageController()

Method Detail

getSectionKey

protected String getSectionKey(Map<String,String> pathVars)

Description copied from class: AdminAbstractController

This method is used to determine the current section key. For this default implementation, the sectionKey is pulled from the pathVariable, {sectionKey}, as defined by the request mapping on this controller. To support controller inheritance and allow more specialized controllers to delegate some methods to this basic controller, overridden implementations of this method could return a hardcoded value instead of reading the map

Overrides:

getSectionKey in class AdminAbstractController

Parameters:

pathVars - - the map of all currently bound path variables for this request

Returns:

the sectionKey for this request

getDynamicForm

protected DynamicEntityFormInfo getDynamicForm(EntityForm ef,
                                   String id)

addOnChangeTrigger

protected void addOnChangeTrigger(EntityForm ef)

viewEntityForm

@RequestMapping(value="/{id}",
                method=GET)
public String viewEntityForm(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response,
                                   org.springframework.ui.Model model,
                                   @PathVariable
                                   Map<String,String> pathVars,
                                   @PathVariable(value="id")
                                   String id)
                      throws Exception

Description copied from class: AdminBasicEntityController

Renders the main entity form for the specified entity

Overrides:

viewEntityForm in class AdminBasicEntityController

Returns:

the return view path

Throws:

Exception

saveEntity

@RequestMapping(value="/{id}",
                method=POST)
public String saveEntity(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               org.springframework.ui.Model model,
                               @PathVariable
                               Map<String,String> pathVars,
                               @PathVariable(value="id")
                               String id,
                               @ModelAttribute(value="entityForm")
                               EntityForm entityForm,
                               org.springframework.validation.BindingResult result,
                               org.springframework.web.servlet.mvc.support.RedirectAttributes ra)
                  throws Exception

Description copied from class: AdminBasicEntityController

Attempts to save the given entity. If validation is unsuccessful, it will re-render the entity form with error fields highlighted. On a successful save, it will refresh the entity page.

Overrides:

saveEntity in class AdminBasicEntityController

Returns:

the return view path

Throws:

Exception

getDynamicForm

@RequestMapping(value="/{propertyName}/dynamicForm",
                method=GET)
public String getDynamicForm(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response,
                                   org.springframework.ui.Model model,
                                   @PathVariable
                                   Map<String,String> pathVars,
                                   @PathVariable(value="propertyName")
                                   String propertyName,
                                   @RequestParam(value="propertyTypeId")
                                   String propertyTypeId)
                      throws Exception

Throws:

Exception

attachSectionSpecificInfo

protected void attachSectionSpecificInfo(PersistencePackageRequest ppr,
                             Map<String,String> pathVars)

Description copied from class: AdminAbstractController

A hook method that is invoked every time the #getSectionPersistencePackageRequest(String) method is invoked. This allows specialized controllers to hook into every request and manipulate the persistence package request as desired.

Overrides:

attachSectionSpecificInfo in class AdminAbstractController