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 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.
      Since:
      3.6
      See Also:
  • 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, 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'
  • Method Details

    • fill

      public void fill(Composite parent)
      Description copied from class: ContributionItem
      The default implementation of this IContributionItem method does nothing. Subclasses may override.
      Specified by:
      fill in interface IContributionItem
      Overrides:
      fill in class ContributionItem
      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 be null