eve.ui

Interface MultiCardPanel

All Superinterfaces:

MultiPanel

All Known Implementing Classes:

CardPanel, MultiCardPanelAdapter, ProgressAndControl, TabbedPanel

public interface MultiCardPanel
extends MultiPanel

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD_OPTION_DONT_SHOW_TEXT_WITH_ICON An option with addCard() that indicates that the icon should be used alone and not used together with the cardName value.
static int	EXTRA_CONTROL_BOTTOM A value used with getExtraControlArea()
static int	EXTRA_CONTROL_EXTREME A value used with getExtraControlArea()
static int	EXTRA_CONTROL_LEFT A value used with getExtraControlArea()
static int	EXTRA_CONTROL_RIGHT A value used with getExtraControlArea()
static int	EXTRA_CONTROL_TOP A value used with getExtraControlArea()
static int	OPTION_AUTO_SCROLL A value used with modifyCardOptions()
static int	OPTION_DONT_FOCUS_ON_ANY_SELECT A value used with modifyCardOptions()
static int	OPTION_DONT_FOCUS_ON_NEXT_SELECT A value used with modifyCardOptions()
static int	OPTION_FOCUS_ON_CONTROLS_AFTER_SELECTION_HOT_KEY A value used with modifyCardOptions()
static int	OPTION_ITEM_SELECTOR_ALWAYS_ENABLED A value used with modifyCardOptions()
static int	OPTION_SWIPABLE_HORIZONTALLY A value used with modifyCardOptions()
static int	OPTION_SWIPABLE_VERTICALLY A value used with modifyCardOptions()
static int	OPTION_SWIPE_USING_CONTROL A value used with modifyCardOptions()
static int	OPTION_VERTICAL_SCROLLER A value used with modifyCardOptions()

Method Summary

Modifier and Type	Method and Description
Card	addCard(Control toAdd, IImage icon, String cardName, String longCardName, int options) Add a Card with an icon and card name.
Card	addCard(Control toAdd, String cardName, String longCardName) Add a new item to the MultiCardPanel.
Card	addCard(Control toAdd, String cardName, String longCardName, int cardOptionsToSet, int cardOptionsToClear) Add a Card, but temporarily modify the card options before adding and restore after adding.
CardPanel	getCardPanel() Return the CardPanel associated with this MultiCardPanel (which may be null).
CellPanel	getExtraControlArea(int whichArea) If this MultiCardPanel supports an extra area for placing controls which are not within the dynamic display area, then this will return a CellPanel that you can add controls to which will be displayed in that area.
Card	getItem(Control item) This returns a Card object holding information about the item added for the specified control.
Card	getItem(int index) This returns a Card object holding information about the item added at the specified index.
long	modifyAndSaveCardOptions(int optionsToSet, int optionsToClear) Set and/or clear card options and return a value that can be used with restoreCardOptions() to restore the changed bits back to their original state.
int	modifyCardOptions(int optionsToSet, int optionsToClear) Set and/or clear card options - or return the current options (if optionsToSet and optionsToClear are zero).
int	restoreCardOptions(long savedOptions) Restore the card option bits changed by modifyAndSaveCardOptions().
void	select(Card card) Select the specified card.
void	updateCard(Card card) This can be called explicitly if a change has been made to the Card.

Methods inherited from interface eve.ui.MultiPanel

addItem, getItemCount, getSelectedItem, select, select, select

Field Detail

ADD_OPTION_DONT_SHOW_TEXT_WITH_ICON

static final int ADD_OPTION_DONT_SHOW_TEXT_WITH_ICON

An option with addCard() that indicates that the icon should be used alone and not used together with the cardName value.

See Also:

Constant Field Values

OPTION_DONT_FOCUS_ON_NEXT_SELECT

static final int OPTION_DONT_FOCUS_ON_NEXT_SELECT

A value used with modifyCardOptions()

See Also:

Constant Field Values

OPTION_FOCUS_ON_CONTROLS_AFTER_SELECTION_HOT_KEY

static final int OPTION_FOCUS_ON_CONTROLS_AFTER_SELECTION_HOT_KEY

A value used with modifyCardOptions()

See Also:

Constant Field Values

OPTION_DONT_FOCUS_ON_ANY_SELECT

static final int OPTION_DONT_FOCUS_ON_ANY_SELECT

A value used with modifyCardOptions()

See Also:

Constant Field Values

OPTION_AUTO_SCROLL

static final int OPTION_AUTO_SCROLL

A value used with modifyCardOptions()

See Also:

Constant Field Values

OPTION_ITEM_SELECTOR_ALWAYS_ENABLED

static final int OPTION_ITEM_SELECTOR_ALWAYS_ENABLED

A value used with modifyCardOptions()

See Also:

Constant Field Values

OPTION_SWIPABLE_HORIZONTALLY

static final int OPTION_SWIPABLE_HORIZONTALLY

A value used with modifyCardOptions()

See Also:

Constant Field Values

OPTION_SWIPABLE_VERTICALLY

static final int OPTION_SWIPABLE_VERTICALLY

