com.liferay.asset.publisher.web.internal.portlet.template.AssetPublisherPortletDisplayTemplateHandler.java Source code

Introduction

Here is the source code for com.liferay.asset.publisher.web.internal.portlet.template.AssetPublisherPortletDisplayTemplateHandler.java

Source

/**
 * 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.asset.publisher.web.internal.portlet.template;

import com.liferay.asset.kernel.model.AssetEntry;
import com.liferay.asset.kernel.service.AssetCategoryLocalService;
import com.liferay.asset.kernel.service.AssetCategoryService;
import com.liferay.asset.kernel.service.AssetEntryLocalService;
import com.liferay.asset.kernel.service.AssetEntryService;
import com.liferay.asset.kernel.service.AssetTagLocalService;
import com.liferay.asset.kernel.service.AssetTagService;
import com.liferay.asset.kernel.service.AssetVocabularyLocalService;
import com.liferay.asset.kernel.service.AssetVocabularyService;
import com.liferay.asset.publisher.web.constants.AssetPublisherPortletKeys;
import com.liferay.asset.publisher.web.util.AssetPublisherHelper;
import com.liferay.asset.tag.stats.service.AssetTagStatsLocalService;
import com.liferay.petra.string.StringPool;
import com.liferay.portal.kernel.language.LanguageUtil;
import com.liferay.portal.kernel.portletdisplaytemplate.BasePortletDisplayTemplateHandler;
import com.liferay.portal.kernel.template.TemplateHandler;
import com.liferay.portal.kernel.template.TemplateVariableGroup;
import com.liferay.portal.kernel.util.Portal;
import com.liferay.portal.kernel.util.ResourceBundleUtil;
import com.liferay.portlet.display.template.PortletDisplayTemplateConstants;

import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;

import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;

/**
 * @author Juan Fernndez
 */
@Component(immediate = true, property = {
        "javax.portlet.name=" + AssetPublisherPortletKeys.ASSET_PUBLISHER }, service = TemplateHandler.class)
public class AssetPublisherPortletDisplayTemplateHandler extends BasePortletDisplayTemplateHandler {

    @Override
    public String getClassName() {
        return AssetEntry.class.getName();
    }

    @Override
    public Map<String, Object> getCustomContextObjects() {
        Map<String, Object> contextObjects = new HashMap<>(1);

        contextObjects.put("assetPublisherHelper", new AssetPublisherHelper());

        return contextObjects;
    }

    @Override
    public String getName(Locale locale) {
        ResourceBundle resourceBundle = ResourceBundleUtil.getBundle("content.Language", locale, getClass());

        String portletTitle = portal.getPortletTitle(AssetPublisherPortletKeys.ASSET_PUBLISHER, resourceBundle);

        return portletTitle.concat(StringPool.SPACE).concat(LanguageUtil.get(locale, "template"));
    }

    @Override
    public String getResourceName() {
        return AssetPublisherPortletKeys.ASSET_PUBLISHER;
    }

    @Override
    public Map<String, TemplateVariableGroup> getTemplateVariableGroups(long classPK, String language,
            Locale locale) throws Exception {

        Map<String, TemplateVariableGroup> templateVariableGroups = super.getTemplateVariableGroups(classPK,
                language, locale);

        String[] restrictedVariables = getRestrictedVariables(language);

        TemplateVariableGroup assetPublisherUtilTemplateVariableGroup = new TemplateVariableGroup(
                "asset-publisher-util", restrictedVariables);

        assetPublisherUtilTemplateVariableGroup.addVariable("asset-publisher-helper", AssetPublisherHelper.class,
                "assetPublisherHelper");

        templateVariableGroups.put("asset-publisher-util", assetPublisherUtilTemplateVariableGroup);

        TemplateVariableGroup fieldsTemplateVariableGroup = templateVariableGroups.get("fields");

        fieldsTemplateVariableGroup.empty();

        fieldsTemplateVariableGroup.addCollectionVariable("asset-entries", List.class,
                PortletDisplayTemplateConstants.ENTRIES, "asset-entry", AssetEntry.class, "curEntry",
                "getTitle(locale)");
        fieldsTemplateVariableGroup.addVariable("asset-entry", AssetEntry.class,
                PortletDisplayTemplateConstants.ENTRY, "getTitle(locale)");

        TemplateVariableGroup assetServicesTemplateVariableGroup = new TemplateVariableGroup("asset-services",
                restrictedVariables);

        assetServicesTemplateVariableGroup.setAutocompleteEnabled(false);

        assetServicesTemplateVariableGroup.addServiceLocatorVariables(AssetEntryLocalService.class,
                AssetEntryService.class, AssetVocabularyLocalService.class, AssetVocabularyService.class,
                AssetCategoryLocalService.class, AssetCategoryService.class, AssetTagLocalService.class,
                AssetTagService.class, AssetTagStatsLocalService.class);

        templateVariableGroups.put(assetServicesTemplateVariableGroup.getLabel(),
                assetServicesTemplateVariableGroup);

        return templateVariableGroups;
    }

    @Override
    protected String getTemplatesConfigPath() {
        return "com/liferay/asset/publisher/web/portlet/template/dependencies" + "/portlet-display-templates.xml";
    }

    @Reference
    protected Portal portal;

}