content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
   *
   * 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.
   *
   * For further information about Alkacon Software, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://www.opencms.org
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  
  package org.opencms.ui.apps;
  
  import org.opencms.file.CmsObject;
  import org.opencms.main.OpenCms;
  import org.opencms.security.CmsRole;
  import org.opencms.util.CmsMacroResolver;
  import org.opencms.workplace.CmsWorkplace;
  import org.opencms.workplace.tools.I_CmsToolHandler;
  
  import java.util.Locale;
  
  import com.vaadin.server.ExternalResource;
  import com.vaadin.server.Resource;
  
  /**
   * Holding configuration for legacy admin tools.<p>
   */
  public class CmsLegacyAppConfiguration implements I_CmsWorkplaceAppConfiguration {
  
      /** The tool handler. */
      private I_CmsToolHandler m_toolHandler;
  
      /**
       * Constructor.<p>
       *
       * @param toolHandler the tool handler
       */
      public CmsLegacyAppConfiguration(I_CmsToolHandler toolHandler) {
  
          m_toolHandler = toolHandler;
      }
  
      /**
       * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getAppCategory()
       */
      public String getAppCategory() {
  
          return CmsWorkplaceAppManager.LEGACY_CATEGORY_ID;
      }
  
      /**
       * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getAppInstance()
       */
      public I_CmsWorkplaceApp getAppInstance() {
  
          return new CmsLegacyApp(m_toolHandler);
      }
  
      /**
       * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getButtonStyle()
       */
      public String getButtonStyle() {
  
          return I_CmsAppButtonProvider.BUTTON_STYLE_CLASSIC;
      }
  
      /**
       * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getHelpText(java.util.Locale)
       */
      public String getHelpText(Locale locale) {
  
          return CmsMacroResolver.newInstance().setMessages(
              OpenCms.getWorkplaceManager().getMessages(locale)).resolveMacros(m_toolHandler.getHelpText());
      }
  
      /**
       * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getIcon()
       */
      public Resource getIcon() {
  
          return new ExternalResource(CmsWorkplace.getSkinUri() + m_toolHandler.getIconPath());
      }
  
      /**
       * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getId()
       */
      public String getId() {
  
          return m_toolHandler.getPath();
      }
  
      /**
       * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getName(java.util.Locale)
       */
      public String getName(Locale locale) {
  
          return CmsMacroResolver.newInstance().setMessages(
              OpenCms.getWorkplaceManager().getMessages(locale)).resolveMacros(m_toolHandler.getName());
      }
  
      /**
       * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getOrder()
       */
      public int getOrder() {
  
          return 10 + Math.round(m_toolHandler.getPosition());
      }
  
      /**
       * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getPriority()
       */
      public int getPriority() {
  
          return I_CmsWorkplaceAppConfiguration.DEFAULT_PRIORIY;
      }
  
      /**
       * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getRequiredRole()
       */
      public CmsRole getRequiredRole() {
  
          return CmsRole.WORKPLACE_USER;
      }
  
      /**
       * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getVisibility(org.opencms.file.CmsObject)
       */
      public CmsAppVisibilityStatus getVisibility(CmsObject cms) {
  
          boolean visible = cms.existsResource(m_toolHandler.getLink()) && m_toolHandler.isVisible(cms);
          return new CmsAppVisibilityStatus(visible, m_toolHandler.isEnabled(cms), "");
      }
  
  }
  