/* 
    P/P   *  Method: com.dmdirc.ui.interfaces.FrameManager__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.ui.interfaces;
    24  
    25  import com.dmdirc.FrameContainer;
    26  
    27  import javax.swing.JComponent;
    28  
    29  /**
    30   * A frame manager is a widget that allows the user to navigate between the
    31   * various frames that will be open at any one time.
    32   * 
    33   * @author chris
    34   */
    35  public interface FrameManager {
    36      
    37      /**
    38       * Sets the parent component of this frame manager. The frame manager
    39       * should render itself within the parent.
    40       * 
    41       * @param parent The parent control
    42       */
    43      void setParent(JComponent parent);
    44      
    45      /**
    46       * Indicates whether this frame manager can be positioned vertically
    47       * (i.e., at the side of the screen).
    48       * 
    49       * @return True iff the frame manager can be positioned vertically
    50       */
    51      boolean canPositionVertically();
    52      
    53      /**
    54       * Indicates whether this frame manager can be positioned horizontally
    55       * (i.e., at the top or bottom of the screen).
    56       * 
    57       * @return True iff the frame manager can be positioned horizontally
    58       */
    59      boolean canPositionHorizontally();
    60      
    61      /**
    62       * Adds a window to this frame manager.
    63       * 
    64       * @param window The server to be added
    65       */
    66      void addWindow(FrameContainer window);
    67      
    68      /**
    69       * Removes a window from this frame manager.
    70       * 
    71       * @param window The server to be removed
    72       */
    73      void delWindow(FrameContainer window);   
    74      
    75      /**
    76       * Adds a new window to this frame manager.
    77       * 
    78       * @param parent The parent to which the window belongs, or null
    79       * @param window The custom window to be added
    80       */
    81      void addWindow(FrameContainer parent, FrameContainer window);
    82      
    83      /**
    84       * Removes a window from this frame manager.
    85       * 
    86       * @param parent The parent to which the window belongs, or null
    87       * @param window The custom window to be removed
    88       */
    89      void delWindow(FrameContainer parent, FrameContainer window);
    90  
    91  }