libreccm-legacy/ccm-cms-assets-imagestep/src/com/arsdigita/cms/contentassets/ui/ImageStep.java

/*
 * Copyright (C) 2001-2004 Red Hat Inc. All Rights Reserved.
 *
 * 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.
 * 
 * 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 com.arsdigita.cms.contentassets.ui;

import com.arsdigita.bebop.AbstractSingleSelectionModel;
import com.arsdigita.bebop.Page;
import com.arsdigita.bebop.PageState;
import com.arsdigita.bebop.RequestLocal;
import com.arsdigita.bebop.event.ActionEvent;
import com.arsdigita.bebop.event.ActionListener;
import com.arsdigita.bebop.parameters.ParameterModel;
import com.arsdigita.cms.ContentItem;
import com.arsdigita.cms.ItemSelectionModel;
import com.arsdigita.cms.contentassets.ItemImageAttachment;
import com.arsdigita.cms.contentassets.util.ImageStepGlobalizationUtil;
import com.arsdigita.cms.ui.ImageComponent;
import com.arsdigita.cms.ui.SecurityPropertyEditor;
import com.arsdigita.cms.ui.authoring.AuthoringKitWizard;
import com.arsdigita.cms.ui.workflow.WorkflowLockedComponentAccess;
import com.arsdigita.domain.DomainObjectFactory;
import com.arsdigita.persistence.OID;
import com.arsdigita.toolbox.ui.OIDParameter;
import java.util.Iterator;
import org.apache.log4j.Logger;

/**
 * Pluggable authoring step as the main entry point to add an ImageAsset to a
 * content item.
 *
 * @author unknown
 * @author Sören Bernstein <quasi@quasiweb.de>
 */
public class ImageStep extends SecurityPropertyEditor {

	private static final Logger s_log = Logger.getLogger(ImageStep.class);
	private final ItemSelectionModel m_itemSelection;
	private final AttachmentSelectionModel m_attachmentSelection;
	private final AuthoringKitWizard m_parent;
	private final ImageStepDisplay m_display;
	private final ImageStepEdit m_add;
	private final OIDParameter m_attachmentOID;

	/**
	 * Constructor.
	 *
	 * @param itemModel The {@link ItemSelectionModel} to use with this
	 * instance
	 * @param parent The parent {@link AuthoringKitWizard}
	 */
	public ImageStep(ItemSelectionModel itemModel,
		AuthoringKitWizard parent) {
		super();

		m_itemSelection = itemModel;
		m_parent = parent;

		m_attachmentOID = new OIDParameter("attachmentID");
		m_attachmentSelection = new AttachmentSelectionModel();


		/* Create ImageEditStep to add images to the current item            */
		m_add = new ImageStepEdit(this);
		WorkflowLockedComponentAccess addCA =
			new WorkflowLockedComponentAccess(m_add, m_itemSelection);
		addComponent("add",
			ImageStepGlobalizationUtil.globalize(
			"cms.contentassets.ui.image_step.add_image"),
			addCA);

		/* ImageDisplayStep to display all already attached images           */
		m_display = new ImageStepDisplay(this); // Component to display
		setDisplayComponent(m_display);           // all attached images.

		Iterator imageComponents = m_add.getImageComponents();
		while (imageComponents.hasNext()) {
			ImageComponent component =
				(ImageComponent) imageComponents.next();

			addListeners(component.getForm(),
				component.getSaveCancelSection().getCancelButton());
		}

		m_parent.getList().addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(ActionEvent event) {
				PageState state = event.getPageState();
				showDisplayPane(state);
			}
		});
	}

	@Override
	public void register(Page p) {
		super.register(p);

		p.addComponentStateParam(this, m_attachmentOID);
	}

	/**
	 * @return the parent wizard
	 */
	public AuthoringKitWizard getParentWizard() {
		return m_parent;
	}

	/**
	 * @return The item selection model
	 */
	public ItemSelectionModel getItemSelectionModel() {
		return m_itemSelection;
	}

	/**
	 * @return The currently selected item, null if there isn't one.
	 */
	public ContentItem getItem(PageState ps) {
		return m_itemSelection.getSelectedItem(ps);
	}

	/**
	 * @return The currently selected item, null if there isn't one.
	 */
	public ItemImageAttachment getAttachment(PageState ps) {
		return (ItemImageAttachment) m_attachmentSelection.getSelectedAttachment(ps);
	}

	private class AttachmentSelectionModel
		extends AbstractSingleSelectionModel {

		private final RequestLocal m_attachment = new RequestLocal() {
			@Override
			protected Object initialValue(PageState ps) {
				OID oid = (OID) getSelectedKey(ps);
				if (null == oid) {
					return null;
				}

				return DomainObjectFactory.newInstance(oid);
			}
		};

		@Override
		public Object getSelectedKey(PageState ps) {
			OID oid = (OID) ps.getValue(m_attachmentOID);
			if (null == oid) {
				return null;
			}

			return oid;
		}

		@Override
		public void setSelectedKey(PageState ps, Object oid) {
			m_attachment.set(ps, null);
			ps.setValue(m_attachmentOID, oid);
		}

		public ItemImageAttachment getSelectedAttachment(PageState ps) {
			return (ItemImageAttachment) m_attachment.get(ps);
		}

		public void setSelectedAttachment(PageState ps,
			ItemImageAttachment attachment) {
			setSelectedKey(ps, attachment);
			m_attachment.set(ps, attachment);
		}

		@Override
		public ParameterModel getStateParameter() {
			return m_attachmentOID;
		}
	}

	/**
	 * Show display pane.
	 *
	 * Also, reset the forms for reuse.
	 *
	 * @param state
	 */
	@Override
	public void showDisplayPane(PageState state) {
		super.showDisplayPane(state);
		m_add.reset(state);
	}
}