org.xmind.core.IControlPoint 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 IControlPoint extends IAdaptable, ISheetComponent, IPositioned {

    /**
     * 
     * @return
     */
    IRelationship getParent();

    /**
     * 
     * @return
     */
    int getIndex();

    /**
     * Checks whether or not the polar position is ready to use.
     * 
     * A Polar Position is defined as a pair of coordinates containing an
     * angle and an amount.
     * 
     * 
     * WARNING: Experimental method.
     * 
     * 
     * @return True if the polar position is ready to use
     */
    boolean usesPolarPosition();

    /**
     * 
     * 
     * WARNING: Experimental method.
     * 
     * 
     * @return
     */
    boolean hasPolarAngle();

    /**
     * 
     * 
     * WARNING: Experimental method.
     * 
     * 
     * @return
     */
    boolean hasPolarAmount();

    /**
     * 
     * 
     * WARNING: Experimental method.
     * 
     */
    double getPolarAngle();

    /**
     * 
     * WARNING: Experimental method.
     * 
     * 
     * @return
     */
    double getPolarAmount();

    /**
     * 
     * WARNING: Experimental method.
     * 
     * 
     * @param angle
     */
    void setPolarAngle(double angle);

    /**
     * 
     * WARNING: Experimental method.
     * 
     * 
     * @param amount
     */
    void setPolarAmount(double amount);

    /**
     * 
     * WARNING: Experimental method.
     * 
     * 
     */
    void resetPolarAngle();

    /**
     * 
     * WARNING: Experimental method.
     * 
     * 
     */
    void resetPolarAmount();

}