IEditableTask


1   /*******************************************************************************
2    * Copyright (c) 2006 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  
12  package org.eclipse.ui.internal.provisional.cheatsheets;
13  
14  import java.net.MalformedURLException  ;
15  import java.net.URL  ;
16  
17  /**
18   * An editable task within a composite cheatsheet. An editable task is associated
19   * with a task editor and the task editor is responsible for completing the task.
20   * <p>
21   * This interface is not intended to be implemented by clients.
22   * </p>
23   */
24  
25  public interface IEditableTask extends ICompositeCheatSheetTask {
26      
27      /**
28       * Set the state of this task to COMPLETED
29       */
30      public void complete();
31      
32      /**
33       * Gets a URL which can be used to open the content file for this 
34       * task if the content file is specified by a path.
35       * @param path the path to the content file
36       * @throws MalformedURLException 
37       * @return a URL to the content file
38       */
39      public URL   getInputUrl(String   path) throws MalformedURLException  ;
40  
41  }
42

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags