org.netbeans.api.editor

Class StickyWindowSupport

java.lang.Object

org.netbeans.api.editor.StickyWindowSupport

public final class StickyWindowSupport
extends Object

Support for Sticky Windows in the editor. JComponents can be added to a layer on top of the editor. Components will update their vertical position on editor changes.

Since:

2.9

Method Summary

Modifier and Type	Method and Description
void	addWindow(JComponent window) Add a sticky window to the editor.
Point	convertPoint(Point aPoint) Convert a aPoint in root component coordinate system to the editor coordinate system.
void	removeWindow(JComponent window) Remove a sticky window from the editor.

Methods inherited from class java.lang.Object

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

Method Detail

addWindow

public void addWindow(JComponent window)

Add a sticky window to the editor.

Parameters:

window - the JComponent to add to the editor

convertPoint

@NonNull
public Point convertPoint(Point aPoint)

Convert a aPoint in root component coordinate system to the editor coordinate system. aPoint is assumed to be in the root component coordinate system of the editor. If conversion is not possible, return aPoint without any conversion.

Parameters:

aPoint - the Point to convert

Returns:

aPoint converted to editor coordinate system

removeWindow

public void removeWindow(JComponent window)

Remove a sticky window from the editor.

Parameters:

window - the JComponent to remove