org.povclipse2.editors.hovers

Class PovrayInformationControl

java.lang.Object

org.povclipse2.editors.hovers.PovrayInformationControl

public class PovrayInformationControl
extends java.lang.Object

Information control implementation for creating the text hover for folded areas.

This is a code copy of DefaultInformationControl, extended to do syntax highlighting as well as the F2 focus functionality.

Author:

Wolfgang Möstl

See Also:

gitweb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PovrayInformationControl.HoverPopupDialog PopupDialog class providing access to the underlying PovrayInformationControl.

Constructor Summary

Constructors

Constructor and Description
PovrayInformationControl(Shell parent, IInformationPresenter presenter, java.lang.String type) Creates a default information control with the given shell as parent.
PovrayInformationControl(Shell parent, IInformationPresenter presenter, java.lang.String statusFieldText, java.lang.String type) Creates a default information control with the given shell as parent.
PovrayInformationControl(Shell parent, int style, IInformationPresenter presenter, java.lang.String type) Creates a default information control with the given shell as parent.
PovrayInformationControl(Shell parent, int style, IInformationPresenter presenter, java.lang.String statusFieldText, java.lang.String type) Creates a default information control with the given shell as parent.
PovrayInformationControl(Shell parent, int shellStyle, int style, IInformationPresenter presenter, java.lang.String type) Creates a default information control with the given shell as parent.
PovrayInformationControl(Shell parentShell, int shellStyle, int style, IInformationPresenter presenter, java.lang.String statusFieldText, java.lang.String type) Creates a default information control with the given shell as parent.
PovrayInformationControl(Shell parent, java.lang.String type) Creates a default information control with the given shell as parent.

Method Summary

Modifier and Type	Method and Description
void	addDisposeListener(DisposeListener listener)
void	addFocusListener(FocusListener listener)
Point	computeSizeHint()
Rectangle	computeTrim()
void	dispose()
Rectangle	getBounds()
boolean	hasContents()
boolean	isFocusControl()
void	removeDisposeListener(DisposeListener listener)
void	removeFocusListener(FocusListener listener)
boolean	restoresLocation()
boolean	restoresSize()
void	setBackgroundColor(Color background)
void	setFocus()
void	setForegroundColor(Color foreground)
void	setInformation(java.lang.String content)
void	setInput(java.lang.Object input)
void	setLocation(Point location)
void	setSize(int width, int height)
void	setSizeConstraints(int maxWidth, int maxHeight)
void	setVisible(boolean visible)
PopupDialog	showFocusDialog()
void	widgetDisposed(DisposeEvent event) Deprecated. As of 3.2, no longer used and called

Methods inherited from class java.lang.Object

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

Constructor Detail

PovrayInformationControl

public PovrayInformationControl(Shell parent,
                                int shellStyle,
                                int style,
                                IInformationPresenter presenter,
                                java.lang.String type)

Creates a default information control with the given shell as parent. The given information presenter is used to process the information to be displayed. The given styles are applied to the created styled text widget.

Parameters:

parent - the parent shell

shellStyle - the additional styles for the shell

style - the additional styles for the styled text widget

presenter - the presenter to be used

type - the type of syntax highlighting to be used. Only constants from PovClipseMessageTypeIndication are valid, or null to use a generic syntax highlighting.

PovrayInformationControl

public PovrayInformationControl(Shell parentShell,
                                int shellStyle,
                                int style,
                                IInformationPresenter presenter,
                                java.lang.String statusFieldText,
                                java.lang.String type)

Creates a default information control with the given shell as parent. The given information presenter is used to process the information to be displayed. The given styles are applied to the created styled text widget.

Parameters:

parentShell - the parent shell

shellStyle - the additional styles for the shell

style - the additional styles for the styled text widget

presenter - the presenter to be used

statusFieldText - the text to be used in the optional status field or null if the status field should be hidden

type - the type of syntax highlighting to be used. Only constants from PovClipseMessageTypeIndication are valid, or null to use a generic syntax highlighting.

Since:

3.0

PovrayInformationControl