A value used with modifyCardOptions()

See Also:

Constant Field Values

OPTION_SWIPE_USING_CONTROL

static final int OPTION_SWIPE_USING_CONTROL

A value used with modifyCardOptions()

See Also:

Constant Field Values

OPTION_VERTICAL_SCROLLER

static final int OPTION_VERTICAL_SCROLLER

A value used with modifyCardOptions()

See Also:

Constant Field Values

EXTRA_CONTROL_EXTREME

static final int EXTRA_CONTROL_EXTREME

A value used with getExtraControlArea()

See Also:

Constant Field Values

EXTRA_CONTROL_LEFT

static final int EXTRA_CONTROL_LEFT

A value used with getExtraControlArea()

See Also:

Constant Field Values

EXTRA_CONTROL_RIGHT

static final int EXTRA_CONTROL_RIGHT

A value used with getExtraControlArea()

See Also:

Constant Field Values

EXTRA_CONTROL_TOP

static final int EXTRA_CONTROL_TOP

A value used with getExtraControlArea()

See Also:

Constant Field Values

EXTRA_CONTROL_BOTTOM

static final int EXTRA_CONTROL_BOTTOM

A value used with getExtraControlArea()

See Also:

Constant Field Values

Method Detail

addCard

Card addCard(Control toAdd,
             IImage icon,
             String cardName,
             String longCardName,
             int options)

Add a Card with an icon and card name.

Parameters:

toAdd - the item to add.

icon - an optional icon to associate with the item.

cardName - the display name of item.

longCardName - a longer title for the item.

options - any combination of the ADD_OPTIONS.

Returns:

the added card.

addCard

Card addCard(Control toAdd,
             String cardName,
             String longCardName,
             int cardOptionsToSet,
             int cardOptionsToClear)

Add a Card, but temporarily modify the card options before adding and restore after adding.

Parameters:

toAdd - The item to be added

cardName - The name to appear on the tab.

longName - A longer descriptive name for the tab. If this is null it will be set to tabName.

cardOptionsToSet - any combination of the OPTION_XXX values. These will be set before adding and then restored to original condition after.

cardOptionsToClear - any combination of the OPTION_XXX values. These will be cleared before adding and then restored to original condition after.

Returns:

The Card created for the item.

addCard

Card addCard(Control toAdd,
             String cardName,
             String longCardName)

Add a new item to the MultiCardPanel.

Parameters:

toAdd - The item to be added

cardName - The name to appear on the tab.

longName - A longer descriptive name for the tab. If this is null it will be set to tabName.

Returns:

The Card created for the item.

getCardPanel

CardPanel getCardPanel()

Return the CardPanel associated with this MultiCardPanel (which may be null).

Parameters:

item - The item to be added

tabName - The name to appear on the tab.

longName - A longer descriptive name for the tab. If this is null it will be set to tabName.

Returns:

The Card created for the item.

getItem

Card getItem(int index)

This returns a Card object holding information about the item added at the specified index.

getItem

Card getItem(Control item)

This returns a Card object holding information about the item added for the specified control.

modifyCardOptions

int modifyCardOptions(int optionsToSet,
                      int optionsToClear)

Set and/or clear card options - or return the current options (if optionsToSet and optionsToClear are zero).

Parameters:

optionsToSet - the option bits to set - any of the OPTION_XXX values, but none that are included in options to clear.

optionsToClear - the option bits to clear - any of the OPTION_XXX values, but none that are included in options to set.

Returns:

the new value of the option bits. If both optionsToSet and optionsToClear are 0, then this will return the current state of the options without changing any.

modifyAndSaveCardOptions

long modifyAndSaveCardOptions(int optionsToSet,
                              int optionsToClear)

Set and/or clear card options and return a value that can be used with restoreCardOptions() to restore the changed bits back to their original state.

Parameters:

optionsToSet - the option bits to set - any of the OPTION_XXX values, but none that are included in options to clear.

optionsToClear - the option bits to clear - any of the OPTION_XXX values, but none that are included in options to set.

Returns:

a value that can be used with restoreCardOptions().

restoreCardOptions

int restoreCardOptions(long savedOptions)

Restore the card option bits changed by modifyAndSaveCardOptions().

Parameters:

savedOptions - the value returned by modifyAndSaveCardOptions().

Returns:

the state of the options after restoration.

getExtraControlArea

CellPanel getExtraControlArea(int whichArea)

If this MultiCardPanel supports an extra area for placing controls which are not within the dynamic display area, then this will return a CellPanel that you can add controls to which will be displayed in that area.

Parameters:

whichArea - one of the EXTRA_CONTROL_XXX values possibly OR'ed with the EXTRA_CONTROL_EXTREME option.

Returns:

the specified extra area if present - null if not.

select

void select(Card card)

Select the specified card.

Parameters:

card -

updateCard

void updateCard(Card card)

This can be called explicitly if a change has been made to the Card. Or it may be called by the Card itself if it determines it has been changed (e.g. if it has been iconized).

Parameters:

card -