# com.bea.ide.sourceeditor.ui
IPopupTip Interface

public interface IPopupTip

An interface defining a popup tip in the source editor. Popup tips can be displayed by calling `ISourceView.showPopupTip```.

All Known Implementing Classes
  `DefaultPopupTip`

## Nested Class Summary

`public static interface` | `IPopupTip.Container` Interface allowing the popup tip to reference its parent container.

## Field Summary

`public static final int` | `HORIZONTAL_AT_TOKEN` Horizontal position at the token enclosing the popups offset.
`public static final int` | `HORIZONTAL_LEFT_APPLICATION_MARGIN` Horizontal position at the left margin of main application window.
`public static final int` | `HORIZONTAL_LEFT_EDITOR_MARGIN` Horizontal position at the left margin of the source editor.
`public static final int` | `HORIZONTAL_RIGHT_APPLICATION_MARGIN` Horizontal position at the right margin of the main application window.
`public static final int` | `HORIZONTAL_RIGHT_EDITOR_MARGIN` Horizontal position at the right margin of the source editor.
`public static final int` | `HORIZONTAL_TAB_AT_OFFSET` Horizontal position aligning the popup's offset with a tab position specified by the popup
`public static final int` | `VERTICAL_ABOVE_TOKEN` Vertical position above the line containing the popup's editor offset.
`public static final int` | `VERTICAL_AT_TOKEN` Vertical position at the line containing the popup's editor offset.
`public static final int` | `VERTICAL_BELOW_TOKEN` Vertical position below the line containing popup's editor offset.

## Method Summary

`public boolean` | `disposeOnKeyAction`() Returns whether this popup should disappear on keyboard actions.
`public boolean` | `disposeOnMouseAction`() Returns whether this popup should disappear on mouse motion.
`public `Component`` | `getComponent`() Returns the display component of this popup tip
`public int[]` | `getHorizontalAlignment`() Returns an array of horizontal position constants specifying the prefered locations for this component.
`public int` | `getOffset`() Gets the editor offset that is the source of this popup tip
`public int` | `getTabPosition`() If HORIZONTAL_TAB_AT_OFFSET horizontal positioning is used, this method return the tab position at which alignment should occur.
`public int[]` | `getVerticalAlignment`() Returns an array of vertical position constants specifying the prefered locations for this component.
`public void` | `onDisplay`(`IPopupTip.Container` container) Called when this tip is displayed.
`public void` | `onDispose`() Called when this popup is disposed.

## Field Detail

### HORIZONTAL_AT_TOKEN

    public static final int HORIZONTAL_AT_TOKEN

  Horizontal position at the token enclosing the popups offset.

### HORIZONTAL_LEFT_APPLICATION_MARGIN

    public static final int HORIZONTAL_LEFT_APPLICATION_MARGIN

  Horizontal position at the left margin of main application window.

### HORIZONTAL_LEFT_EDITOR_MARGIN

    public static final int HORIZONTAL_LEFT_EDITOR_MARGIN

  Horizontal position at the left margin of the source editor.

### HORIZONTAL_RIGHT_APPLICATION_MARGIN

    public static final int HORIZONTAL_RIGHT_APPLICATION_MARGIN

  Horizontal position at the right margin of the main application window.

### HORIZONTAL_RIGHT_EDITOR_MARGIN

    public static final int HORIZONTAL_RIGHT_EDITOR_MARGIN

  Horizontal position at the right margin of the source editor.

### HORIZONTAL_TAB_AT_OFFSET

    public static final int HORIZONTAL_TAB_AT_OFFSET

  Horizontal position aligning the popup's offset with a tab position specified by the popup

### VERTICAL_ABOVE_TOKEN

    public static final int VERTICAL_ABOVE_TOKEN

  Vertical position above the line containing the popup's editor offset.

### VERTICAL_AT_TOKEN

    public static final int VERTICAL_AT_TOKEN

  Vertical position at the line containing the popup's editor offset.

### VERTICAL_BELOW_TOKEN

    public static final int VERTICAL_BELOW_TOKEN

  Vertical position below the line containing popup's editor offset.

## Method Detail

### disposeOnKeyAction() Method

    public boolean disposeOnKeyAction()

Returns whether this popup should disappear on keyboard actions.

### disposeOnMouseAction() Method

    public boolean disposeOnMouseAction()

Returns whether this popup should disappear on mouse motion.

### getComponent() Method

    public Component getComponent()

Returns the display component of this popup tip

### getHorizontalAlignment() Method

    public int[] getHorizontalAlignment()

Returns an array of horizontal position constants specifying the prefered locations for this component. The positions are tried in order until one is found that can be contained completely within the application window. If all options result in a clipped popup, the first position in the list is used.

### getOffset() Method

    public int getOffset()

Gets the editor offset that is the source of this popup tip

### getTabPosition() Method

    public int getTabPosition()

If HORIZONTAL_TAB_AT_OFFSET horizontal positioning is used, this method return the tab position at which alignment should occur.

### getVerticalAlignment() Method

    public int[] getVerticalAlignment()

Returns an array of vertical position constants specifying the prefered locations for this component. The positions are tried in order until one is found that can be contained completely within the application window. If all options result in a clipped popup, the first position in the list is used.

### onDisplay(IPopupTip.Container) Method

    public void onDisplay(IPopupTip.Container container)

Called when this tip is displayed. This method gives the popup a chance to save a reference to its parent container.

### onDispose() Method

    public void onDispose()

Called when this popup is disposed. This method provides an opportunity for the popup to clean up any resources needed for its display.