/* Copyright (C) 2006 Christian Schneider
 * 
 * This file is part of Nomad.
 * 
 * Nomad 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 2 of the License, or
 * (at your option) any later version.
 * 
 * Nomad 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 Nomad; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
package net.sf.nmedit.jpatch;

import java.io.File;

import javax.swing.event.UndoableEditListener;
import javax.swing.undo.UndoManager;
import javax.swing.undo.UndoableEdit;

import net.sf.nmedit.jpatch.history.PUndoableEditSupport;

public interface PPatch 
{
    UndoManager getUndoManager();
    
    PUndoableEditSupport getEditSupport();
    
    /**
     * Posts an edit of this component.
     * The edit will only be recognized if 
     * {@link #isUndoableEditSupportEnabled()}
     * is true.
     * @param edit
     */
    void postEdit(UndoableEdit edit);
    
    /**
     * True if undo support is enabled.
     * @return true if undo support is enabled
     */
    boolean isUndoableEditSupportEnabled();
    

    PSettings getSettings();
    
    int getModuleContainerCount();
    PModuleContainer getModuleContainer(int index);
    
    PPatch createEmptyPatch();
    PPatch createFromFile(File file) throws Exception;
    
    ModuleDescriptions getModuleDescriptions();
    
  //  PHistory getHistory();
    
    PFactory getComponentFactory();

    PModule createModule(PModuleDescriptor d);
    
    PModuleMetrics getModuleMetrics();

    boolean setFocusedComponent(Object f);
    Object getFocusedComponent();
    
    String patchFileString();

	int getModuleContainerIndex(PModuleContainer sourceContainer);
        
    
    void addUndoableEditListener(UndoableEditListener l);
    void removeUndoableEditListener(UndoableEditListener l);    
    
    PUndoableEditFactory getUndoableEditFactory();
    
    void setName(String name);
    String getName();
    
}