001    package net.sourceforge.mp3dings;
002    
003    /* Mp3dings - manage mp3 meta-information
004     * Copyright (C) 2003-2004 Moritz Ringler
005     * $Id: Mp3dingsTab.java 13 2007-07-27 09:52:39Z ringler $
006     *
007     * This program is free software; you can redistribute it and/or
008     * modify it under the terms of the GNU General Public License
009     * as published by the Free Software Foundation; either version 2
010     * of the License, or (at your option) any later version.
011     *
012     * This program is distributed in the hope that it will be useful,
013     * but WITHOUT ANY WARRANTY; without even the implied warranty of
014     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
015     * GNU General Public License for more details.
016     *
017     * You should have received a copy of the GNU General Public License
018     * along with this program; if not, write to the Free Software
019     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
020     */
021    
022    import javax.swing.JPanel;
023    import javax.swing.JScrollPane;
024    import java.awt.Component;
025    
026    /** Common properties of the four Mp3dings tabs:
027    * <ol>
028    * <li>Data
029    * <li>Names
030    * <li>ID3v1
031    * <li>ID3v2
032    * </ol>
033    * All tabs share the same layout: they consist of a {@link #getTable table}
034    * that displays the data in the {@link #getModel tablemodel}. This table is
035    * wrapped in a {@link #getScrollPane scrollpane} so that it can become
036    * as large as needed. The data is manipulated through the {@link #addTablePopup
037    * context menu} and {@link #getToolbar toolbar buttons}.
038    *
039    */
040    public interface Mp3dingsTab{
041        /** Returns the table model that contains the data of this tab. */
042        public Mp3dingsTableModel getModel();
043    
044        /** Returns the table that displays the data of this tab. */
045        public Mp3dingsTable getTable();
046    
047        /** Returns the scrollpane that contains the table of this tab. */
048        public JScrollPane getScrollPane();
049    
050        /** Returns the toolbar that contains the buttons that trigger
051        * the actions specific to this tab.
052        */
053        public JPanel getToolbar();
054    
055        /** Adds a context menu to the table in this tab. */
056        public void addTablePopup(TableContextMenu tcm);
057    
058        /** Returns a component view of this Mp3dings tab
059        */
060        public Component getComponent();
061    }