A_CmsResourcePreview.java

/*
 * 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.ade.galleries.client.preview;

import org.opencms.ade.galleries.client.ui.CmsGalleryDialog;
import org.opencms.ade.galleries.shared.CmsResourceInfoBean;
import org.opencms.ade.galleries.shared.I_CmsGalleryProviderConstants.GalleryMode;
import org.opencms.ade.galleries.shared.rpc.I_CmsPreviewService;
import org.opencms.ade.galleries.shared.rpc.I_CmsPreviewServiceAsync;
import org.opencms.gwt.client.CmsCoreProvider;
import org.opencms.gwt.shared.property.CmsClientProperty;

import com.google.gwt.core.client.GWT;
import com.google.gwt.user.client.rpc.ServiceDefTarget;

/**
 * Preview dialog controller.<p>
 * 
 * This class handles the communication between preview dialog and the server.  
 * 
 * @param <T> the resource info bean type
 * 
 * @since 8.0.0
 */
public abstract class A_CmsResourcePreview<T extends CmsResourceInfoBean> implements I_CmsResourcePreview<T> {

    /** The preview service. */
    private static I_CmsPreviewServiceAsync m_previewService;

    /** The info bean of the binary preview dialog. */
    protected T m_infoBean;

    /** The gallery dialog in which this preview is displayed. */
    private CmsGalleryDialog m_galleryDialog;

    /**
     * Constructor.<p>
     * 
     * @param galleryDialog the gallery dialog instance
     */
    protected A_CmsResourcePreview(CmsGalleryDialog galleryDialog) {

        m_galleryDialog = galleryDialog;
    }

    /**
     * Returns the preview service.<p>
     * 
     * @return the preview service
     */
    protected static I_CmsPreviewServiceAsync getService() {

        if (m_previewService == null) {
            m_previewService = GWT.create(I_CmsPreviewService.class);
            String serviceUrl = CmsCoreProvider.get().link("org.opencms.ade.galleries.CmsPreviewService.gwt");
            ((ServiceDefTarget)m_previewService).setServiceEntryPoint(serviceUrl);
        }
        return m_previewService;
    }

    /**
     * @see org.opencms.ade.galleries.client.preview.I_CmsResourcePreview#getGalleryDialog()
     */
    public CmsGalleryDialog getGalleryDialog() {

        return m_galleryDialog;
    }

    /**
     * @see org.opencms.ade.galleries.client.preview.I_CmsResourcePreview#getGalleryMode()
     */
    public GalleryMode getGalleryMode() {

        return m_galleryDialog.getController().getDialogMode();
    }

    /**
     * @see org.opencms.ade.galleries.client.preview.I_CmsResourcePreview#getHandler()
     */
    public abstract I_CmsPreviewHandler<T> getHandler();

    /**
     * @see org.opencms.ade.galleries.client.preview.I_CmsResourcePreview#getLocale()
     */
    public String getLocale() {

        return m_galleryDialog.getController().getSearchLocale();
    }

    /**
     * @see org.opencms.ade.galleries.client.preview.I_CmsResourcePreview#getResourcePath()
     */
    public String getResourcePath() {

        return m_infoBean.getResourcePath();
    }

    /**
     * @see org.opencms.ade.galleries.client.preview.I_CmsPreviewController#removePreview()
     */
    public void removePreview() {

        getPreviewDialog().removeFromParent();
        m_infoBean = null;
        m_previewService = null;
    }

    /**
     * @see org.opencms.ade.galleries.client.preview.I_CmsResourcePreview#selectResource(java.lang.String, java.lang.String)
     */
    public void selectResource(String resourcePath, String title) {

        switch (getGalleryMode()) {
            case widget:
                CmsPreviewUtil.setResourcePath(resourcePath);
                break;
            case editor:
                CmsPreviewUtil.setLink(resourcePath, title, null);
                CmsPreviewUtil.closeDialog();
                break;
            case ade:
            case view:
            default:
                //nothing to do here, should not be called
                break;
        }
    }

    /**
     * @see org.opencms.ade.galleries.client.preview.I_CmsResourcePreview#setDataInEditor()
     */
    public boolean setDataInEditor() {

        return getHandler().setDataInEditor();
    }

    /**
     * Sets the current resource within the editor or xml-content.<p>
     */
    public void setResource() {

        selectResource(m_infoBean.getResourcePath(), m_infoBean.getProperties().get(CmsClientProperty.PROPERTY_TITLE));
    }

    /**
     * Calls the preview handler to display the given data.<p>
     * 
     * @param resourceInfo the resource info data
     */
    public void showData(T resourceInfo) {

        m_infoBean = resourceInfo;
        getHandler().showData(resourceInfo);
    }
}