X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;f=swt%2Forg.argeo.tool.devops.e4%2Fsrc%2Forg%2Fargeo%2Fcms%2Fui%2Feclipse%2Fforms%2Feditor%2FIFormPage.java;fp=swt%2Forg.argeo.tool.devops.e4%2Fsrc%2Forg%2Fargeo%2Fcms%2Fui%2Feclipse%2Fforms%2Feditor%2FIFormPage.java;h=eb08cb59ddf48915aa8bdf51a71d82380ad20fa8;hb=825d60c5348dbe3f5be25b0bccf7bdebfe694219;hp=0000000000000000000000000000000000000000;hpb=5e991fff5cba01858dcc5747a27e637325bc5c8e;p=gpl%2Fargeo-jcr.git

diff --git a/swt/org.argeo.tool.devops.e4/src/org/argeo/cms/ui/eclipse/forms/editor/IFormPage.java b/swt/org.argeo.tool.devops.e4/src/org/argeo/cms/ui/eclipse/forms/editor/IFormPage.java
new file mode 100644
index 0000000..eb08cb5
--- /dev/null
+++ b/swt/org.argeo.tool.devops.e4/src/org/argeo/cms/ui/eclipse/forms/editor/IFormPage.java
@@ -0,0 +1,119 @@
+package org.argeo.cms.ui.eclipse.forms.editor;
+import org.argeo.cms.ui.eclipse.forms.IManagedForm;
+import org.eclipse.swt.widgets.Control;
+/**
+ * Interface that all GUI pages need to implement in order
+ * to be added to FormEditor part. The interface makes 
+ * several assumptions:
+ * <ul>
+ * <li>The form page has a managed form</li>
+ * <li>The form page has a unique id</li>
+ * <li>The form page can be GUI but can also wrap a complete
+ * editor class (in that case, it should return <code>true</code>
+ * from <code>isEditor()</code> method).</li>
+ * <li>The form page is lazy i.e. understands that 
+ * its part control will be created at the last possible
+ * moment.</li>.
+ * </ul>
+ * <p>Existing editors can be wrapped by implementing
+ * this interface. In this case, 'isEditor' should return <code>true</code>.
+ * A common editor to wrap in <code>TextEditor</code> that is
+ * often added to show the raw source code of the file open into
+ * the multi-page editor.
+ * 
+ * @since 1.0
+ */
+public interface IFormPage {
+	/**
+	 * @param editor
+	 *            the form editor that this page belongs to
+	 */
+	void initialize(FormEditor editor);
+	/**
+	 * Returns the editor this page belongs to.
+	 * 
+	 * @return the form editor
+	 */
+	FormEditor getEditor();
+	/**
+	 * Returns the managed form of this page, unless this is a source page.
+	 * 
+	 * @return the managed form or <samp>null </samp> if this is a source page.
+	 */
+	IManagedForm getManagedForm();
+	/**
+	 * Indicates whether the page has become the active in the editor. Classes
+	 * that implement this interface may use this method to commit the page (on
+	 * <code>false</code>) or lazily create and/or populate the content on
+	 * <code>true</code>.
+	 * 
+	 * @param active
+	 *            <code>true</code> if page should be visible, <code>false</code>
+	 *            otherwise.
+	 */
+	void setActive(boolean active);
+	/**
+	 * Returns <samp>true </samp> if page is currently active, false if not.
+	 * 
+	 * @return <samp>true </samp> for active page.
+	 */
+	boolean isActive();
+	/**
+	 * Tests if the content of the page is in a state that allows the
+	 * editor to flip to another page. Typically, pages that contain
+	 * raw source with syntax errors should not allow editors to 
+	 * leave them until errors are corrected.
+	 * @return <code>true</code> if the editor can flip to another page,
+	 * <code>false</code> otherwise.
+	 */
+	boolean canLeaveThePage();
+	/**
+	 * Returns the control associated with this page.
+	 * 
+	 * @return the control of this page if created or <samp>null </samp> if the
+	 *         page has not been shown yet.
+	 */
+	Control getPartControl();
+	/**
+	 * Page must have a unique id that can be used to show it without knowing
+	 * its relative position in the editor.
+	 * 
+	 * @return the unique page identifier
+	 */
+	String getId();
+	/**
+	 * Returns the position of the page in the editor.
+	 * 
+	 * @return the zero-based index of the page in the editor.
+	 */
+	int getIndex();
+	/**
+	 * Sets the position of the page in the editor.
+	 * 
+	 * @param index
+	 *            the zero-based index of the page in the editor.
+	 */
+	void setIndex(int index);
+	/**
+	 * Tests whether this page wraps a complete editor that
+	 * can be registered on its own, or represents a page
+	 * that cannot exist outside the multi-page editor context.
+	 * 
+	 * @return <samp>true </samp> if the page wraps an editor,
+	 *         <samp>false </samp> if this is a form page.
+	 */
+	boolean isEditor();
+	/**
+	 * A hint to bring the provided object into focus. If the object is in a
+	 * tree or table control, select it. If it is shown on a scrollable page,
+	 * ensure that it is visible. If the object is not presented in 
+	 * the page, <code>false</code> should be returned to allow another
+	 * page to try.
+	 * 
+	 * @param object
+	 *            object to select and reveal
+	 * @return <code>true</code> if the request was successful, <code>false</code>
+	 *         otherwise.
+	 */
+	boolean selectReveal(Object object);
+}