org.opencms.widgets.CmsVfsImageWidget Maven / Gradle / Ivy
Show all versions of opencms-core 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.ade.galleries.shared.I_CmsGalleryProviderConstants;
import org.opencms.file.CmsObject;
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.loader.CmsImageScaler;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;
import org.opencms.util.CmsMacroResolver;
import org.opencms.util.CmsStringUtil;
import org.opencms.workplace.CmsDialog;
import org.opencms.workplace.CmsWorkplace;
import org.opencms.xml.types.CmsXmlVfsImageValue;
import java.util.List;
import java.util.Map;
import org.apache.commons.logging.Log;
/**
* Provides a widget for an extended image selection using the advanced gallery dialog.
*
* @since 7.5.0
*/
public class CmsVfsImageWidget extends CmsAdeImageGalleryWidget {
/** The static log object for this class. */
private static final Log LOG = CmsLog.getLog(CmsVfsImageWidget.class);
/** Input field prefix for the description field. */
private static final String PREFIX_DESCRIPTION = "desc.";
/** Input field prefix for the format field. */
private static final String PREFIX_FORMAT = "format.";
/** Input field prefix for the hidden format value field. */
private static final String PREFIX_FORMATVALUE = "fmtval.";
/** Input field prefix for the image field. */
private static final String PREFIX_IMAGE = "img.";
/** Input field prefix for the image ratio field. */
private static final String PREFIX_IMAGERATIO = "imgrat.";
/** Input field prefix for the hidden scale field. */
private static final String PREFIX_SCALE = "scale.";
/**
* Creates a new image widget.
*/
public CmsVfsImageWidget() {
// empty constructor is required for class registration
super();
}
/**
* Creates an image widget with the specified configuration options.
*
* @param configuration the configuration (possible options) for the image widget
*/
public CmsVfsImageWidget(String configuration) {
super(configuration);
}
/**
* @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 image widget
result.append(getJSIncludeFile(CmsWorkplace.getSkinUri() + "components/widgets/vfsimage.js"));
return result.toString();
}
/**
* @see org.opencms.widgets.I_CmsWidget#getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)
*/
@Override
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;
}
// cast parameter to xml value to access the specific methods
CmsXmlVfsImageValue value = (CmsXmlVfsImageValue)param;
String imageLink = value.getRequestLink(cms);
if (imageLink == null) {
imageLink = "";
}
StringBuffer result = new StringBuffer(4096);
result.append("
");
result.append("");
result.append("");
result.append("");
result.append(widgetDialog.getMessages().key(Messages.GUI_EDITOR_LABEL_IMAGE_PATH_0));
result.append(" ");
result.append("");
result.append("");
result.append(" ");
result.append(widgetDialog.dialogHorizontalSpacer(10));
result.append(
"");
result.append(
widgetDialog.button(
getOpenGalleryCall(cms, widgetDialog, param, idHash),
null,
getGalleryName() + "gallery",
Messages.getButtonName(getGalleryName()),
widgetDialog.getButtonStyle()));
// create preview button
String previewClass = "hide";
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(imageLink)) {
// show button if preview is enabled
previewClass = "show";
}
result.append("");
result.append("");
result.append(
widgetDialog.button(
getOpenPreviewCall(widgetDialog, PREFIX_IMAGE + param.getId()),
null,
"preview.png",
Messages.GUI_BUTTON_PREVIEW_0,
widgetDialog.getButtonStyle()));
result.append("
");
result.append("
");
JSONObject additional = null;
try {
additional = getAdditionalGalleryInfo(
cms,
widgetDialog instanceof CmsDialog ? ((CmsDialog)widgetDialog).getParamResource() : null,
widgetDialog.getMessages(),
param);
} catch (JSONException e) {
LOG.error("Error parsing widget configuration", e);
}
if (additional != null) {
result.append("\n");
}
CmsVfsImageWidgetConfiguration configuration = getWidgetConfiguration(cms, widgetDialog.getMessages(), param);
String format = value.getFormat(cms);
if (configuration.isShowFormat()) {
// show the format select box, also create hidden format value field
result.append("");
result.append("");
result.append(widgetDialog.getMessages().key(Messages.GUI_EDITOR_LABEL_IMAGE_FORMAT_0));
result.append(" ");
result.append("");
result.append("");
result.append(" ");
result.append(" ");
List formatValues = configuration.getFormatValues();
String selectedFormat = "";
try {
selectedFormat = formatValues.get(selectedIndex);
} catch (Exception e) {
// ignore, just didn't find a matching format value
}
// create hidden field to store the matching image format value
result.append("");
// create hidden field to store image ratio
String ratio = "";
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(imageLink)) {
// an image is specified, calculate ratio
try {
CmsImageScaler scaler = new CmsImageScaler(cms, cms.readResource(imageLink));
float r = scaler.getWidth() / (float)scaler.getHeight();
ratio = String.valueOf(r);
} catch (CmsException e) {
// ignore, image not found in VFS
}
}
result.append("");
// add possible format names and values as JS variables to access them from image gallery window
result.append("\n");
} else {
result.append("");
result.append("");
result.append("\n");
}
String description = value.getDescription(cms);
if (description == null) {
description = "";
}
if (configuration.isShowDescription()) {
result.append("");
result.append("");
result.append(widgetDialog.getMessages().key(Messages.GUI_EDITOR_LABEL_IMAGE_DESC_0));
result.append(" ");
result.append("");
result.append("");
result.append(" ");
result.append(" ");
} else {
result.append("");
}
result.append("
");
String scale = value.getScaleOptions(cms);
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(configuration.getScaleParams())
&& (scale.indexOf(configuration.getScaleParams()) == -1)) {
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(scale)) {
scale += ",";
}
scale += configuration.getScaleParams();
}
result.append("");
result.append(" ");
return result.toString();
}
/**
* @see org.opencms.widgets.I_CmsADEWidget#getWidgetName()
*/
@Override
public String getWidgetName() {
return CmsVfsImageWidget.class.getName();
}
/**
* @see org.opencms.widgets.A_CmsWidget#getWidgetStringValue(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)
*/
@Override
public String getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) {
String result = super.getWidgetStringValue(cms, widgetDialog, param);
String configuration = CmsMacroResolver.resolveMacros(getConfiguration(), cms, widgetDialog.getMessages());
if (configuration == null) {
configuration = param.getDefault(cms);
}
List options = CmsSelectWidgetOption.parseOptions(configuration);
for (int m = 0; m < options.size(); m++) {
CmsSelectWidgetOption option = options.get(m);
if (result.equals(option.getValue())) {
result = option.getOption();
break;
}
}
return result;
}
/**
* @see org.opencms.widgets.I_CmsWidget#newInstance()
*/
@Override
public I_CmsWidget newInstance() {
return new CmsVfsImageWidget(getConfiguration());
}
/**
* @see org.opencms.widgets.I_CmsWidget#setEditorValue(org.opencms.file.CmsObject, java.util.Map, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)
*/
@Override
public void setEditorValue(
CmsObject cms,
Map formParameters,
I_CmsWidgetDialog widgetDialog,
I_CmsWidgetParameter param) {
String[] imgValues = formParameters.get(PREFIX_IMAGE + param.getId());
if ((imgValues != null) && (imgValues.length > 0)) {
param.setStringValue(cms, imgValues[0]);
}
CmsXmlVfsImageValue value = (CmsXmlVfsImageValue)param;
String[] descValues = formParameters.get(PREFIX_DESCRIPTION + param.getId());
value.setDescription(cms, descValues[0]);
String[] formatValues = formParameters.get(PREFIX_FORMAT + param.getId());
value.setFormat(cms, formatValues[0]);
String[] scaleValues = formParameters.get(PREFIX_SCALE + param.getId());
value.setScaleOptions(cms, scaleValues[0]);
}
/**
* @see org.opencms.widgets.CmsAdeImageGalleryWidget#getAdditionalGalleryInfo(org.opencms.file.CmsObject, java.lang.String, org.opencms.i18n.CmsMessages, org.opencms.widgets.I_CmsWidgetParameter)
*/
@Override
protected JSONObject getAdditionalGalleryInfo(
CmsObject cms,
String resource,
CmsMessages messages,
I_CmsWidgetParameter param) throws JSONException {
JSONObject result = super.getAdditionalGalleryInfo(cms, resource, messages, param);
result.put("isAdvancedWidget", true);
return result;
}
/**
* @see org.opencms.widgets.A_CmsAdeGalleryWidget#getGalleryOpenParams(org.opencms.file.CmsObject, org.opencms.i18n.CmsMessages, org.opencms.widgets.I_CmsWidgetParameter, java.lang.String, long)
*/
@Override
protected Map getGalleryOpenParams(
CmsObject cms,
CmsMessages widgetDialog,
I_CmsWidgetParameter param,
String resource,
long hashId) {
Map result = super.getGalleryOpenParams(cms, widgetDialog, param, resource, hashId);
// the current element value will be read by java-script including the image input field and the scale input field
StringBuffer currentElement = new StringBuffer("'+document.getElementById('");
if (param != null) {
currentElement.append(PREFIX_IMAGE).append(param.getId());
}
currentElement.append("').getAttribute('value')+'");
// only try reading scale and format info if formats are used
if (param != null) {
if (getWidgetConfiguration(cms, widgetDialog, param).isShowFormat()) {
currentElement.append("%3F__scale%3D'+document.getElementById('");
currentElement.append(PREFIX_SCALE).append(param.getId()).append("').getAttribute('value')+'");
currentElement.append("%26format%3D'+escape(document.getElementById('").append(PREFIX_FORMAT).append(
param.getId()).append("')[document.getElementById('").append(PREFIX_FORMAT).append(
param.getId()).append("').selectedIndex].value)+'");
}
}
result.put(I_CmsGalleryProviderConstants.CONFIG_CURRENT_ELEMENT, currentElement.toString());
return result;
}
/**
* Returns the currently selected value of the select widget.
*
* If a value is found in the given parameter, this is used. Otherwise
* the default value of the select options are used. If there is neither a parameter value
* nor a default value, null is returned.
*
* @param cms the current users OpenCms context
* @param selectOptions the available select options
* @param currentValue the current value that is selected
*
* @return the currently selected value of the select widget
*/
protected String getSelectedValue(CmsObject cms, List selectOptions, String currentValue) {
String paramValue = currentValue;
if (CmsStringUtil.isEmpty(paramValue)) {
CmsSelectWidgetOption option = CmsSelectWidgetOption.getDefaultOption(selectOptions);
if (option != null) {
paramValue = option.getValue();
}
}
return paramValue;
}
}