diff options
Diffstat (limited to 'plugins/infra/core/org.eclipse.papyrus.infra.core.sasheditor/src/org/eclipse/papyrus/infra/core/sasheditor/contentprovider/ISashWindowsContentProvider.java')
| -rw-r--r-- | plugins/infra/core/org.eclipse.papyrus.infra.core.sasheditor/src/org/eclipse/papyrus/infra/core/sasheditor/contentprovider/ISashWindowsContentProvider.java | 73 |
1 files changed, 35 insertions, 38 deletions
diff --git a/plugins/infra/core/org.eclipse.papyrus.infra.core.sasheditor/src/org/eclipse/papyrus/infra/core/sasheditor/contentprovider/ISashWindowsContentProvider.java b/plugins/infra/core/org.eclipse.papyrus.infra.core.sasheditor/src/org/eclipse/papyrus/infra/core/sasheditor/contentprovider/ISashWindowsContentProvider.java index 1dbf77c02a7..04ad0a3c618 100644 --- a/plugins/infra/core/org.eclipse.papyrus.infra.core.sasheditor/src/org/eclipse/papyrus/infra/core/sasheditor/contentprovider/ISashWindowsContentProvider.java +++ b/plugins/infra/core/org.eclipse.papyrus.infra.core.sasheditor/src/org/eclipse/papyrus/infra/core/sasheditor/contentprovider/ISashWindowsContentProvider.java @@ -6,14 +6,12 @@ import org.eclipse.papyrus.infra.core.sasheditor.internal.SashWindowsContainer; /**
* This interface is used by the sash windows system to discover its content. It is considered
* as the root of the sash windows models.
- * The sashsystem is able to retrieve all its content from this interface, and associated interfaces {@link ITabFolderModel}, {@link ISashPanelModel},
- * {@link IPageModel}.
+ * The sashsystem is able to retrieve all its content from this interface, and associated interfaces {@link ITabFolderModel}, {@link ISashPanelModel}, {@link IPageModel}.
* The interface is also used by the sashsystem to communicate, by sending event, with the
- * effective implementation or upper level.
- * <br>
- *
+ * effective implementation or upper level. <br>
+ *
* @author dumoulin
- *
+ *
*/
public interface ISashWindowsContentProvider {
@@ -23,49 +21,48 @@ public interface ISashWindowsContentProvider { * The {@link SashWindowsContainer} will ask for an interface used to interact with the object.
* In normal implementation, this method should return the model used by the real implementation.
* The root object should correspond to a Panel (Folder or Sash).
- *
+ *
* @return The object representing the root of the implementation.
*/
- public /*Panel*/Object getRootModel();
+ public/* Panel */Object getRootModel();
/**
* Create the interface used by the {@link SashWindowsContainer} to access the root model.
* This method is called by the {@link SashWindowsContainer} to get the interface.
* The method is called only once for a given object.
- *
- * @param root An object representing a Panel
+ *
+ * @param root
+ * An object representing a Panel
* @return The SashModel corresponding to the specified panel object.
*/
- public IAbstractPanelModel createChildSashModel(/*Panel*/Object root);
+ public IAbstractPanelModel createChildSashModel(/* Panel */Object root);
/**
* Add a page to the current TabFolder.
- * The Page is added at the end of the tab list.
- * <br>
+ * The Page is added at the end of the tab list. <br>
* This method is not used by the {@link ISashWindowsContainer}.
- *
+ *
* @param page
- * An object identifying the page to add. The object could be anything. It will be
- * passed to the {@link ITabFolderModel#createChildSashModel(Object)} method.
+ * An object identifying the page to add. The object could be anything. It will be
+ * passed to the {@link ITabFolderModel#createChildSashModel(Object)} method.
*/
public void addPage(Object page);
/**
- * Add a page at the specified index of TabFolder.
- * <br>
+ * Add a page at the specified index of TabFolder. <br>
* This method is not used by the {@link ISashWindowsContainer}.
- *
+ *
* @param page
- * An object identifying the page to add. The object could be anything. It will be
- * passed to the {@link ITabFolderModel#createChildSashModel(Object)} method.
+ * An object identifying the page to add. The object could be anything. It will be
+ * passed to the {@link ITabFolderModel#createChildSashModel(Object)} method.
* @param index
- * Index to where the tabItem should be added.
+ * Index to where the tabItem should be added.
*/
public void addPage(Object page, int index);
/**
* Move a tab inside the specified folder.
- *
+ *
* @param model
* @param oldIndex
* @param newIndex
@@ -74,7 +71,7 @@ public interface ISashWindowsContentProvider { /**
* Move a tab from folder to folder.
- *
+ *
* @param model
* @param sourceIndex
* @param model2
@@ -84,7 +81,7 @@ public interface ISashWindowsContentProvider { /**
* Remove the page at the specified index of the current tabFolder
- *
+ *
* @param index
*/
public void removePage(int index);
@@ -92,15 +89,15 @@ public interface ISashWindowsContentProvider { /**
* Remove the page from the sashes window.
* Look for the folder containing the page.
- *
+ *
* @param page
- * The Object identifying the page. This is the object used in {@link #addPage(Object)}.
+ * The Object identifying the page. This is the object used in {@link #addPage(Object)}.
*/
public void removePage(Object page);
/**
* Remove the specified page from the parentFolder.
- *
+ *
* @param tabItem
*/
public void removePage(ITabFolderModel parentFolder, int tabIndex);
@@ -111,15 +108,15 @@ public interface ISashWindowsContentProvider { * is called by the the SashTileContainer when the user
* drags a tab in a correct place. The SashTileContainer has not changed is presentation yet. This
* will be done when the corresponding event will occur.
- *
+ *
* @param tabFolder
- * The folder containing the tab to move
+ * The folder containing the tab to move
* @param tabIndex
- * The index of the tab to move
+ * The index of the tab to move
* @param targetFolder
- * The folder to which the side refers to
+ * The folder to which the side refers to
* @param side
- * Side where node should be inserted : SWT.LEFT, SWT.RIGHT, SWT.TOP, SWT.DOWN.
+ * Side where node should be inserted : SWT.LEFT, SWT.RIGHT, SWT.TOP, SWT.DOWN.
*/
public void createFolder(ITabFolderModel tabFolder, int tabIndex, ITabFolderModel targetFolder, int side);
@@ -127,14 +124,14 @@ public interface ISashWindowsContentProvider { * Ask the model to keep trace of the Current Folder.
* The notion of Current Folder is used by {@link #addPage(Object)}.
* Calling this method should not fire a Change Event.
- *
+ *
* This method is used by the SashSystem when the user select a new folder by clicking on one of
* the tabs.
- *
+ *
* @param rawModel
- * The Raw model identifying the folder. This is the same object as the one
- * returned by {@link ISashPanelModel#getChildren()} when the child denote a folder.
+ * The Raw model identifying the folder. This is the same object as the one
+ * returned by {@link ISashPanelModel#getChildren()} when the child denote a folder.
*/
- public void setCurrentFolder(/*Folder*/Object rawModel);
+ public void setCurrentFolder(/* Folder */Object rawModel);
}
|