Package org.yamcs.studio.core.utils

Class StatusLineContributionItem

java.lang.Object

org.eclipse.jface.action.ContributionItem

org.yamcs.studio.core.utils.StatusLineContributionItem

All Implemented Interfaces:

IContributionItem

Direct Known Subclasses:

ConnectionStringStatusLineContributionItem, MissionTimeStatusLineContributionItem, ProcessorStatusLineContributionItem

public class StatusLineContributionItem
extends ContributionItem

A contribution item to be used with status line managers. Forked and modified from jface's StatusLineContributionItem, because it does not provide good customization options. (e.g. no tooltip support)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CALC_TRUE_WIDTH	A constant indicating that the contribution should compute its actual size depending on the text.

Constructor Summary

Constructors

Constructor	Description
StatusLineContributionItem(String id)	Creates a status line contribution item with the given id.
StatusLineContributionItem(String id, boolean addTrailingSeparator)
StatusLineContributionItem(String id, int charWidth)	Creates a status line contribution item with the given id that displays the given number of characters.
StatusLineContributionItem(String id, int charWidth, boolean addTrailingSeparator)

Method Summary

Modifier and Type	Method	Description
void	addClickListener(Listener listener)
void	fill(Composite parent)
Point	getDisplayLocation()	An accessor for the current location of this status line contribution item -- relative to the display.
String	getText()	Retrieves the text that is being displayed in the status line.
boolean	isDisposed()
void	setErrorText(String errorText, String errorDetail)
void	setImage(Image image)
void	setText(String text)	Sets the text to be displayed in the status line.
void	setToolTipText(String tooltip)

Methods inherited from class org.eclipse.jface.action.ContributionItem

dispose, fill, fill, fill, getId, getParent, isDirty, isDynamic, isEnabled, isGroupMarker, isSeparator, isVisible, saveWidgetState, setId, setParent, setVisible, toString, update, update

Methods inherited from class java.lang.Object

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

Field Details

CALC_TRUE_WIDTH

public static final int CALC_TRUE_WIDTH

A constant indicating that the contribution should compute its actual size depending on the text. It will grab all space necessary to display the whole text.

See Also:

• Constant Field Values

Constructor Details

StatusLineContributionItem

public StatusLineContributionItem(String id)

Creates a status line contribution item with the given id.

Parameters:

id - the contribution item's id, or null if it is to have no id

StatusLineContributionItem

public StatusLineContributionItem(String id,
 boolean addTrailingSeparator)

StatusLineContributionItem

public StatusLineContributionItem(String id,
 int charWidth)

Creates a status line contribution item with the given id that displays the given number of characters.

Parameters:

id - the contribution item's id, or null if it is to have no id

charWidth - the number of characters to display. If the value is CALC_TRUE_WIDTH then the contribution will compute the preferred size exactly. Otherwise the size will be based on the average character size * 'charWidth'

StatusLineContributionItem

public StatusLineContributionItem(String id,
 int charWidth,
 boolean addTrailingSeparator)

Method Details

fill

public void fill(Composite parent)

Specified by:

fill in interface IContributionItem

Overrides:

fill in class ContributionItem

isDisposed

public boolean isDisposed()

getDisplayLocation

public Point getDisplayLocation()

An accessor for the current location of this status line contribution item -- relative to the display.

Returns:

The current location of this status line; null if not yet initialized.

setToolTipText

public void setToolTipText(String tooltip)

setImage

public void setImage(Image image)

setErrorText

public void setErrorText(String errorText,
 String errorDetail)

addClickListener

public void addClickListener(Listener listener)

getText

public String getText()

Retrieves the text that is being displayed in the status line.

Returns:

the text that is currently being displayed

setText

public void setText(String text)

Sets the text to be displayed in the status line.

Parameters:

text - the text to be displayed, must not be null