org.eclipse.jface.internal.text

Class InformationControlReplacer [ source ]

java.lang.Object

org.eclipse.jface.text.AbstractInformationControlManager

org.eclipse.jface.internal.text.InformationControlReplacer

Direct Known Subclasses:

StickyHoverManager

public class InformationControlReplacer
extends AbstractInformationControlManager

An information control replacer can replace an AbstractInformationControlManager's control.

The AbstractInformationControlManager can be configured with such a replacer by calling setInformationControlReplacer.

Since:

3.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	InformationControlReplacer.DefaultInformationControlCreator Default control creator.

Nested classes/interfaces inherited from class org.eclipse.jface.text.AbstractInformationControlManager

AbstractInformationControlManager.Anchor, AbstractInformationControlManager.IInformationControlCloser

Field Summary

Fields inherited from class org.eclipse.jface.text.AbstractInformationControlManager

ANCHOR_BOTTOM, ANCHOR_GLOBAL, ANCHOR_LEFT, ANCHOR_RIGHT, ANCHOR_TOP, DEBUG, fDisposed, fInformationControl, fInformationControlCloser, fInformationControlCreator, STORE_LOCATION_X, STORE_LOCATION_Y, STORE_SIZE_HEIGHT, STORE_SIZE_WIDTH

Constructor Summary

Constructors

Constructor and Description
InformationControlReplacer(IInformationControlCreator creator) Creates a new information control replacer.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	computeInformation() Computes the information to be displayed and the area in which the computed information is valid.
IInformationControl	getCurrentInformationControl2()
int	getKeepUpMargin() The number of pixels to blow up the keep-up zone.
void	hideInformationControl() Hides the information control and stops the information control closer.
boolean	isReplacing() Tells whether the replacer is currently replacing another information control.
void	replaceInformationControl(IInformationControlCreator informationPresenterControlCreator, Rectangle contentBounds, Object information, Rectangle subjectArea, boolean takeFocus) Replace the information control.
void	setDelayedInput(Object input)
void	showInformationControl(Rectangle subjectArea, Object information) Opens the information control with the given information and the specified subject area.

Methods inherited from class org.eclipse.jface.text.AbstractInformationControlManager

canClearDataOnHide, computeAvailableArea, computeInformationControlLocation, computeLocation, computeSizeConstraints, computeSizeConstraints, dispose, disposeInformationControl, doShowInformation, getInformationControl, getInternalAccessor, getNextFallbackAnchor, getSubjectArea, getSubjectControl, handleInformationControlDisposed, handleSubjectControlDisposed, install, isEnabled, presentInformation, restoreInformationControlBounds, setAnchor, setCloser, setCustomInformationControlCreator, setEnabled, setFallbackAnchors, setInformation, setInformation, setMargins, setRestoreInformationControlBounds, setSizeConstraints, showInformation, showInformationControl, storeInformationControlBounds, takesFocusWhenVisible, updateLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

InformationControlReplacer

public InformationControlReplacer(IInformationControlCreator creator)

Creates a new information control replacer.

Parameters:

creator - the default information control creator

Method Detail

replaceInformationControl

public void replaceInformationControl(IInformationControlCreator informationPresenterControlCreator,
                             Rectangle contentBounds,
                             Object information,
                             Rectangle subjectArea,
                             boolean takeFocus)

Replace the information control.

Parameters:

informationPresenterControlCreator - the information presenter control creator

contentBounds - the bounds of the content area of the information control

information - the information to show

subjectArea - the subject area

takeFocus - true iff the replacing information control should take focus

computeInformation

protected void computeInformation()

Description copied from class: AbstractInformationControlManager

Computes the information to be displayed and the area in which the computed information is valid. Implementation of this method must finish their computation by setting the computation results using setInformation.

Specified by:

computeInformation in class AbstractInformationControlManager

showInformationControl

public void showInformationControl(Rectangle subjectArea,
                          Object information)

Opens the information control with the given information and the specified subject area. It also activates the information control closer.

Parameters:

subjectArea - the information area

information - the information

hideInformationControl

public void hideInformationControl()

Description copied from class: AbstractInformationControlManager

Hides the information control and stops the information control closer.

Overrides:

hideInformationControl in class AbstractInformationControlManager

setDelayedInput

public void setDelayedInput(Object input)

Parameters:

input - the delayed input, or null to request cancellation

isReplacing

public boolean isReplacing()

Tells whether the replacer is currently replacing another information control.

Returns:

true while code from replaceInformationControl(IInformationControlCreator, Rectangle, Object, Rectangle, boolean) is run

getCurrentInformationControl2

public IInformationControl getCurrentInformationControl2()

Returns:

the current information control, or null if none available

getKeepUpMargin

public int getKeepUpMargin()

The number of pixels to blow up the keep-up zone.

Returns:

the margin in pixels