oracle.javatools.controls
Class EditorPeekPopup

java.lang.Object
  oracle.javatools.controls.EditorPeekPopup

public class EditorPeekPopup
extends java.lang.Object

Mechanism to show a popup window containing a snippet of a section of a basic editor pane. It is designed to add the ability of gutter overview components to provide a mouse over peek of off screen sections of an editor pane. The pop up will appear in the pop up layer of the layer pane of the editors top level JWindow or JFrame.

Field Summary

static boolean

editorPeek True if the extended editor peek functionality is switched on.

Method Summary

static java.lang.String[]	createTextLines(java.lang.String text)
static void	hidePopup(boolean keepKey)
static boolean	isShowing()
static void	showPopup(java.lang.Object key, BasicEditorPane editorPane, java.lang.String[] text, java.awt.Rectangle sourceRect, int startLine, int endLine, int lineHeight, java.awt.Color[] backgroundColors, int fadeAmount, int minimumSize) Show the pop up containing a snippet of code rendered directly from the editor If you have any effects on the editor that shouldn't show up in the snippet then remove them before calling this and then add them back directly afterwards.
static void	showPopup(java.lang.Object key, BasicEditorPane editorPane, java.lang.String text, java.awt.Rectangle sourceRect, int startLine, int endLine, int lineHeight, java.awt.Color backgroundColor, int fadeAmount, int minimumSize) Show the pop up containing a snippet of code rendered directly from the editor If you have any effects on the editor that shouldn't show up in the snippet then remove them before calling this and then add them back directly afterwards.
static void	showPopup(java.lang.Object key, java.awt.Window window, BasicEditorPane editorPane, java.lang.String[] text, java.awt.Rectangle sourceRect, int startLine, int endLine, int lineHeight, java.awt.Color[] backgroundColors, int fadeAmount, int minimumSize) Show the pop up containing a snippet of code rendered directly from the editor If you have any effects on the editor that shouldn't show up in the snippet then remove them before calling this and then add them back directly afterwards.

Methods inherited from class java.lang.Object

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

Field Detail

editorPeek

public static boolean editorPeek

True if the extended editor peek functionality is switched on. The switch is the java command line option: -Dide.gutter.peek=true

Method Detail

showPopup

public static void showPopup(java.lang.Object key,
                             BasicEditorPane editorPane,
                             java.lang.String[] text,
                             java.awt.Rectangle sourceRect,
                             int startLine,
                             int endLine,
                             int lineHeight,
                             java.awt.Color[] backgroundColors,
                             int fadeAmount,
                             int minimumSize)

Show the pop up containing a snippet of code rendered directly from the editor If you have any effects on the editor that shouldn't show up in the snippet then remove them before calling this and then add them back directly afterwards.

Parameters:

key - - an object used to determine whether to re-generate the popup. If this method is called with the same key that was used on the last call then this method returns immediately. Calling hidePopup(true) will remove the key.

editorPane -

text - one line per array entry will be displayed in the pop up

sourceRect - the rectangle (in screen coords) from which the popup will 'pop' The popup can appear left or reight of the rectangle depending on screen space.

startLine -

endLine -

lineHeight -

backgroundColors - each line will be background colored to the appropriate indexed color

fadeAmount - - The snippet shows a small part of the surrounding lines, they will be faded by this number of pixels

minimumSize - - minimum size in pixels for teh popup. -1 indicates no minimum size

showPopup

public static void showPopup(java.lang.Object key,
                             java.awt.Window window,
                             BasicEditorPane editorPane,
                             java.lang.String[] text,
                             java.awt.Rectangle sourceRect,
                             int startLine,
                             int endLine,
                             int lineHeight,
                             java.awt.Color[] backgroundColors,
                             int fadeAmount,
                             int minimumSize)

Show the pop up containing a snippet of code rendered directly from the editor If you have any effects on the editor that shouldn't show up in the snippet then remove them before calling this and then add them back directly afterwards.

Parameters:

key - - an object used to determine whether to re-generate the popup. If this method is called with the same key that was used on the last

editorPane -

text - one line per array entry will be displayed in the pop upcall then this method returns immediately. Calling hidePopup(true) will remove the key.

sourceRect - the rectangle (in screen coords) from which the popup will 'pop' The popup can appear left or reight of the rectangle depending on screen space.

startLine -

endLine -

lineHeight -

backgroundColors - each line will be background colored to the appropriate indexed color

fadeAmount - - The snippet shows a small part of the surrounding lines, they will be faded by this number of pixels

minimumSize - - minimum size in pixels for teh popup. -1 indicates no minimum size

showPopup

public static void showPopup(java.lang.Object key,
                             BasicEditorPane editorPane,
                             java.lang.String text,
                             java.awt.Rectangle sourceRect,
                             int startLine,
                             int endLine,
                             int lineHeight,
                             java.awt.Color backgroundColor,
                             int fadeAmount,
                             int minimumSize)

Show the pop up containing a snippet of code rendered directly from the editor If you have any effects on the editor that shouldn't show up in the snippet then remove them before calling this and then add them back directly afterwards.

Parameters:

key - - an object used to determine whether to re-generate the popup. If this method is called with the same key that was used on the last call then this method returns immediately. Calling hidePopup(true) will remove the key.

sourceRect - the rectangle (in screen coords) from which the popup will 'pop' The popup can appear left or reight of the rectangle depending on screen space.

editorPane -

startLine -

endLine -

lineHeight -

backgroundColor -

fadeAmount - - The snippet shows a small part of the surrounding lines, they will be faded by this number of pixels

minimumSize - - minimum size in pixels for teh popup. -1 indicates no minimum size

createTextLines

public static java.lang.String[] createTextLines(java.lang.String text)

hidePopup

public static void hidePopup(boolean keepKey)

isShowing

public static boolean isShowing()