Eclipse Plug-in Developer Guide (Galileo) - WorkspaceUndoUtil (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.ide.undo
Class WorkspaceUndoUtil


java.lang.Object
  
org.eclipse.ui.ide.undo.WorkspaceUndoUtil

public class WorkspaceUndoUtil
extends Object
extends Object

WorkspaceUndoUtil defines common utility methods and constants used by clients who create undoable workspace operations.

Since:: 3.3

Method Summary

static IUndoContext getBookmarksUndoContext ()
          Return the undo context that should be used for operations involving bookmarks.

static Shell getShell ( IAdaptable uiInfo)
          Return the shell described by the specified adaptable, or the active shell if no shell has been specified in the adaptable.

static IUndoContext getTasksUndoContext ()
          Return the undo context that should be used for operations involving tasks.

static IAdaptable getUIInfoAdapter ( Shell shell)
          Make an IAdaptable that adapts to the specified shell, suitable for passing for passing to any IUndoableOperation or IOperationHistory method that requires an IAdaptable uiInfo parameter.

static IUndoContext getWorkspaceUndoContext ()
          Return the undo context that should be used for workspace-wide operations

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getWorkspaceUndoContext

public static 
IUndoContext getWorkspaceUndoContext()

Return the undo context that should be used for workspace-wide operations

Returns:: the undo context suitable for workspace-level operations.

getTasksUndoContext

public static 
IUndoContext getTasksUndoContext()

Return the undo context that should be used for operations involving tasks.

Returns:: the tasks undo context

getBookmarksUndoContext

public static 
IUndoContext getBookmarksUndoContext()

Return the undo context that should be used for operations involving bookmarks.

Returns:: the bookmarks undo context

getUIInfoAdapter

public static 
IAdaptable getUIInfoAdapter(
Shell shell)

Make an IAdaptable that adapts to the specified shell, suitable for passing for passing to any IUndoableOperation or IOperationHistory method that requires an IAdaptable uiInfo parameter.

Parameters:: shell - the shell that should be returned by the IAdaptable when asked to adapt a shell. If this parameter is null, the returned shell will also be null.
Returns:: an IAdaptable that will return the specified shell.

getShell

public static 
Shell getShell(
IAdaptable uiInfo)

Return the shell described by the specified adaptable, or the active shell if no shell has been specified in the adaptable.

Parameters:: uiInfo - the IAdaptable (or null) provided by the caller in order to supply UI information for prompting the user if necessary. When this parameter is not null, it contains an adapter for the org.eclipse.swt.widgets.Shell.class
Returns:: the Shell that can be used to show information