Eclipse Platform
Release 3.1

org.eclipse.ltk.core.refactoring
Class RefactoringStatusContext

java.lang.Object
  extended byorg.eclipse.ltk.core.refactoring.RefactoringStatusContext
Direct Known Subclasses:
FileStatusContext

public abstract class RefactoringStatusContext
extends Object

A RefactoringStatusContext can be used to annotate a RefactoringStatusEntry with additional information typically presented in the user interface.

To present a context in the user interface a corresponding context viewer can be registered via the extension point org.eclipse.ltk.ui.refactoring.statusContextViewers.

This class may be subclassed by clients.

Since:
3.0

Constructor Summary
RefactoringStatusContext()
           
 
Method Summary
abstract  Object getCorrespondingElement()
          Returns the element that corresponds directly to this context, or null if there is no corresponding element.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RefactoringStatusContext

public RefactoringStatusContext()
Method Detail

getCorrespondingElement

public abstract Object getCorrespondingElement()
Returns the element that corresponds directly to this context, or null if there is no corresponding element.

For example, the corresponding element of a context for a problem detected in an IResource would the the resource itself.

Returns:
the corresponding element

toString

public String toString()

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.