AnnotationDesc (Editor Library) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib/1 1.14.0 3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.editor
Class AnnotationDesc

java.lang.Object
  org.netbeans.editor.AnnotationDesc

public abstract class AnnotationDesc
extends Object
extends Object

Description of the annotation. The annotations is defined by AnnotationType, length, offset and description.

Since:: 07/2001

Field Summary

static String PROP_ANNOTATION_TYPE
          Property name of the annotation type

static String PROP_MOVE_TO_FRONT
          Virtual property for fronting of annotation

static String PROP_SHORT_DESCRIPTION
          Property name of the tip text

Constructor Summary

AnnotationDesc(int offset, int length)


Method Summary

void addPropertyChangeListener(PropertyChangeListener l)
          Add listeners on changes of annotation properties

protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)
          Fire property change to registered listeners.

Action[] getActions()
          Returns list of actions associated to this annotation type.

abstract String getAnnotationType()
          Getter for annotation type name

AnnotationType getAnnotationTypeInstance()
          Getter for annotation type object

Coloring getColoring()
          Gets annotation coloring.

Image getGlyph()
          Gets glyph image.

int getLength()
          Get length of the annotation

abstract int getLine()
          Getter for line number of this annotation

abstract int getOffset()
          Getter for offset of this annotation

int getOrderNumber()
          Internal order of the annotations.

abstract String getShortDescription()
          Getter for localized tooltip text for this annotation

boolean isDefaultGlyph()
          Checks whether the annotation type has its own glyph icon

boolean isVisible()
          Is annotation type visible.

boolean isWholeLine()
          Whether this annotation annotates whole line or just part of the text

void removePropertyChangeListener(PropertyChangeListener l)
          Remove listeners on changes of annotation properties

String toString()


void updateAnnotationType()
          Method for fetching AnnotationType which correspond to the name of the annotation type stored in annotation.

Methods inherited from class java.lang.Object

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

Field Summary
`static String`	`PROP_ANNOTATION_TYPE` Property name of the annotation type
`static String`	`PROP_MOVE_TO_FRONT` Virtual property for fronting of annotation
`static String`	`PROP_SHORT_DESCRIPTION` Property name of the tip text

Constructor Summary
`AnnotationDesc(int offset, int length)`

Method Summary
`void`	`addPropertyChangeListener(PropertyChangeListener l)` Add listeners on changes of annotation properties
`protected void`	`firePropertyChange(String propertyName, Object oldValue, Object newValue)` Fire property change to registered listeners.
`Action[]`	`getActions()` Returns list of actions associated to this annotation type.
`abstract String`	`getAnnotationType()` Getter for annotation type name
`AnnotationType`	`getAnnotationTypeInstance()` Getter for annotation type object
`Coloring`	`getColoring()` Gets annotation coloring.
`Image`	`getGlyph()` Gets glyph image.
`int`	`getLength()` Get length of the annotation
`abstract int`	`getLine()` Getter for line number of this annotation
`abstract int`	`getOffset()` Getter for offset of this annotation
`int`	`getOrderNumber()` Internal order of the annotations.
`abstract String`	`getShortDescription()` Getter for localized tooltip text for this annotation
`boolean`	`isDefaultGlyph()` Checks whether the annotation type has its own glyph icon
`boolean`	`isVisible()` Is annotation type visible.
`boolean`	`isWholeLine()` Whether this annotation annotates whole line or just part of the text
`void`	`removePropertyChangeListener(PropertyChangeListener l)` Remove listeners on changes of annotation properties
`String`	`toString()`
`void`	`updateAnnotationType()` Method for fetching AnnotationType which correspond to the name of the annotation type stored in annotation.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

PROP_SHORT_DESCRIPTION

public static final String PROP_SHORT_DESCRIPTION

Property name of the tip text

See Also:: Constant Field Values

PROP_ANNOTATION_TYPE

public static final String PROP_ANNOTATION_TYPE

Property name of the annotation type

See Also:: Constant Field Values

PROP_MOVE_TO_FRONT

public static final String PROP_MOVE_TO_FRONT

Virtual property for fronting of annotation

See Also:: Constant Field Values

Constructor Detail

AnnotationDesc

public AnnotationDesc(int offset,
                      int length)

Method Detail

getColoring

public Coloring getColoring()

Gets annotation coloring. This is pass through method to annotation type

getGlyph

public Image getGlyph()

Gets glyph image. This is pass through method to annotation type

isDefaultGlyph

public boolean isDefaultGlyph()

Checks whether the annotation type has its own glyph icon

isVisible

public boolean isVisible()

Is annotation type visible. This is pass through method to annotation type

getOrderNumber

public int getOrderNumber()

Internal order of the annotations. Used for correct cycling.

getActions

public Action[] getActions()

Returns list of actions associated to this annotation type.

isWholeLine

public boolean isWholeLine()

Whether this annotation annotates whole line or just part of the text

getLength

public int getLength()

Get length of the annotation

getAnnotationTypeInstance

public AnnotationType getAnnotationTypeInstance()

Getter for annotation type object

getAnnotationType

public abstract String getAnnotationType()

Getter for annotation type name

getShortDescription

public abstract String getShortDescription()

Getter for localized tooltip text for this annotation

getOffset

public abstract int getOffset()

Getter for offset of this annotation

getLine

public abstract int getLine()

Getter for line number of this annotation

updateAnnotationType

public void updateAnnotationType()

Method for fetching AnnotationType which correspond to the name of the annotation type stored in annotation.

addPropertyChangeListener

public final void addPropertyChangeListener(PropertyChangeListener l)

Add listeners on changes of annotation properties

Parameters:: l - change listener

removePropertyChangeListener

public final void removePropertyChangeListener(PropertyChangeListener l)

Remove listeners on changes of annotation properties

Parameters:: l - change listener

firePropertyChange

protected final void firePropertyChange(String propertyName,
                                        Object oldValue,
                                        Object newValue)

Fire property change to registered listeners.

toString

public String toString()

Overrides:: toString in class Object