Eclipse Platform
Release 3.4

org.eclipse.ui.statushandlers
Interface IStatusAdapterConstants


public interface IStatusAdapterConstants

This interface contains common constants important for StatusAdapter.

This interface should not be implemented or extended by clients.

Since:
3.4

Field Summary
static QualifiedName EXPLANATION_PROPERTY
          This property is used to add an explanation to the adapter.
static QualifiedName HINT_PROPERTY
          This property is used to add a hint to the adapter.
static String PROPERTY_PREFIX
          Common prefix for properties defined in this interface.
static QualifiedName TIMESTAMP_PROPERTY
          This property is used to add a timestamp to the adapter.
static QualifiedName TITLE_PROPERTY
          This property is used to add title to the adapter.
 

Field Detail

PROPERTY_PREFIX

public static final String PROPERTY_PREFIX
Common prefix for properties defined in this interface.

See Also:
Constant Field Values

TITLE_PROPERTY

public static final QualifiedName TITLE_PROPERTY
This property is used to add title to the adapter. If the adapter is shown in a dialog, this property is used to create title of the dialog.

The property must be of type String.


TIMESTAMP_PROPERTY

public static final QualifiedName TIMESTAMP_PROPERTY
This property is used to add a timestamp to the adapter. If the adapter is shown in the UI, this property can be used for sorting and showing information about the status creation time.

The property must be of type Long.


EXPLANATION_PROPERTY

public static final QualifiedName EXPLANATION_PROPERTY
This property is used to add an explanation to the adapter. If the adapter is shown in the UI, this property should be used to present additional explanation for the status.

The property must be of type String.


HINT_PROPERTY

public static final QualifiedName HINT_PROPERTY
This property is used to add a hint to the adapter. If the adapter is shown in the UI, this property should be used to present suggested actions that have to be performed by the user.

The property must be of type String.


Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.