Class AbstractStatusAreaProvider

java.lang.Object
org.eclipse.jface.dialogs.ErrorSupportProvider
org.eclipse.ui.statushandlers.AbstractStatusAreaProvider

public abstract class AbstractStatusAreaProvider extends ErrorSupportProvider

A status area provider creates an area that displays detailed information about StatusAdapter or IStatus.

The area provider can be set in WorkbenchStatusDialogManager as well as in JFace Policy since its extends ErrorSupportProvider.

Since:
3.4
See Also:
  • Constructor Details

    • AbstractStatusAreaProvider

      public AbstractStatusAreaProvider()
  • Method Details

    • createSupportArea

      public abstract Control createSupportArea(Composite parent, StatusAdapter statusAdapter)
      Create an area for detailed support area as a child of the given parent.
      Parameters:
      parent - A Composite that will host support area.
      statusAdapter - The StatusAdapter to be supported.
      Returns:
      a control, that hold all support elements.
    • createSupportArea

      public final Control createSupportArea(Composite parent, IStatus status)
      Description copied from class: ErrorSupportProvider
      Create an area for adding support components as a child of parent.
      Specified by:
      createSupportArea in class ErrorSupportProvider
      Parameters:
      parent - The parent Composite
      status - The IStatus that is being displayed.
      Returns:
      Control
    • validFor

      public boolean validFor(StatusAdapter statusAdapter)
      This method is called before createSupportArea(Composite, StatusAdapter) to check if it will display any significant implementation.

      Important: This API is a part of work in progress and therefore is suitable only for support area providers (which are presented in the status dialog tray).

      Parameters:
      statusAdapter - - StatusAdapter for which status are will be requested.
      Returns:
      true if provider is able to process particular StatusAdapter
      Since:
      3.6