Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui.texteditor.spelling
Class SpellingAnnotation

java.lang.Object
  extended by 

org.eclipse.jface.text.source.Annotation
      extended by 
org.eclipse.ui.texteditor.spelling.SpellingAnnotation
All Implemented Interfaces:
IQuickFixableAnnotation

public class SpellingAnnotation
extends Annotation
implements IQuickFixableAnnotation

Spelling annotation.

Since:
3.3

Field Summary
static  String TYPE
          The spelling annotation type.
 
Fields inherited from class org.eclipse.jface.text.source. Annotation
TYPE_UNKNOWN
 
Constructor Summary
SpellingAnnotation ( SpellingProblem problem)
          Creates a new spelling annotation.
 
Method Summary
  SpellingProblem getSpellingProblem ()
          Returns the spelling problem.
 boolean isQuickFixable ()
          Tells whether there are quick fixes for this annotation.
 boolean isQuickFixableStateSet ()
          Tells whether the quick fixable state has been set.
 void setQuickFixable (boolean state)
          Sets whether there are quick fixes available for this annotation.
 
Methods inherited from class org.eclipse.jface.text.source. Annotation
getText, getType, isMarkedDeleted, isPersistent, markDeleted, setText, setType
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE

public static final 
String TYPE
The spelling annotation type.

See Also:
Constant Field Values
Constructor Detail

SpellingAnnotation

public SpellingAnnotation(
SpellingProblem problem)
Creates a new spelling annotation.

Parameters:
problem - the spelling problem.
Method Detail

isQuickFixable

public boolean isQuickFixable()
Description copied from interface: IQuickFixableAnnotation
Tells whether there are quick fixes for this annotation.

Note: This method must only be called if IQuickFixableAnnotation.isQuickFixableStateSet() returns true.

Specified by:
isQuickFixable in interface IQuickFixableAnnotation
Returns:
true if this annotation offers quick fixes

isQuickFixableStateSet

public boolean isQuickFixableStateSet()
Description copied from interface: IQuickFixableAnnotation
Tells whether the quick fixable state has been set.

Normally this means IQuickFixableAnnotation.setQuickFixable(boolean) has been called at least once but it can also be hard-coded, e.g. always return true.

Specified by:
isQuickFixableStateSet in interface IQuickFixableAnnotation
Returns:
true if the state has been set

setQuickFixable

public void setQuickFixable(boolean state)
Description copied from interface: IQuickFixableAnnotation
Sets whether there are quick fixes available for this annotation.

Specified by:
setQuickFixable in interface IQuickFixableAnnotation
Parameters:
state - true if there are quick fixes available, false otherwise

getSpellingProblem

public 
SpellingProblem getSpellingProblem()
Returns the spelling problem.

Returns:
the spelling problem

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire