ewe.ui
Class Card

java.lang.Object
  ewe.ui.Card

public class Card

extends Object

A Card represents a Control that has been added to a Control that implements MultiPanel - a CardPanel, for example.

Field Summary

IImage	closedImage If this is not null then it will be displayed when the card is not selected.
static int	DISABLED A flag.
int	flags
static int	HIDDEN A flag.
IImage	image If this is not null then this will be displayed instead of the tab text.
Control	item This is the item that was added to the MultiPanel.
String	longName This is the longName given to the item when it was added to the MultiPanel.
CellPanel	panel This is the CellPanel which contains the item which was added to the MultiPanel.
String	tabName This is the short (tab) name given to the item when it was added to the MultiPanel.
Object	tip If this is not null then this will be the tool tip for the tab.

Constructor Summary

Card()

Method Summary

Card	iconize(IImage icon) Call this after you have specified the tab name.
Card	iconize(IImage icon, boolean iconOnlyWhenClosed) Call this after you have specified the tab name.
Card	iconize(String imageName) This iconizes the tab with the icon of the specified name and, tells the Card to display an icon only when it is deslected ONLY if it is running on a PDA sized screen.
Card	iconize(String imageName, Object maskOrColor) This iconizes the tab with the icon of the specified name and, tells the Card to display an icon only when it is deslected ONLY if it is running on a PDA sized screen.
Card	iconize(String imageName, Object maskOrColor, boolean iconOnlyWhenClosed) Call this after you have specified the tab name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, toString

Field Detail

longName

public String longName

This is the longName given to the item when it was added to the MultiPanel.

tabName

public String tabName

This is the short (tab) name given to the item when it was added to the MultiPanel.

panel

public CellPanel panel

This is the CellPanel which contains the item which was added to the MultiPanel. If the item added already was a CellPanel, then this MAY be the added item.

item

public Control item

This is the item that was added to the MultiPanel.

image

public IImage image

If this is not null then this will be displayed instead of the tab text. Use an IconAndText if you want to display both an Icon and text.

closedImage

public IImage closedImage

If this is not null then it will be displayed when the card is not selected.

tip

public Object tip

If this is not null then this will be the tool tip for the tab. Otherwise the tool tip will be the image (if there is one) or tab name.

flags

public int flags

DISABLED

public static final int DISABLED

A flag.

See Also:

Constant Field Values

HIDDEN

public static final int HIDDEN

A flag.

See Also:

Constant Field Values

Constructor Detail

Card

public Card()

Method Detail

iconize

public Card iconize(IImage icon)

Call this after you have specified the tab name. This will create an IconAndText image for the tab and, tells the Card to display an icon only when it is deslected ONLY if it is running on a PDA sized screen.

Parameters:

icon - The icon to use with this tab.

Returns:

itself.

iconize

public Card iconize(IImage icon,
                    boolean iconOnlyWhenClosed)

Call this after you have specified the tab name. This will create an IconAndText image for the tab AND set the closedImage to be the icon.

Parameters:

icon - The icon to use with this tab.

iconOnlyWhenClosed - Indicates that only the icon should be displayed when the tab is not selected.

Returns:

itself.

iconize

public Card iconize(String imageName,
                    Object maskOrColor,
                    boolean iconOnlyWhenClosed)

Call this after you have specified the tab name. This will create an IconAndText image for the tab AND set the closedImage to be the icon. The image is retrieved from the ImageCache.

Parameters:

imageName - The name of the icon.

maskOrColor - A mask image or color value.

iconOnlyWhenClosed - Indicates that only the icon should be displayed when the tab is not selected.

Returns:

itself.

iconize

public Card iconize(String imageName,
                    Object maskOrColor)

This iconizes the tab with the icon of the specified name and, tells the Card to display an icon only when it is deslected ONLY if it is running on a PDA sized screen.

Parameters:

imageName - The name of the icon.

maskOrColor - A mask image or color value.

Returns:

this Card.

iconize

public Card iconize(String imageName)

This iconizes the tab with the icon of the specified name and, tells the Card to display an icon only when it is deslected ONLY if it is running on a PDA sized screen.

Returns:

this Card.