Field Detail

• PROP_SHORT_DESCRIPTION

  public static final java.lang.String PROP_SHORT_DESCRIPTION

  Property name of the tip text

  See Also:

  Constant Field Values

• PROP_ANNOTATION_TYPE

  public static final java.lang.String PROP_ANNOTATION_TYPE

  Property name of the annotation type

  See Also:

  Constant Field Values

• PROP_MOVE_TO_FRONT

  public static final java.lang.String PROP_MOVE_TO_FRONT

  Virtual property which does not have getter/setter. When change on this property is fired, listeners (= editors) must ensure that this annotation is not covered by some other annotation which is on the same line - annotation must be moved in front of others. See also moveToFront() method.

  Since:

  1.27

  See Also:

  Constant Field Values

Constructor Detail

• Annotation

  public Annotation​()

Method Detail

• getAnnotationType

  public abstract java.lang.String getAnnotationType​()

  Returns name of the file which describes the annotation type. The file must be defined in module installation layer in the directory "Editors/AnnotationTypes"

  Returns:

  name of the anotation type

• getShortDescription

  public abstract java.lang.String getShortDescription​()

  Gets the tool tip text for this annotation.

  Returns:

  tool tip for this annotation, or null for no tool tip

• attach

  public final void attach​(Annotatable anno)

  Attach annotation to Annotatable object.

  Parameters:

  anno - annotatable class to which this annotation will be attached

• notifyAttached

  protected void notifyAttached​(Annotatable toAnno)

  Notifies the annotation that it was attached to the annotatable.

  Parameters:

  toAnno - annotatable to which the annotation was attached.

  Since:

  1.38

• detach

  public final void detach​()

  Detach annotation.

• notifyDetached

  protected void notifyDetached​(Annotatable fromAnno)

  Notifies the annotation that it was detached from the annotatable.

  Parameters:

  fromAnno - annotatable from which the annotation was detached.

  Since:

  1.38

• getAttachedAnnotatable

  public final Annotatable getAttachedAnnotatable​()

  Gets annotatable object to which this annotation is attached.

  Returns:

  null if annotation is not attached or reference to annotatable object.

  Since:

  1.27

• addPropertyChangeListener

  public final void addPropertyChangeListener​(java.beans.PropertyChangeListener l)

  Add listeners on changes of annotation properties

  Parameters:

  l - change listener

• removePropertyChangeListener

  public final void removePropertyChangeListener​(java.beans.PropertyChangeListener l)

  Remove listeners on changes of annotation properties

  Parameters:

  l - change listener

• firePropertyChange

  protected final void firePropertyChange​(java.lang.String propertyName,
                                          java.lang.Object oldValue,
                                          java.lang.Object newValue)

  Fire property change to registered listeners.

• moveToFront

  public final void moveToFront​()

  Helper method for moving annotation which is covered by other annotations on the same line in front of others. The method fires change on PROP_MOVE_TO_FRONT property on which editors must listen and do the fronting of the annotation. Whether the annotation is visible in editor or not is not guaranteed by this method - use Line.show instead.

  Since:

  1.27