oracle.javatools.ui

Class StatusIndicator

java.lang.Object

oracle.javatools.ui.StatusIndicator

public final class StatusIndicator
extends java.lang.Object

Standard indicator of status. Includes an icon and rollover pop up.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatusIndicator.Location Where the status indicator will appear.
static class	StatusIndicator.OkPolicy Enum of values indicating what to show when the indicator is at Status OK
static class	StatusIndicator.Status Possible status levels that can be displayed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_STATUS Property fired when the status changes
static java.lang.String	PROPERTY_STATUS_INDICATOR Components may store a status indicator as a client property:
static int	SIZE The size of the status indicator.

Constructor Summary

Constructors

Constructor and Description
StatusIndicator()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
javax.swing.JComponent	configureLabel(javax.swing.JLabel label, StatusIndicator.Location location) Add this status indicator to the given label and return a component containing both.
javax.swing.JComponent	configureStandalone(StatusIndicator.OkPolicy okPolicy) Get a new standalone component to display status for this indicator.
void	configureTab(javax.swing.JTabbedPane tabbedPane, int tabIndex) Add this status indicator to the given tab index on a JTabbedPane.
javax.swing.Icon	getIcon(StatusIndicator.OkPolicy okPolicy) Return an icon representing the current status.
StatusIndicator.Status	getStatus()
static void	main(java.lang.String[] args) Test method, do not call.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	setInfoTipContent(Template template) Set the content for the infotip which will appear when the mouse cursor hovers over the status component.
void	setStatus(StatusIndicator.Status status) Set the status.

Methods inherited from class java.lang.Object

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

Field Detail

SIZE

public static final int SIZE

The size of the status indicator.

See Also:

Constant Field Values

PROPERTY_STATUS_INDICATOR

public static final java.lang.String PROPERTY_STATUS_INDICATOR

Components may store a status indicator as a client property:

comp.putClientProperty(PROPERTY_STATUS_INDICATOR, statusIndicator);

and other components may read this property, e.g. a FlatTabbedPaneUI will look for status indicators in client properties of tab header components in order to display a status icon on the tab header.

See Also:

Constant Field Values

PROPERTY_STATUS

public static final java.lang.String PROPERTY_STATUS

Property fired when the status changes

See Also:

Constant Field Values

Constructor Detail

StatusIndicator

public StatusIndicator()

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

setStatus

public void setStatus(StatusIndicator.Status status)

Set the status.

Parameters:

status - the current status

getStatus

public StatusIndicator.Status getStatus()

Returns:

the current status.

getIcon

public javax.swing.Icon getIcon(StatusIndicator.OkPolicy okPolicy)

Return an icon representing the current status. For most cases one of the configure... methods should be used to represent status in a UI.

Returns:

an icon representing the current status.

configureStandalone

public javax.swing.JComponent configureStandalone(StatusIndicator.OkPolicy okPolicy)

Get a new standalone component to display status for this indicator.

Multiple calls to the method will return a new component each call.

This method will also add a client property key: PROPERTY_STATUS_INDICATOR, value: this StatusIndicator into the returned component's client properties.

Returns:

the component indicating the status.

configureTab

public void configureTab(javax.swing.JTabbedPane tabbedPane,
                         int tabIndex)

Add this status indicator to the given tab index on a JTabbedPane. The name and icon (optional) are taken from the existing tab.

This works for both standard JTabbedPane and FlatTabbedPaneUI

This method will also add a client property key: PROPERTY_STATUS_INDICATOR, value: this StatusIndicator into the JTabbedPane client properties.

Parameters:

tabbedPane -

tabIndex -

configureLabel

public javax.swing.JComponent configureLabel(javax.swing.JLabel label,
                                             StatusIndicator.Location location)

Add this status indicator to the given label and return a component containing both.

This method will also add a client property key: PROPERTY_STATUS_INDICATOR, value: this StatusIndicator into the given JLabel adn the returned JComponent's client properties.

Parameters:

label -

setInfoTipContent

public void setInfoTipContent(Template template)

Set the content for the infotip which will appear when the mouse cursor hovers over the status component.

The StatusSummaryTemplate was created especially for use in a status indicator, it should be preferred over custom templates.

Parameters:

template - the infotip template, or null for no hover.

main

public static void main(java.lang.String[] args)

Test method, do not call.

Parameters:

args -