X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=org.argeo.cms%2Fsrc%2Forg%2Fargeo%2Fcms%2Fviewers%2FAbstractPageViewer.java;fp=org.argeo.cms%2Fsrc%2Forg%2Fargeo%2Fcms%2Fviewers%2FAbstractPageViewer.java;h=5e6de37097ea226c9a0165eb16666739c13e1f3c;hb=998cdf60d00ffc35d987bdb373a9676b095f16f8;hp=0000000000000000000000000000000000000000;hpb=fe9129fa0539f717ce18f0e42829ff3f31559c3b;p=lgpl%2Fargeo-commons.git

diff --git a/org.argeo.cms/src/org/argeo/cms/viewers/AbstractPageViewer.java b/org.argeo.cms/src/org/argeo/cms/viewers/AbstractPageViewer.java
new file mode 100644
index 000000000..5e6de3709
--- /dev/null
+++ b/org.argeo.cms/src/org/argeo/cms/viewers/AbstractPageViewer.java
@@ -0,0 +1,239 @@
+package org.argeo.cms.viewers;
+
+import java.util.Observable;
+import java.util.Observer;
+
+import javax.jcr.Node;
+import javax.jcr.RepositoryException;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.argeo.cms.CmsEditable;
+import org.argeo.cms.CmsException;
+import org.argeo.cms.widgets.ScrolledPage;
+import org.eclipse.jface.viewers.ContentViewer;
+import org.eclipse.jface.viewers.ISelection;
+import org.eclipse.jface.viewers.StructuredSelection;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.events.MouseAdapter;
+import org.eclipse.swt.events.MouseListener;
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Control;
+import org.eclipse.swt.widgets.Widget;
+
+/** Base class for viewers related to a page */
+public abstract class AbstractPageViewer extends ContentViewer implements
+		Observer {
+	private static final long serialVersionUID = 5438688173410341485L;
+
+	private final static Log log = LogFactory.getLog(AbstractPageViewer.class);
+
+	private final boolean readOnly;
+	/** The basis for the layouts, typically a ScrolledPage. */
+	private final Composite page;
+	private final CmsEditable cmsEditable;
+
+	private MouseListener mouseListener;
+
+	private EditablePart edited;
+	private ISelection selection = StructuredSelection.EMPTY;
+
+	protected AbstractPageViewer(Section parent, int style,
+			CmsEditable cmsEditable) {
+		// read only at UI level
+		readOnly = SWT.READ_ONLY == (style & SWT.READ_ONLY);
+
+		this.cmsEditable = cmsEditable == null ? CmsEditable.NON_EDITABLE
+				: cmsEditable;
+		if (this.cmsEditable instanceof Observable)
+			((Observable) this.cmsEditable).addObserver(this);
+
+		if (cmsEditable.canEdit()) {
+			mouseListener = createMouseListener();
+		}
+		page = findPage(parent);
+	}
+
+	/**
+	 * Can be called to simplify the called to isModelInitialized() and
+	 * initModel()
+	 */
+	protected void initModelIfNeeded(Node node) {
+		try {
+			if (!isModelInitialized(node))
+				if (getCmsEditable().canEdit()) {
+					initModel(node);
+					node.getSession().save();
+				}
+		} catch (Exception e) {
+			throw new CmsException("Cannot initialize model", e);
+		}
+	}
+
+	/** Called if user can edit and model is not initialized */
+	protected Boolean isModelInitialized(Node node) throws RepositoryException {
+		return true;
+	}
+
+	/** Called if user can edit and model is not initialized */
+	protected void initModel(Node node) throws RepositoryException {
+	}
+
+	/** Create (retrieve) the MouseListener to use. */
+	protected MouseListener createMouseListener() {
+		return new MouseAdapter() {
+			private static final long serialVersionUID = 1L;
+		};
+	}
+
+	protected Composite findPage(Composite composite) {
+		if (composite instanceof ScrolledPage) {
+			return (ScrolledPage) composite;
+		} else {
+			if (composite.getParent() == null)
+				return composite;
+			return findPage(composite.getParent());
+		}
+	}
+
+	@Override
+	public void update(Observable o, Object arg) {
+		if (o == cmsEditable)
+			editingStateChanged(cmsEditable);
+	}
+
+	/** To be overridden in order to provide the actual refresh */
+	protected void refresh(Control control) throws RepositoryException {
+	}
+
+	/** To be overridden.Save the edited part. */
+	protected void save(EditablePart part) throws RepositoryException {
+	}
+
+	/** Prepare the edited part */
+	protected void prepare(EditablePart part, Object caretPosition) {
+	}
+
+	/** Notified when the editing state changed. Does nothing, to be overridden */
+	protected void editingStateChanged(CmsEditable cmsEditable) {
+	}
+
+	@Override
+	public void refresh() {
+		try {
+			if (cmsEditable.canEdit() && !readOnly)
+				mouseListener = createMouseListener();
+			else
+				mouseListener = null;
+			refresh(getControl());
+			layout(getControl());
+		} catch (RepositoryException e) {
+			throw new CmsException("Cannot refresh", e);
+		}
+	}
+
+	@Override
+	public void setSelection(ISelection selection, boolean reveal) {
+		this.selection = selection;
+	}
+
+	protected void updateContent(EditablePart part) throws RepositoryException {
+	}
+
+	// LOW LEVEL EDITION
+	protected void edit(EditablePart part, Object caretPosition) {
+		try {
+			if (edited == part)
+				return;
+
+			if (edited != null && edited != part)
+				stopEditing(true);
+
+			part.startEditing();
+			updateContent(part);
+			prepare(part, caretPosition);
+			edited = part;
+			layout(part.getControl());
+		} catch (RepositoryException e) {
+			throw new CmsException("Cannot edit " + part, e);
+		}
+	}
+
+	private void stopEditing(Boolean save) throws RepositoryException {
+		if (edited instanceof Widget && ((Widget) edited).isDisposed()) {
+			edited = null;
+			return;
+		}
+
+		assert edited != null;
+		if (edited == null) {
+			if (log.isTraceEnabled())
+				log.warn("Told to stop editing while not editing anything");
+			return;
+		}
+
+		if (save)
+			save(edited);
+
+		edited.stopEditing();
+		updateContent(edited);
+		layout(((EditablePart) edited).getControl());
+		edited = null;
+	}
+
+	// METHODS AVAILABLE TO EXTENDING CLASSES
+	protected void saveEdit() {
+		try {
+			if (edited != null)
+				stopEditing(true);
+		} catch (RepositoryException e) {
+			throw new CmsException("Cannot stop editing", e);
+		}
+	}
+
+	protected void cancelEdit() {
+		try {
+			if (edited != null)
+				stopEditing(false);
+		} catch (RepositoryException e) {
+			throw new CmsException("Cannot cancel editing", e);
+		}
+	}
+
+	/** Layout this controls from the related base page. */
+	public void layout(Control... controls) {
+		page.layout(controls);
+	}
+
+	// UTILITIES
+	/** Check whether the edited part is in a proper state */
+	protected void checkEdited() {
+		if (edited == null || (edited instanceof Widget)
+				&& ((Widget) edited).isDisposed())
+			throw new CmsException(
+					"Edited should not be null or disposed at this stage");
+	}
+
+	// GETTERS / SETTERS
+	public boolean isReadOnly() {
+		return readOnly;
+	}
+
+	protected EditablePart getEdited() {
+		return edited;
+	}
+
+	public MouseListener getMouseListener() {
+		return mouseListener;
+	}
+
+	public CmsEditable getCmsEditable() {
+		return cmsEditable;
+	}
+
+	@Override
+	public ISelection getSelection() {
+		return selection;
+	}
+
+}