oracle.javatools.ui.overview

Class OverviewStatus

java.lang.Object

oracle.javatools.ui.overview.OverviewStatus

public final class OverviewStatus
extends java.lang.Object

An OverviewStatus is a special indicator mark that can appear at the start of an Overview to give a summary of the overall state of the overview.

Field Summary

Fields

Modifier and Type	Field and Description
static javax.swing.Icon	BUSY_ICON A common icon that represents the overview is busy (e.g.
static java.awt.Color	ERROR The common error status color.
static java.awt.Color	INCOMPLETE The common incomplete status color.
static java.awt.Color	OK The common OK status color.
static java.awt.Color	WARNING The common warning status color.

Constructor Summary

Constructors

Constructor and Description
OverviewStatus(Overview overview) Create an OverviewStatus.

Method Summary

Methods

Modifier and Type	Method and Description
void	setColor(java.awt.Color color) Set the status to render in the given color.
void	setIcon(javax.swing.Icon icon) Set the status to render the given icon.
void	setTipProvider(OverviewTipProvider provider) Set an optional tip provider to create content for a tip that may appear when the mouse is hovered over the status area.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BUSY_ICON

public static final javax.swing.Icon BUSY_ICON

A common icon that represents the overview is busy (e.g. calculating it's marks).

ERROR

public static final java.awt.Color ERROR

The common error status color.

OK

public static final java.awt.Color OK

The common OK status color.

WARNING

public static final java.awt.Color WARNING

The common warning status color.

INCOMPLETE

public static final java.awt.Color INCOMPLETE

The common incomplete status color.

Constructor Detail

OverviewStatus

public OverviewStatus(Overview overview)

Create an OverviewStatus.

Method Detail

setColor

public void setColor(java.awt.Color color)

Set the status to render in the given color.

Parameters:

color -

setIcon

public void setIcon(javax.swing.Icon icon)

Set the status to render the given icon.

Parameters:

icon -

setTipProvider

public void setTipProvider(OverviewTipProvider provider)

Set an optional tip provider to create content for a tip that may appear when the mouse is hovered over the status area.

The provider will be called with a set of all of the marks in the overview.

Parameters:

provider -