org.povclipse2.common

Class PovClipseHoverPresenter

java.lang.Object

org.povclipse2.common.PovClipseHoverPresenter

public class PovClipseHoverPresenter
extends java.lang.Object

IInformationPresenter used by text hovers.

Author:

Wolfgang Möstl

See Also:

gitweb

Field Summary

Fields

Modifier and Type	Field and Description
static int	HOVER_TYPE_CODE
static int	HOVER_TYPE_COLOR
static int	HOVER_TYPE_COLOR_MAP
static int	HOVER_TYPE_DECLARATION
static int	HOVER_TYPE_DEFAULT
static int	HOVER_TYPE_ERROR
static int	HOVER_TYPE_INCLUDE
static int	HOVER_TYPE_MACRO

Constructor Summary

Constructors

Constructor and Description
PovClipseHoverPresenter() Constructor reading the colors from the preference store.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getExtraInfo(java.lang.String msg) Gets the extra information stored between the TYPE information and the TYPE_DELIMETER.
static int	getHoverType(java.lang.String msg) Gets the hover type using the hover message.
static java.lang.String	getStrippedHoverMessage(java.lang.String msg)
static boolean	isHoverTypeCode(java.lang.String msg) Checks whether the hover message belongs to a code-folding or not.
static boolean	isHoverTypeColor(java.lang.String msg) Checks whether the hover message belongs to a color or not.
static boolean	isHoverTypeColorMap(java.lang.String msg) Checks whether the hover message belongs to a color_map or not.
static boolean	isHoverTypeDeclaration(java.lang.String msg) Checks whether the hover message belongs to a declare statement or not.
static boolean	isHoverTypeInclude(java.lang.String msg) Checks whether the hover message belongs to a include statement or not.
static boolean	isHoverTypeMacro(java.lang.String msg) Checks whether the hover message belongs to a macro or not.
java.lang.String	updatePresentation(Display display, java.lang.String hoverInfo, TextPresentation presentation, int maxWidth, int maxHeight) Default implemtation, not uased by the framework as this class implements IInformationPresenterExtension as well!
java.lang.String	updatePresentation(Drawable drawable, java.lang.String hoverInfo, TextPresentation presentation, int maxWidth, int maxHeight)

Methods inherited from class java.lang.Object

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

Field Detail

HOVER_TYPE_DEFAULT

public static final int HOVER_TYPE_DEFAULT

See Also:

Constant Field Values

HOVER_TYPE_CODE

public static final int HOVER_TYPE_CODE

See Also:

Constant Field Values

HOVER_TYPE_MACRO

public static final int HOVER_TYPE_MACRO

See Also:

Constant Field Values

HOVER_TYPE_INCLUDE

public static final int HOVER_TYPE_INCLUDE

See Also:

Constant Field Values

HOVER_TYPE_DECLARATION

public static final int HOVER_TYPE_DECLARATION

See Also:

Constant Field Values

HOVER_TYPE_COLOR

public static final int HOVER_TYPE_COLOR

See Also:

Constant Field Values

HOVER_TYPE_COLOR_MAP

public static final int HOVER_TYPE_COLOR_MAP

See Also:

Constant Field Values

HOVER_TYPE_ERROR

public static final int HOVER_TYPE_ERROR

See Also:

Constant Field Values

Constructor Detail

PovClipseHoverPresenter

public PovClipseHoverPresenter()

Constructor reading the colors from the preference store.

Method Detail

updatePresentation

public java.lang.String updatePresentation(Display display,
                                           java.lang.String hoverInfo,
                                           TextPresentation presentation,
                                           int maxWidth,
                                           int maxHeight)

Default implemtation, not uased by the framework as this class implements IInformationPresenterExtension as well!

See Also:

org.eclipse.jface.text.DefaultInformationControl$IInformationPresenter#updatePresentation(org.eclipse.swt.widgets.Display, java.lang.String, org.eclipse.jface.text.TextPresentation, int, int)

updatePresentation

public java.lang.String updatePresentation(Drawable drawable,
                                           java.lang.String hoverInfo,
                                           TextPresentation presentation,
                                           int maxWidth,
                                           int maxHeight)

See Also:

org.eclipse.jface.text.DefaultInformationControl$IInformationPresenterExtension#updatePresentation(org.eclipse.swt.graphics.Drawable, java.lang.String, org.eclipse.jface.text.TextPresentation, int, int)

getHoverType

public static int getHoverType(java.lang.String msg)

Gets the hover type using the hover message.

Parameters:

msg - The hover message including the ttype prefix.

Returns:

One of the HOVER_TYPE_* constants. If the msg is null or the type is either unknown or not set HOVER_TYPE_DEFAULT is returned.

isHoverTypeColor

public static boolean isHoverTypeColor(java.lang.String msg)

Checks whether the hover message belongs to a color or not.

Parameters:

msg - The message to be processed.

Returns:

true it the message belongs to a color hover.

isHoverTypeColorMap

public static boolean isHoverTypeColorMap(java.lang.String msg)

Checks whether the hover message belongs to a color_map or not.

Parameters:

msg - The message to be processed.

Returns:

true it the message belongs to a color_map hover.

isHoverTypeMacro

public static boolean isHoverTypeMacro(java.lang.String msg)

Checks whether the hover message belongs to a macro or not.

Parameters:

msg - The message to be processed.

Returns:

true it the message belongs to a macro hover.

isHoverTypeCode

public static boolean isHoverTypeCode(java.lang.String msg)

Checks whether the hover message belongs to a code-folding or not.

Parameters:

msg - The message to be processed.

Returns:

true it the message belongs to a code-folding hover.

isHoverTypeInclude

public static boolean isHoverTypeInclude(java.lang.String msg)

Checks whether the hover message belongs to a include statement or not.

Parameters:

msg - The message to be processed.

Returns:

true it the message belongs to a include hover.

isHoverTypeDeclaration

public static boolean isHoverTypeDeclaration(java.lang.String msg)

Checks whether the hover message belongs to a declare statement or not.

Parameters:

msg - The message to be processed.

Returns:

true it the message belongs to a declare hover.

getExtraInfo

public static java.lang.String getExtraInfo(java.lang.String msg)

Gets the extra information stored between the TYPE information and the TYPE_DELIMETER.

Parameters:

msg - The message to be processed.

Returns:

See above.

getStrippedHoverMessage

public static java.lang.String getStrippedHoverMessage(java.lang.String msg)