org.eclipse.ui.presentations.IStackPresentationSite Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gef-gwt
The newest version!
/*******************************************************************************
 * Copyright (c) 2004, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Chris Gross [email protected] Bug 107443
 *******************************************************************************/
package org.eclipse.ui.presentations;

import org.eclipse.jface.action.IMenuManager;
import org.eclipse.swt.graphics.Point;

/**
 * Represents the main interface between a StackPresentation and the workbench.
 * 
 * Not intended to be implemented by clients.
 * 
 * @since 3.0
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IStackPresentationSite {
	public static int STATE_MINIMIZED = 0;

	public static int STATE_MAXIMIZED = 1;

	public static int STATE_RESTORED = 2;

	/**
	 * Sets the state of the container. Called by the presentation when the user
	 * causes the the container to be minimized, maximized, etc.
	 * 
	 * @param newState
	 *            one of the STATE_* constants
	 */
	public void setState(int newState);

	/**
	 * Returns the current state of the site (one of the STATE_* constants)
	 * 
	 * @return the current state of the site (one of the STATE_* constants)
	 */
	public int getState();

	/**
	 * Returns true iff the site supports the given state
	 * 
	 * @param state
	 *            one of the STATE_* constants, above
	 * @return true iff the site supports the given state
	 */
	public boolean supportsState(int state);

	/**
	 * Begins dragging the given part
	 * 
	 * @param beingDragged
	 *            the part to drag (not null)
	 * @param initialPosition
	 *            the mouse position at the time of the initial mousedown
	 *            (display coordinates, not null)
	 * @param keyboard
	 *            true iff the drag was initiated via mouse dragging, and false
	 *            if the drag may be using the keyboard
	 */
	public void dragStart(IPresentablePart beingDragged, Point initialPosition,
			boolean keyboard);

	/**
	 * Closes the given set of parts.
	 * 
	 * @param toClose
	 *            the set of parts to close (Not null. All of the entries must
	 *            be non-null)
	 */
	public void close(IPresentablePart[] toClose);

	/**
	 * Begins dragging the entire stack of parts
	 * 
	 * @param initialPosition
	 *            the mouse position at the time of the initial mousedown
	 *            (display coordinates, not null)
	 * @param keyboard
	 *            true iff the drag was initiated via mouse dragging, and false
	 *            if the drag may be using the keyboard
	 */
	public void dragStart(Point initialPosition, boolean keyboard);

	/**
	 * Returns true iff this site will allow the given part to be closed
	 * 
	 * @param toClose
	 *            part to test (not null)
	 * @return true iff the part may be closed
	 */
	public boolean isCloseable(IPresentablePart toClose);

	/**
	 * Returns true iff the given part can be dragged. If this returns false,
	 * the given part should not trigger a drag.
	 * 
	 * @param toMove
	 *            part to test (not null)
	 * @return true iff this part is a valid drag source
	 */
	public boolean isPartMoveable(IPresentablePart toMove);

	/**
	 * Returns true iff this entire stack can be dragged
	 * 
	 * @return tre iff the stack can be dragged
	 */
	public boolean isStackMoveable();

	/**
	 * Makes the given part active
	 * 
	 * @param toSelect
	 */
	public void selectPart(IPresentablePart toSelect);

	/**
	 * Returns the currently selected part or null if the stack is empty
	 * 
	 * @return the currently selected part or null if the stack is empty
	 */
	public IPresentablePart getSelectedPart();

	/**
	 * Adds system actions to the given menu manager. The site may make use of
	 * the following group ids:
	 * 
	 * close, for close actions
	 * size, for resize actions
	 * misc, for miscellaneous actions
	 * 
	 * The presentation can control the insertion position by creating these
	 * group IDs where appropriate.
	 * 
	 * @param menuManager
	 *            the menu manager to populate
	 */
	public void addSystemActions(IMenuManager menuManager);

	/**
	 * Notifies the workbench that the preferred size of the presentation has
	 * changed. Hints to the workbench that it should trigger a layout at the
	 * next opportunity.
	 * 
	 * @since 3.1
	 */
	public void flushLayout();

	/**
	 * Returns the list of presentable parts currently in this site
	 * 
	 * @return the list of presentable parts currently in this site
	 * @since 3.1
	 */
	public IPresentablePart[] getPartList();

	/**
	 * Returns the property with the given id or null. Folder
	 * properties are an extensible mechanism for perspective authors to
	 * customize the appearance of view stacks. The list of customizable
	 * properties is determined by the presentation factory, and set in the
	 * perspective factory.
	 * 
	 * @param id
	 *            Must not be null.
	 * @return property value, or null if the property is not set.
	 * @since 3.3
	 */
	public String getProperty(String id);
}