org.opencms.ade.galleries.client.ui.CmsResultItemWidget Maven / Gradle / Ivy
Show all versions of opencms-gwt 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, 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.ade.galleries.client.ui;
import org.opencms.ade.galleries.client.ui.css.I_CmsLayoutBundle;
import org.opencms.ade.galleries.shared.CmsResultItemBean;
import org.opencms.gwt.client.CmsCoreProvider;
import org.opencms.gwt.client.dnd.I_CmsDragHandle;
import org.opencms.gwt.client.dnd.I_CmsDraggable;
import org.opencms.gwt.client.ui.CmsListItemWidget;
import org.opencms.gwt.client.ui.input.CmsLabel.I_TitleGenerator;
import org.opencms.gwt.client.util.CmsClientStringUtil;
import org.opencms.gwt.client.util.CmsToolTipHandler;
import org.opencms.gwt.shared.CmsAdditionalInfoBean;
import org.opencms.gwt.shared.CmsGwtConstants;
import org.opencms.gwt.shared.CmsIconUtil;
import org.opencms.gwt.shared.CmsListInfoBean;
import org.opencms.util.CmsStringUtil;
import com.google.gwt.user.client.ui.HTML;
/**
* The result list item widget.
*
* Enabling the image tile view.
*
* @since 8.0.0
*/
public class CmsResultItemWidget extends CmsListItemWidget {
/**
* Widget containing the image(s) for a result list item..
*/
public class ImageTile extends HTML implements I_CmsDragHandle {
/** The draggable result list item. */
private I_CmsDraggable m_draggable;
/**
* Creates a new instance with the given content.
*
* @param content the HTML content
*/
public ImageTile(String content) {
super(content);
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDragHandle#getDraggable()
*/
public I_CmsDraggable getDraggable() {
return m_draggable;
}
/**
* Sets the draggable widget.
*
* @param draggable the draggable widget
*/
public void setDraggable(I_CmsDraggable draggable) {
m_draggable = draggable;
}
}
/** Standard image tile scale parameter. */
private static final String IMAGE_SCALE_PARAM = "?__scale=t:1,c:ffffff,r:0";
/** Tile view flag. */
private boolean m_hasTileView;
/** The tool tip handler. */
private CmsToolTipHandler m_tooltipHandler;
/** The image tile. */
private ImageTile m_imageTile;
/**
* Constructor.
*
* @param infoBean the resource info bean
* @param showPath true to show the resource path in sub title
*/
public CmsResultItemWidget(CmsResultItemBean infoBean, boolean showPath) {
super(infoBean);
if (showPath) {
setSubtitleLabel(infoBean.getPath());
setSubtitleTitle(infoBean.getSubTitle());
} else {
setSubtitleTitle(infoBean.getPath());
}
String type = infoBean.getType();
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(infoBean.getPseudoType())) {
type = infoBean.getPseudoType();
}
String detailIconClasses = null;
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(infoBean.getDetailResourceType())) {
detailIconClasses = CmsIconUtil.getResourceIconClasses(infoBean.getDetailResourceType(), true);
if (CmsGwtConstants.TYPE_CONTAINERPAGE.equals(infoBean.getResourceType())) {
detailIconClasses += " " + I_CmsLayoutBundle.INSTANCE.listItemWidgetCss().pageDetailType();
}
}
setIcon(CmsIconUtil.getResourceIconClasses(type, infoBean.getPath(), false), detailIconClasses);
// if resourceType=="image" prepare for tile view
if (CmsResultsTab.isImagelikeType(infoBean.getType())) {
m_hasTileView = true;
// add tile view marker css classes
String src = infoBean.getViewLink();
if (src == null) {
src = CmsCoreProvider.get().link(infoBean.getPath());
}
String timeParam = "&time=" + System.currentTimeMillis();
// insert tile view image div
ImageTile imageTile = new ImageTile("![](\"")
"
// using a second image tag for the small thumbnail variant
+ ""
+ "
");
imageTile.setStyleName(I_CmsLayoutBundle.INSTANCE.galleryResultItemCss().imageTile());
m_imageTile = imageTile;
m_tooltipHandler = new CmsToolTipHandler(imageTile, generateTooltipHtml(infoBean));
m_contentPanel.insert(imageTile, 0);
}
}
/**
* Gets the image tile.
*
* @return the image tile
*/
public ImageTile getImageTile() {
return m_imageTile;
}
/**
* Indicates wther there is a tile view available for this widget.
*
* @return true if a tiled view is available
*/
public boolean hasTileView() {
return m_hasTileView;
}
/**
* Initializes the title attribute of the subtitle line.
*
* @param subtitleTitle the value to set
*/
public void setSubtitleTitle(final String subtitleTitle) {
m_subtitle.setTitle(subtitleTitle);
m_subtitle.setTitleGenerator(new I_TitleGenerator() {
public String getTitle(String originalText) {
return subtitleTitle;
}
});
}
/**
* @see com.google.gwt.user.client.ui.Composite#onDetach()
*/
@Override
protected void onDetach() {
if (m_tooltipHandler != null) {
m_tooltipHandler.clearShowing();
}
super.onDetach();
}
/**
* Generates the HTML for the item tool-tip.
*
* @param infoBean the item info
*
* @return the generated HTML
*/
private String generateTooltipHtml(CmsListInfoBean infoBean) {
StringBuffer result = new StringBuffer();
result.append("
").append(CmsClientStringUtil.shortenString(infoBean.getTitle(), 70)).append("
");
if (infoBean.hasAdditionalInfo()) {
for (CmsAdditionalInfoBean additionalInfo : infoBean.getAdditionalInfo()) {
result.append("").append(additionalInfo.getName()).append(": ");
// shorten the value to max 45 characters
result.append(CmsClientStringUtil.shortenString(additionalInfo.getValue(), 45)).append("
");
}
}
return result.toString();
}
/**
* Returns the scale parameter for big thumbnail images.
*
* @return the scale parameter
*/
private String getBigImageScaleParam() {
return IMAGE_SCALE_PARAM
+ ",w:"
+ I_CmsLayoutBundle.INSTANCE.galleryResultItemCss().bigImageWidth()
+ ",h:"
+ I_CmsLayoutBundle.INSTANCE.galleryResultItemCss().bigImageHeight();
}
/**
* Returns the scale parameter for small thumbnail images.
*
* @param infoBean the resource info
*
* @return the scale parameter
*/
private String getSmallImageScaleParam(CmsResultItemBean infoBean) {
String result = null;
if (infoBean.getDimension() != null) {
String[] sizes = infoBean.getDimension().split("x");
try {
int width = Integer.parseInt(sizes[0].trim());
int height = Integer.parseInt(sizes[1].trim());
// only use the small image dimensions in case of dimensions smaller than the big thumbnail
if ((I_CmsLayoutBundle.INSTANCE.galleryResultItemCss().bigImageWidth() > width)
|| (I_CmsLayoutBundle.INSTANCE.galleryResultItemCss().bigImageHeight() > height)) {
result = IMAGE_SCALE_PARAM
+ ",w:"
+ I_CmsLayoutBundle.INSTANCE.galleryResultItemCss().smallImageWidth()
+ ",h:"
+ I_CmsLayoutBundle.INSTANCE.galleryResultItemCss().smallImageHeight();
}
} catch (Exception e) {
// failed parsing the dimensions, will use big image
}
}
if (result == null) {
result = getBigImageScaleParam();
}
return result;
}
}