/*
 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
 * Copyright (C) $$Year-Rel$$ The Jalview Authors
 * 
 * This file is part of Jalview.
 * 
 * Jalview is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License 
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *  
 * Jalview is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty 
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
 * PURPOSE.  See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
 * The Jalview Authors are detailed in the 'AUTHORS' file.
 */
package jalview.api;

import jalview.datamodel.AlignmentI;
import jalview.structure.StructureSelectionManager;

/**
 * abstract interface implemented by alignment panels holding an alignment view
 * 
 * @author JimP
 * 
 */
public interface AlignmentViewPanel extends OOMHandlerI
{

  AlignViewportI getAlignViewport();

  AlignmentI getAlignment();

  StructureSelectionManager getStructureSelectionManager();

  /**
   * repaint the alignment view after a datamodel update.
   * 
   * @param updateOverview
   *          - if true, the overview panel will also be updated and repainted
   * @param updateStructures
   *          - if true then any linked structure views will also be updated
   */
  void paintAlignment(boolean updateOverview, boolean updateStructures);

  /**
   * automatically adjust annotation panel height for new annotation whilst
   * ensuring the alignment is still visible.
   */
  void adjustAnnotationHeight();

  FeatureRenderer getFeatureRenderer();

  FeatureRenderer cloneFeatureRenderer();

  /**
   * 
   * @return displayed name for the view
   */
  String getViewName();
}