Class StatusLineContributionItem

java.lang.Object
org.eclipse.jface.action.ContributionItem
org.eclipse.ui.texteditor.StatusLineContributionItem
All Implemented Interfaces:
IContributionItem, IStatusField, IStatusFieldExtension

public class StatusLineContributionItem extends ContributionItem implements IStatusField, IStatusFieldExtension
Contribution item for the status line.
Since:
2.0
  • Constructor Details

    • StatusLineContributionItem

      public StatusLineContributionItem(String id)
      Creates a new item with the given id.
      Parameters:
      id - the item's id
    • StatusLineContributionItem

      public StatusLineContributionItem(String id, boolean visible, int widthInChars)
      Creates a new item with the given attributes.
      Parameters:
      id - the item's id
      visible - the visibility of this item
      widthInChars - the width in characters
      Since:
      3.0
  • Method Details

    • setText

      public void setText(String text)
      Description copied from interface: IStatusField
      Sets the text of this status field.
      Specified by:
      setText in interface IStatusField
      Parameters:
      text - the text shown in the status field
    • setImage

      public void setImage(Image image)
      Description copied from interface: IStatusField
      Sets the image of this status field.
      Specified by:
      setImage in interface IStatusField
      Parameters:
      image - the image shown in the status field
    • setErrorText

      public void setErrorText(String text)
      Description copied from interface: IStatusFieldExtension
      Sets the text of this status field.

      The error text overrides the current text until the error text is cleared (set to null).

      Specified by:
      setErrorText in interface IStatusFieldExtension
      Parameters:
      text - the error text shown in the status field or null to clear
      See Also:
    • setErrorImage

      public void setErrorImage(Image image)
      Description copied from interface: IStatusFieldExtension
      Sets the error image of this status field.

      The error image overrides the current image until the error image is cleared (set to null).

      Specified by:
      setErrorImage in interface IStatusFieldExtension
      Parameters:
      image - the error image shown in the status field or null to clear
      See Also:
    • setToolTipText

      public void setToolTipText(String string)
      Description copied from interface: IStatusFieldExtension
      Sets tool tip text for this status field.
      Specified by:
      setToolTipText in interface IStatusFieldExtension
      Parameters:
      string - the new tool tip text or null to clear
    • 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
    • setActionHandler

      public void setActionHandler(IAction actionHandler)