org.opencms.ui.apps.CmsSitemapEditorConfiguration Maven / Gradle / Ivy
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH (http://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: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://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.ade.configuration.CmsADEManager;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.ui.A_CmsUI;
import org.opencms.ui.components.OpenCmsTheme;
import org.opencms.util.CmsStringUtil;
import java.util.Locale;
import org.apache.commons.logging.Log;
import com.vaadin.server.ExternalResource;
import com.vaadin.server.Resource;
import com.vaadin.ui.Notification;
import com.vaadin.ui.Notification.Type;
/**
* The sitemap editor app configuration.
*/
public class CmsSitemapEditorConfiguration extends A_CmsWorkplaceAppConfiguration implements I_CmsHasAppLaunchCommand {
/** The app id. */
public static final String APP_ID = "sitemapeditor";
/** Logger instance for this class. */
private static final Log LOG = CmsLog.getLog(CmsSitemapEditorConfiguration.class);
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getAppCategory()
*/
@Override
public String getAppCategory() {
return "Main";
}
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getAppInstance()
*/
public I_CmsWorkplaceApp getAppInstance() {
throw new IllegalStateException("The sitemap app should be launched through the app launch command only.");
}
/**
* @see org.opencms.ui.apps.I_CmsHasAppLaunchCommand#getAppLaunchCommand()
*/
public Runnable getAppLaunchCommand() {
return new Runnable() {
public void run() {
openSitemapEditor();
}
};
}
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getButtonStyle()
*/
@Override
public String getButtonStyle() {
return I_CmsAppButtonProvider.BUTTON_STYLE_TRANSPARENT;
}
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getHelpText(java.util.Locale)
*/
@Override
public String getHelpText(Locale locale) {
return Messages.get().getBundle(locale).key(Messages.GUI_SITEMAP_HELP_0);
}
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getIcon()
*/
public Resource getIcon() {
return new ExternalResource(OpenCmsTheme.getImageLink("apps/sitemap.png"));
}
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getId()
*/
public String getId() {
return APP_ID;
}
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getName(java.util.Locale)
*/
@Override
public String getName(Locale locale) {
return Messages.get().getBundle(locale).key(Messages.GUI_SITEMAP_TITLE_0);
}
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getOrder()
*/
@Override
public int getOrder() {
return 2;
}
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getPriority()
*/
@Override
public int getPriority() {
return I_CmsWorkplaceAppConfiguration.DEFAULT_PRIORIY;
}
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getVisibility(org.opencms.file.CmsObject)
*/
@Override
public CmsAppVisibilityStatus getVisibility(CmsObject cms) {
return new CmsAppVisibilityStatus(true, true, null);
}
/**
* Opens the sitemap editor for the current site.
*/
void openSitemapEditor() {
CmsObject cms = A_CmsUI.getCmsObject();
String siteRoot = cms.getRequestContext().getSiteRoot();
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(siteRoot)
&& !OpenCms.getSiteManager().getSharedFolder().equals(siteRoot)) {
try {
CmsResource res = cms.readResource(CmsADEManager.PATH_SITEMAP_EDITOR_JSP);
String link = OpenCms.getLinkManager().substituteLink(cms, res);
A_CmsUI.get().getPage().setLocation(link);
return;
} catch (CmsException e) {
LOG.debug("Unable to open sitemap editor.", e);
}
}
Notification.show("The sitemap editor is not available for the current site.", Type.WARNING_MESSAGE);
}
}