Package org.eclipse.jface.action
Class StatusLineContributionItem
- java.lang.Object
-
- org.eclipse.jface.action.ContributionItem
-
- org.eclipse.jface.action.StatusLineContributionItem
-
- All Implemented Interfaces:
IContributionItem
public class StatusLineContributionItem extends ContributionItem
A contribution item to be used with status line managers.This class may be instantiated; it is not intended to be subclassed.
- Since:
- 3.4
-
-
Field Summary
Fields Modifier and Type Field Description static 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, int charWidth)
Creates a status line contribution item with the given id that displays the given number of characters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
fill(Composite parent)
The default implementation of thisIContributionItem
method does nothing.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.void
setText(String text)
Sets the text to be displayed in the status line.-
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
-
-
-
-
Field Detail
-
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.- Since:
- 3.6
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
StatusLineContributionItem
public StatusLineContributionItem(String id)
Creates a status line contribution item with the given id.- Parameters:
id
- the contribution item's id, ornull
if it is to have no id
-
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, ornull
if it is to have no idcharWidth
- 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'
-
-
Method Detail
-
fill
public void fill(Composite parent)
Description copied from class:ContributionItem
The default implementation of thisIContributionItem
method does nothing. Subclasses may override.- Specified by:
fill
in interfaceIContributionItem
- Overrides:
fill
in classContributionItem
- Parameters:
parent
- the parent control
-
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.
-
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 benull
-
-