IDock


1   package org.columba.api.gui.frame;
2   
3   import java.util.Iterator  ;
4   
5   import javax.swing.JComponent  ;
6   import javax.swing.JPopupMenu  ;
7   
8   
9   /**
10   * A <code>IFrameMediator</code> supporting docking should also implement this
11   * interface, describing the dockable views residing in this frame mediator
12   * workspace.
13   * 
14   * @author fdietz
15   */
16  public interface IDock {
17  
18      enum REGION {CENTER, NORTH, SOUTH, EAST, WEST}
19  
20      public static final String   DOCKING_VIEW_SEARCH = "search_panel";
21      public static final String   DOCKING_VIEW_CONTEXTUAL_PANEL = "contextual_panel";
22  
23      /**
24       * Return iterator of dockables.
25       * 
26       * @return dockable iterator of <code>IDockable</code>
27       */
28      public Iterator  <IDockable> getDockableIterator();
29      
30      /**
31       * Register new dockable at this docking container.
32       * 
33       * @param dockable
34       */
35      public void registerDockable(IDockable dockable);
36      
37      /**
38       * Register new dockable at this docking container.
39       * 
40       * @param id
41       *            dockable id
42       * @param name
43       *            dockable human-readable name (used in menu item)
44       * @param comp
45       *            dockable view
46       * @param popup
47       *            popup menu, can be <code>null</code>
48       */
49      public IDockable registerDockable(String   id, String   name, JComponent   comp, JPopupMenu   popup);
50      
51  
52      public void dock(IDockable dockable, REGION region);
53      
54      public void dock(IDockable dockable, REGION region, float percentage);
55      
56      public void dock(IDockable dockable, IDockable parentDockable, REGION region, float percentage);
57      
58      public void setSplitProportion(IDockable dockable, float percentage);
59      
60      public void showDockable(String   id);
61  }
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags