Java tutorial
/** * Copyright (c) 2000-present Liferay, Inc. All rights reserved. * * This library is free software; you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation; either version 2.1 of the License, or (at your option) * any later version. * * This library is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more * details. */ package com.liferay.dynamic.data.lists.web.internal.template; import com.liferay.dynamic.data.lists.constants.DDLConstants; import com.liferay.dynamic.data.lists.constants.DDLPortletKeys; import com.liferay.dynamic.data.lists.model.DDLRecord; import com.liferay.dynamic.data.lists.model.DDLRecordSet; import com.liferay.dynamic.data.lists.service.DDLRecordLocalService; import com.liferay.dynamic.data.lists.service.DDLRecordService; import com.liferay.dynamic.data.lists.service.DDLRecordSetLocalService; import com.liferay.dynamic.data.lists.service.DDLRecordSetService; import com.liferay.dynamic.data.lists.web.configuration.DDLWebConfigurationKeys; import com.liferay.dynamic.data.lists.web.configuration.DDLWebConfigurationUtil; import com.liferay.dynamic.data.mapping.service.DDMStructureLocalService; import com.liferay.dynamic.data.mapping.service.DDMStructureService; import com.liferay.dynamic.data.mapping.service.DDMTemplateLocalService; import com.liferay.dynamic.data.mapping.service.DDMTemplateService; import com.liferay.dynamic.data.mapping.storage.DDMFormFieldValue; import com.liferay.dynamic.data.mapping.template.BaseDDMTemplateHandler; import com.liferay.dynamic.data.mapping.template.DDMTemplateVariableCodeHandler; import com.liferay.portal.kernel.configuration.Filter; import com.liferay.portal.kernel.language.LanguageUtil; import com.liferay.portal.kernel.model.Release; import com.liferay.portal.kernel.template.TemplateHandler; import com.liferay.portal.kernel.template.TemplateVariableCodeHandler; import com.liferay.portal.kernel.template.TemplateVariableGroup; import com.liferay.portal.kernel.util.Portal; import com.liferay.portal.kernel.util.SetUtil; import com.liferay.portal.kernel.util.StringPool; import java.util.HashMap; import java.util.LinkedHashMap; import java.util.List; import java.util.Locale; import java.util.Map; import org.osgi.service.component.annotations.Component; import org.osgi.service.component.annotations.Reference; /** * @author Jorge Ferrer * @author Marcellus Tavares */ @Component(immediate = true, property = { "javax.portlet.name=" + DDLPortletKeys.DYNAMIC_DATA_LISTS_DISPLAY }, service = TemplateHandler.class) public class DDLDisplayTemplateHandler extends BaseDDMTemplateHandler { @Override public String getClassName() { return DDLRecordSet.class.getName(); } @Override public Map<String, Object> getCustomContextObjects() { Map<String, Object> contextObjects = new HashMap<>(1); contextObjects.put("ddlDisplayTemplateHelper", new DDLDisplayTemplateHelper()); return contextObjects; } @Override public String getName(Locale locale) { String portletTitle = _portal.getPortletTitle(DDLPortletKeys.DYNAMIC_DATA_LISTS, locale); return portletTitle.concat(StringPool.SPACE).concat(LanguageUtil.get(locale, "template")); } @Override public String getResourceName() { return "com.liferay.dynamic.data.lists.template"; } @Override public String getTemplatesHelpPath(String language) { return DDLWebConfigurationUtil.get(getTemplatesHelpPropertyKey(), new Filter(language)); } @Override public String getTemplatesHelpPropertyKey() { return DDLWebConfigurationKeys.DYNAMIC_DATA_LISTS_HELP_TEMPLATE; } @Override public Map<String, TemplateVariableGroup> getTemplateVariableGroups(long classPK, String language, Locale locale) throws Exception { Map<String, TemplateVariableGroup> templateVariableGroups = new LinkedHashMap<>(); addTemplateVariableGroup(templateVariableGroups, getDDLUtilVariablesTemplateVariableGroups()); addTemplateVariableGroup(templateVariableGroups, getDDLVariablesTemplateVariableGroups()); addTemplateVariableGroup(templateVariableGroups, getGeneralVariablesTemplateVariableGroup()); TemplateVariableGroup structureFieldsTemplateVariableGroup = getStructureFieldsTemplateVariableGroup( classPK, locale); structureFieldsTemplateVariableGroup.setLabel("data-list-record-fields"); addTemplateVariableGroup(templateVariableGroups, structureFieldsTemplateVariableGroup); addTemplateVariableGroup(templateVariableGroups, getUtilTemplateVariableGroup()); String[] restrictedVariables = getRestrictedVariables(language); TemplateVariableGroup ddlServicesTemplateVariableGroup = new TemplateVariableGroup("data-list-services", restrictedVariables); ddlServicesTemplateVariableGroup.setAutocompleteEnabled(false); ddlServicesTemplateVariableGroup.addServiceLocatorVariables(DDLRecordLocalService.class, DDLRecordService.class, DDLRecordSetLocalService.class, DDLRecordSetService.class, DDMStructureLocalService.class, DDMStructureService.class, DDMTemplateLocalService.class, DDMTemplateService.class); templateVariableGroups.put(ddlServicesTemplateVariableGroup.getLabel(), ddlServicesTemplateVariableGroup); return templateVariableGroups; } protected TemplateVariableGroup getDDLUtilVariablesTemplateVariableGroups() { TemplateVariableGroup ddlUtilTemplateVariableGroup = new TemplateVariableGroup("data-list-util"); ddlUtilTemplateVariableGroup.addVariable("data-list-display-template-helper", DDLDisplayTemplateHelper.class, "ddlDisplayTemplateHelper", null); return ddlUtilTemplateVariableGroup; } protected TemplateVariableGroup getDDLVariablesTemplateVariableGroups() { TemplateVariableGroup templateVariableGroup = new TemplateVariableGroup("data-list-variables"); templateVariableGroup.addVariable("data-definition-id", null, DDLConstants.RESERVED_DDM_STRUCTURE_ID); templateVariableGroup.addVariable("data-list-description", String.class, DDLConstants.RESERVED_RECORD_SET_DESCRIPTION); templateVariableGroup.addVariable("data-list-id", null, DDLConstants.RESERVED_RECORD_SET_ID); templateVariableGroup.addVariable("data-list-name", String.class, DDLConstants.RESERVED_RECORD_SET_NAME); templateVariableGroup.addCollectionVariable("data-list-records", List.class, "records", "record", DDLRecord.class, "cur_record", null); templateVariableGroup.addVariable("template-id", null, DDLConstants.RESERVED_DDM_TEMPLATE_ID); return templateVariableGroup; } @Override protected Class<?> getFieldVariableClass() { return DDMFormFieldValue.class; } @Override protected TemplateVariableCodeHandler getTemplateVariableCodeHandler() { return _templateVariableCodeHandler; } @Reference private Portal _portal; @Reference(target = "(&(release.bundle.symbolic.name=com.liferay.dynamic.data.lists.service)(release.schema.version=1.0.2))") private Release _release; private final TemplateVariableCodeHandler _templateVariableCodeHandler = new DDMTemplateVariableCodeHandler( DDLDisplayTemplateHandler.class.getClassLoader(), "com/liferay/dynamic/data/lists/web/internal/template" + "/dependencies/", SetUtil.fromArray(new String[] { "document-library", "html", "link-to-page" })); }