org.xmind.core.IWorkbookComponent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmindjbehaveplugin Show documentation

Plugin that manages JBehave stories storage in XMind mindmap file, which allows design jBehave tests right after the brainstorm

The newest version!

/* ******************************************************************************
 * Copyright (c) 2006-2012 XMind Ltd. and others.
 * 
 * This file is a part of XMind 3. XMind releases 3 and
 * above are dual-licensed under the Eclipse Public License (EPL),
 * which is available at http://www.eclipse.org/legal/epl-v10.html
 * and the GNU Lesser General Public License (LGPL), 
 * which is available at http://www.gnu.org/licenses/lgpl.html
 * See http://www.xmind.net/license.html for details.
 * 
 * Contributors:
 *     XMind Ltd. - initial API and implementation
 *******************************************************************************/
package org.xmind.core;

public interface IWorkbookComponent {

    /**
     * Gets the workbook who owns this component.
     * 
     * @return the owned workbook
     */
    IWorkbook getOwnedWorkbook();

    /**
     * Determines whether this component is isolated from the owned workbook.
     * 
     * 
     * Isolated objects are objects that is owned by this workbook but will not
     * be saved with this workbook.
     * 
     * 
     * To isolate an object, generally call removeXXX() from its
     * parent. To attach an isolated object, generally call corresponding
     * addXXX() from a parental object.
     * 
     * 
     * @return true if this component is isolated from its owned
     *         workbook, false otherwise
     */
    boolean isOrphan();

}