ch.tatool.core.display.swing

Interface SwingExecutionDisplay

All Superinterfaces:

ExecutionDisplay

All Known Implementing Classes:

SwingExecutionFrame

public interface SwingExecutionDisplay
extends ExecutionDisplay

Swing container provided to elements to interact with the user Components can be added to the Display in a "Card style view" manner, where each component is displayed in full at once. In addition to the displayed card, an overlay can be added to the display, which will be displayed above the displayed card. Note: All methods in this interface need to be called from the AWT Event Dispatch thread only.

Author:

Michael Ruflin

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_CARD_ID ID of the empty card.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCard(String cardId, Component component) Add a card to this display
void	displayEmptyCard() Display an empty card.
Color	getBackgroundColor() Get the background color of the display.
String	getDisplayedCardId() Get the currently displayed card.
void	removeAllCards() Remove all added cards.
void	removeCard(String cardId) Removes a card from the display.
void	setBackgroundColor(Color color) Set the background color of the display.
void	setOverlay(Component component) Set the overlay component to be displayed.
void	showCard(String cardId) Display a previously added card.

Field Detail

EMPTY_CARD_ID

static final String EMPTY_CARD_ID

ID of the empty card.

See Also:

Constant Field Values

Method Detail

addCard

void addCard(String cardId,
           Component component)

Add a card to this display

showCard

void showCard(String cardId)

Display a previously added card.

removeCard

void removeCard(String cardId)

Removes a card from the display.

removeAllCards

void removeAllCards()

Remove all added cards.

displayEmptyCard

void displayEmptyCard()

Display an empty card.

getDisplayedCardId

String getDisplayedCardId()

Get the currently displayed card.

setOverlay

void setOverlay(Component component)

Set the overlay component to be displayed.

Parameters:

component - the overlay component to display, null to remove any displayed component

getBackgroundColor

Color getBackgroundColor()

Get the background color of the display.

Returns:

the background color, with white being default

setBackgroundColor

void setBackgroundColor(Color color)

Set the background color of the display.

Parameters:

color - the background color to set.