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: *
true
* from isEditor()
method).Existing editors can be wrapped by implementing
* this interface. In this case, 'isEditor' should return true
.
* A common editor to wrap in TextEditor
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 null 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
* false
) or lazily create and/or populate the content on
* true
.
*
* @param active
* true
if page should be visible, false
* otherwise.
*/
void setActive(boolean active);
/**
* Returns true if page is currently active, false if not.
*
* @return true 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 true
if the editor can flip to another page,
* false
otherwise.
*/
boolean canLeaveThePage();
/**
* Returns the control associated with this page.
*
* @return the control of this page if created or null 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 true if the page wraps an editor,
* false 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, false
should be returned to allow another
* page to try.
*
* @param object
* object to select and reveal
* @return true
if the request was successful, false
* otherwise.
*/
boolean selectReveal(Object object);
}