Eclipse Plug-in Developer Guide (Galileo) - AnnotationBarHoverManager.Closer (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.text.source
Class AnnotationBarHoverManager.Closer


java.lang.Object
  

org.eclipse.swt.events.MouseTrackAdapter
      
org.eclipse.jface.text.source.AnnotationBarHoverManager.Closer

All Implemented Interfaces:: EventListener, AbstractInformationControlManager.IInformationControlCloser, ControlListener, DisposeListener, KeyListener, MouseListener, MouseMoveListener, MouseTrackListener, ShellListener, org.eclipse.swt.internal.SWTEventListener, Listener

Enclosing class:: AnnotationBarHoverManager

Deprecated. As of 3.4, no longer used as closer from super class is used

protected class AnnotationBarHoverManager.Closer
extends MouseTrackAdapter
implements AbstractInformationControlManager.IInformationControlCloser, MouseListener, MouseMoveListener, ControlListener, KeyListener, DisposeListener, ShellListener, Listener
extends MouseTrackAdapter
implements AbstractInformationControlManager.IInformationControlCloser, MouseListener, MouseMoveListener, ControlListener, KeyListener, DisposeListener, ShellListener, Listener

The information control closer for the hover information. Closes the information control as soon as the mouse pointer leaves the subject area, a mouse button is pressed, the user presses a key, or the subject control is resized or moved.

Since:: 3.0

Constructor Summary

AnnotationBarHoverManager.Closer ()
          Deprecated. Creates a new information control closer.

Method Summary

void controlMoved ( ControlEvent event)
          Deprecated. Sent when the location (x, y) of a control changes relative to its parent (or relative to the display, for Shells).

void controlResized ( ControlEvent event)
          Deprecated. Sent when the size (width, height) of a control changes.

void handleEvent ( Event event)
          Deprecated. Sent when an event that the receiver has registered for occurs.

void keyPressed ( KeyEvent event)
          Deprecated. Sent when a key is pressed on the system keyboard.

void keyReleased ( KeyEvent event)
          Deprecated. Sent when a key is released on the system keyboard.

void mouseDoubleClick ( MouseEvent event)
          Deprecated. Sent when a mouse button is pressed twice within the (operating system specified) double click period.

void mouseDown ( MouseEvent event)
          Deprecated. Sent when a mouse button is pressed.

void mouseExit ( MouseEvent event)
          Deprecated. Sent when the mouse pointer passes out of the area of the screen covered by a control.

void mouseMove ( MouseEvent event)
          Deprecated. Sent when the mouse moves.

void mouseUp ( MouseEvent event)
          Deprecated. Sent when a mouse button is released.

void setInformationControl ( IInformationControl control)
          Deprecated. Sets the closer's information control, the one to close if necessary.

void setSubjectControl ( Control control)
          Deprecated. Sets the closer's subject control.

void shellActivated ( ShellEvent e)
          Deprecated. Sent when a shell becomes the active window.

void shellClosed ( ShellEvent e)
          Deprecated. Sent when a shell is closed.

void shellDeactivated ( ShellEvent e)
          Deprecated. Sent when a shell stops being the active window.

void shellDeiconified ( ShellEvent e)
          Deprecated. Sent when a shell is un-minimized.

void shellIconified ( ShellEvent e)
          Deprecated. Sent when a shell is minimized.

void start ( Rectangle subjectArea)
          Deprecated. Tells this closer to start monitoring the subject and the information control.

void stop ()
          Deprecated. Tells this closer to stop monitoring the subject and the information control.

protected void stop (boolean delayRestart)
          Deprecated. As of 3.4, replaced by stop(). Note that delayRestart was never honored.

void widgetDisposed ( DisposeEvent e)
          Deprecated. Sent when the widget is disposed.

Methods inherited from class org.eclipse.swt.events. MouseTrackAdapter

mouseEnter, mouseHover

Methods inherited from class java.lang. Object

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

Constructor Detail

AnnotationBarHoverManager.Closer

public AnnotationBarHoverManager.Closer()

Deprecated.

Creates a new information control closer.

Method Detail

setSubjectControl

public void setSubjectControl(
Control control)

Deprecated.

Description copied from interface: AbstractInformationControlManager.IInformationControlCloser

Sets the closer's subject control. This is the control that parents the information control and from which the subject of the information to be shown is retrieved.

Must be called before start. May again be called between start and stop.

Specified by:: setSubjectControl in interface AbstractInformationControlManager.IInformationControlCloser

Parameters:: control - the subject control

setInformationControl

public void setInformationControl(
IInformationControl control)

Deprecated.

Description copied from interface: AbstractInformationControlManager.IInformationControlCloser

Sets the closer's information control, the one to close if necessary.

Must be called before start. May again be called between start and stop.

Specified by:: setInformationControl in interface AbstractInformationControlManager.IInformationControlCloser

Parameters:: control - the information control

start

public void start(
Rectangle subjectArea)

Deprecated.

Description copied from interface: AbstractInformationControlManager.IInformationControlCloser

Tells this closer to start monitoring the subject and the information control. The presented information is considered valid for the given area of the subject control's display.

Specified by:: start in interface AbstractInformationControlManager.IInformationControlCloser

Parameters:: subjectArea - the area for which the presented information is valid

stop

public void stop()

Deprecated.

Description copied from interface: AbstractInformationControlManager.IInformationControlCloser

Tells this closer to stop monitoring the subject and the information control.

Specified by:: stop in interface AbstractInformationControlManager.IInformationControlCloser

stop

protected void stop(boolean delayRestart)

Deprecated. As of 3.4, replaced by stop(). Note that delayRestart was never honored.

Stops the information control and if delayRestart is set allows restart only after a certain delay.

Parameters:: delayRestart - true if restart should be delayed

mouseMove

public void mouseMove(
MouseEvent event)

Deprecated.

Description copied from interface: MouseMoveListener

Sent when the mouse moves.

Specified by:: mouseMove in interface MouseMoveListener

Parameters:: event - an event containing information about the mouse move

mouseUp

public void mouseUp(
MouseEvent event)

Deprecated.

Description copied from interface: MouseListener

Sent when a mouse button is released.

Specified by:: mouseUp in interface MouseListener

Parameters:: event - an event containing information about the mouse button release

mouseDown

public void mouseDown(
MouseEvent event)

Deprecated.

Description copied from interface: MouseListener

Sent when a mouse button is pressed.

Specified by:: mouseDown in interface MouseListener

Parameters:: event - an event containing information about the mouse button press

mouseDoubleClick

public void mouseDoubleClick(
MouseEvent event)

Deprecated.

Description copied from interface: MouseListener

Sent when a mouse button is pressed twice within the (operating system specified) double click period.

Specified by:: mouseDoubleClick in interface MouseListener

Parameters:: event - an event containing information about the mouse double click
See Also:: Display.getDoubleClickTime()

handleEvent

public void handleEvent(
Event event)

Deprecated.

Description copied from interface: Listener

Sent when an event that the receiver has registered for occurs.

Specified by:: handleEvent in interface Listener

Parameters:: event - the event which occurred

mouseExit

public void mouseExit(
MouseEvent event)

Deprecated.

Description copied from class: MouseTrackAdapter

Sent when the mouse pointer passes out of the area of the screen covered by a control. The default behavior is to do nothing.

Specified by:: mouseExit in interface MouseTrackListener
Overrides:: mouseExit in class MouseTrackAdapter

Parameters:: event - an event containing information about the mouse exit

controlResized

public void controlResized(
ControlEvent event)

Deprecated.

Description copied from interface: ControlListener

Sent when the size (width, height) of a control changes.

Specified by:: controlResized in interface ControlListener

Parameters:: event - an event containing information about the resize

controlMoved

public void controlMoved(
ControlEvent event)

Deprecated.

Description copied from interface: ControlListener

Sent when the location (x, y) of a control changes relative to its parent (or relative to the display, for Shells).

Specified by:: controlMoved in interface ControlListener

Parameters:: event - an event containing information about the move

keyReleased

public void keyReleased(
KeyEvent event)

Deprecated.

Description copied from interface: KeyListener

Sent when a key is released on the system keyboard.

Specified by:: keyReleased in interface KeyListener

Parameters:: event - an event containing information about the key release

keyPressed

public void keyPressed(
KeyEvent event)

Deprecated.

Description copied from interface: KeyListener

Sent when a key is pressed on the system keyboard.

Specified by:: keyPressed in interface KeyListener

Parameters:: event - an event containing information about the key press

shellActivated

public void shellActivated(
ShellEvent e)

Deprecated.

Description copied from interface: ShellListener

Sent when a shell becomes the active window.

Specified by:: shellActivated in interface ShellListener

Parameters:: e - an event containing information about the activation

shellClosed

public void shellClosed(
ShellEvent e)

Deprecated.

Description copied from interface: ShellListener

Sent when a shell is closed.

Specified by:: shellClosed in interface ShellListener

Parameters:: e - an event containing information about the close

shellDeactivated

public void shellDeactivated(
ShellEvent e)

Deprecated.

Description copied from interface: ShellListener

Sent when a shell stops being the active window.

Specified by:: shellDeactivated in interface ShellListener

Parameters:: e - an event containing information about the deactivation

shellDeiconified

public void shellDeiconified(
ShellEvent e)

Deprecated.

Description copied from interface: ShellListener

Sent when a shell is un-minimized.

Specified by:: shellDeiconified in interface ShellListener

Parameters:: e - an event containing information about the un-minimization

shellIconified

public void shellIconified(
ShellEvent e)

Deprecated.

Description copied from interface: ShellListener

Sent when a shell is minimized.

Specified by:: shellIconified in interface ShellListener

Parameters:: e - an event containing information about the minimization

widgetDisposed

public void widgetDisposed(
DisposeEvent e)

Deprecated.

Description copied from interface: DisposeListener

Sent when the widget is disposed.

Specified by:: widgetDisposed in interface DisposeListener

Parameters:: e - an event containing information about the dispose

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Guidelines for using Eclipse APIs.

org.eclipse.jface.text.source Class AnnotationBarHoverManager.Closer

AnnotationBarHoverManager.Closer

setSubjectControl

setInformationControl

start

stop

stop

mouseMove

mouseUp

mouseDown

mouseDoubleClick

handleEvent

mouseExit

controlResized

controlMoved

keyReleased

keyPressed

shellActivated

shellClosed

shellDeactivated

shellDeiconified

shellIconified

widgetDisposed

org.eclipse.jface.text.source
Class AnnotationBarHoverManager.Closer