public PovrayInformationControl(Shell parent,
                                int style,
                                IInformationPresenter presenter,
                                java.lang.String type)

Creates a default information control with the given shell as parent. The given information presenter is used to process the information to be displayed. The given styles are applied to the created styled text widget.

Parameters:

parent - the parent shell

style - the additional styles for the styled text widget

presenter - the presenter to be used

type - the type of syntax highlighting to be used. Only constants from PovClipseMessageTypeIndication are valid, or null to use a generic syntax highlighting.

PovrayInformationControl

public PovrayInformationControl(Shell parent,
                                int style,
                                IInformationPresenter presenter,
                                java.lang.String statusFieldText,
                                java.lang.String type)

Creates a default information control with the given shell as parent. The given information presenter is used to process the information to be displayed. The given styles are applied to the created styled text widget.

Parameters:

parent - the parent shell

style - the additional styles for the styled text widget

presenter - the presenter to be used

statusFieldText - the text to be used in the optional status field or null if the status field should be hidden

type - the type of syntax highlighting to be used. Only constants from PovClipseMessageTypeIndication are valid, or null to use a generic syntax highlighting.

Since:

3.0

PovrayInformationControl

public PovrayInformationControl(Shell parent,
                                java.lang.String type)

Creates a default information control with the given shell as parent. No information presenter is used to process the information to be displayed. No additional styles are applied to the styled text widget.

Parameters:

parent - the parent shell

type - the type of syntax highlighting to be used. Only constants from PovClipseMessageTypeIndication are valid, or null to use a generic syntax highlighting.

PovrayInformationControl

public PovrayInformationControl(Shell parent,
                                IInformationPresenter presenter,
                                java.lang.String type)

Creates a default information control with the given shell as parent. The given information presenter is used to process the information to be displayed. No additional styles are applied to the styled text widget.

Parameters:

parent - the parent shell

presenter - the presenter to be used

type - the type of syntax highlighting to be used. Only constants from PovClipseMessageTypeIndication are valid, or null to use a generic syntax highlighting.

PovrayInformationControl

public PovrayInformationControl(Shell parent,
                                IInformationPresenter presenter,
                                java.lang.String statusFieldText,
                                java.lang.String type)

Creates a default information control with the given shell as parent. The given information presenter is used to process the information to be displayed. No additional styles are applied to the styled text widget.

Parameters:

parent - the parent shell

presenter - the presenter to be used

statusFieldText - the text to be used in the optional status field or null if the status field should be hidden

type - the type of syntax highlighting to be used. Only constants from PovClipseMessageTypeIndication are valid, or null to use a generic syntax highlighting.

Method Detail

showFocusDialog

public PopupDialog showFocusDialog()

setInformation

public void setInformation(java.lang.String content)

setVisible

public void setVisible(boolean visible)

dispose

public void dispose()

setSize

public void setSize(int width,
                    int height)

setLocation

public void setLocation(Point location)

setSizeConstraints

public void setSizeConstraints(int maxWidth,
                               int maxHeight)

computeSizeHint

public Point computeSizeHint()

computeTrim

public Rectangle computeTrim()

getBounds

public Rectangle getBounds()

restoresLocation

public boolean restoresLocation()

restoresSize

public boolean restoresSize()

addDisposeListener

public void addDisposeListener(DisposeListener listener)

removeDisposeListener

public void removeDisposeListener(DisposeListener listener)

setForegroundColor

public void setForegroundColor(Color foreground)

setBackgroundColor

public void setBackgroundColor(Color background)

isFocusControl

public boolean isFocusControl()

setFocus

public void setFocus()

addFocusListener

public void addFocusListener(FocusListener listener)

removeFocusListener

public void removeFocusListener(FocusListener listener)

hasContents

public boolean hasContents()

widgetDisposed

public void widgetDisposed(DisposeEvent event)

Deprecated. As of 3.2, no longer used and called

Since:

3.0

See Also:

org.eclipse.swt.events.DisposeListener#widgetDisposed(org.eclipse.swt.events.DisposeEvent)

setInput

public void setInput(java.lang.Object input)