org.opencms.widgets.A_CmsGalleryWidget Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (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 GmbH & Co. KG, 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.widgets;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.i18n.CmsEncoder;
import org.opencms.i18n.CmsMessages;
import org.opencms.json.JSONArray;
import org.opencms.json.JSONException;
import org.opencms.json.JSONObject;
import org.opencms.util.CmsStringUtil;
import org.opencms.workplace.CmsWorkplace;
import org.opencms.workplace.galleries.A_CmsAjaxGallery;
import org.opencms.xml.content.I_CmsXmlContentHandler.DisplayType;
import org.opencms.xml.types.A_CmsXmlContentValue;
import java.util.List;
import java.util.Locale;
/**
* Base class for all gallery widget implementations.
*
* @since 6.0.0
*/
public abstract class A_CmsGalleryWidget extends A_CmsWidget implements I_CmsADEWidget {
/**
* Creates a new gallery widget.
*/
protected A_CmsGalleryWidget() {
// empty constructor is required for class registration
this("");
}
/**
* Creates a new gallery widget with the given configuration.
*
* @param configuration the configuration to use
*/
protected A_CmsGalleryWidget(String configuration) {
super(configuration);
}
/**
* @see org.opencms.widgets.I_CmsADEWidget#getConfiguration(org.opencms.file.CmsObject, org.opencms.xml.types.A_CmsXmlContentValue, org.opencms.i18n.CmsMessages, org.opencms.file.CmsResource, java.util.Locale)
*/
public String getConfiguration(
CmsObject cms,
A_CmsXmlContentValue schemaType,
CmsMessages messages,
CmsResource resource,
Locale contentLocale) {
CmsGalleryWidgetConfiguration config = new CmsGalleryWidgetConfiguration(
cms,
messages,
schemaType,
getConfiguration());
JSONObject linkGalleryInfo = new JSONObject();
try {
linkGalleryInfo.put("startupfolder", config.getStartup());
linkGalleryInfo.put("startuptype", config.getType());
linkGalleryInfo.put("editedresource", resource.getRootPath());
} catch (JSONException e) {
// TODO: Auto-generated catch block
e.printStackTrace();
}
return "¶ms=" + linkGalleryInfo.toString();
}
/**
* @see org.opencms.widgets.I_CmsADEWidget#getCssResourceLinks(org.opencms.file.CmsObject)
*/
public List getCssResourceLinks(CmsObject cms) {
// TODO: Auto-generated method stub
return null;
}
/**
* @see org.opencms.widgets.I_CmsADEWidget#getDefaultDisplayType()
*/
public DisplayType getDefaultDisplayType() {
return DisplayType.wide;
}
/**
* @see org.opencms.widgets.I_CmsWidget#getDialogIncludes(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)
*/
@Override
public String getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog) {
StringBuffer result = new StringBuffer(256);
// import the JavaScript for the gallery widget
result.append(
getJSIncludeFile(CmsWorkplace.getSkinUri() + "components/widgets/" + getNameLower() + "gallery.js"));
return result.toString();
}
/**
* @see org.opencms.widgets.I_CmsWidget#getDialogInitCall(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)
*/
@Override
public String getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog) {
return "\tinit" + getNameUpper() + "Gallery();\n";
}
/**
* @see org.opencms.widgets.I_CmsWidget#getDialogInitMethod(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)
*/
@Override
public String getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog) {
StringBuffer result = new StringBuffer(16);
result.append("function init");
result.append(getNameUpper());
result.append("Gallery() {\n");
result.append("\t");
result.append(getNameLower());
result.append("GalleryPath = '");
// path to download/image/link/html/table gallery
result.append(A_CmsAjaxGallery.PATH_GALLERIES);
result.append(getNameLower());
result.append("gallery/index.jsp?");
result.append("';\n");
result.append("}\n");
return result.toString();
}
/**
* @see org.opencms.widgets.I_CmsWidget#getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)
*/
public String getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) {
String id = param.getId();
long idHash = id.hashCode();
if (idHash < 0) {
// negative hash codes will not work as JS variable names, so convert them
idHash = -idHash;
// add 2^32 to the value to ensure that it is unique
idHash += 4294967296L;
}
StringBuffer result = new StringBuffer(128);
result.append("");
result.append("");
result.append(" ");
result.append(widgetDialog.dialogHorizontalSpacer(10));
result.append(
"");
result.append(
widgetDialog.button(
"javascript:open"
+ getNameUpper()
+ "Gallery('"
+ A_CmsAjaxGallery.MODE_WIDGET
+ "', '"
+ id
+ "', '"
+ idHash
+ "');return false;",
null,
getNameLower() + "gallery",
Messages.getButtonName(getNameLower()),
widgetDialog.getButtonStyle()));
// create preview button
String previewClass = "hide";
if (showPreview(value)) {
// show button if preview is enabled
previewClass = "show";
}
result.append("");
result.append("");
result.append(
widgetDialog.button(
"javascript:preview" + getNameUpper() + "('" + id + "');return false;",
null,
"preview.png",
Messages.GUI_BUTTON_PREVIEW_0,
widgetDialog.getButtonStyle()));
result.append("
");
result.append("
");
result.append("
");
result.append(" ");
if (getNameLower().equals("image")) {
// reads the configuration String for this widget
CmsVfsImageWidgetConfiguration configuration = new CmsVfsImageWidgetConfiguration(
cms,
widgetDialog.getMessages(),
param,
getConfiguration());
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(configuration.getStartup())) {
result.append("\n");
} else {
result.append("\n");
}
//This part is not used in javascript for now
if (configuration.isShowFormat()) {
// create hidden field to store the matching image format value
result.append("\n");
} else {
result.append("\n");
}
} else { // for download, link, html or table galleries
// reads the configuration String for this widget
CmsGalleryWidgetConfiguration configuration = new CmsGalleryWidgetConfiguration(
cms,
widgetDialog.getMessages(),
param,
getConfiguration());
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(configuration.getStartup())) {
result.append("\n");
} else {
result.append("\n");
}
}
return result.toString();
}
/**
* @see org.opencms.widgets.I_CmsADEWidget#getInitCall()
*/
public String getInitCall() {
return null;
}
/**
* @see org.opencms.widgets.I_CmsADEWidget#getJavaScriptResourceLinks(org.opencms.file.CmsObject)
*/
public List getJavaScriptResourceLinks(CmsObject cms) {
return null;
}
/**
* Returns the lower case name of the gallery, for example "html".
*
* @return the lower case name of the gallery
*/
public abstract String getNameLower();
/**
* Returns the upper case name of the gallery, for example "Html".
*
* @return the upper case name of the gallery
*/
public abstract String getNameUpper();
/**
* @see org.opencms.widgets.I_CmsADEWidget#getWidgetName()
*/
public String getWidgetName() {
return A_CmsGalleryWidget.class.getName();
}
/**
* @see org.opencms.widgets.A_CmsWidget#isCompactViewEnabled()
*/
@Override
public boolean isCompactViewEnabled() {
return false;
}
/**
* @see org.opencms.widgets.I_CmsADEWidget#isInternal()
*/
public boolean isInternal() {
return true;
}
/**
* Returns true if the preview button should be shown.
*
* @param value the current widget value
* @return true if the preview button should be shown
*/
public abstract boolean showPreview(String value);
}