nextapp.echo2.extras.app
Class DropDownMenu

java.lang.Object
  Component
      nextapp.echo2.extras.app.menu.AbstractMenuComponent
          nextapp.echo2.extras.app.DropDownMenu

public class DropDownMenu
extends AbstractMenuComponent

EXPERIMENTAL: Under Development, API may change.

Field Summary

static java.lang.String	PROPERTY_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_BORDER
static java.lang.String	PROPERTY_DISABLED_BACKGROUND
static java.lang.String	PROPERTY_DISABLED_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_DISABLED_EXPAND_ICON
static java.lang.String	PROPERTY_DISABLED_FOREGROUND
static java.lang.String	PROPERTY_EXPAND_ICON
static java.lang.String	PROPERTY_HEIGHT
static java.lang.String	PROPERTY_MENU_BACKGROUND
static java.lang.String	PROPERTY_MENU_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_MENU_BORDER
static java.lang.String	PROPERTY_MENU_FOREGROUND
static java.lang.String	PROPERTY_SELECTION_BACKGROUND
static java.lang.String	PROPERTY_SELECTION_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_SELECTION_FOREGROUND
static java.lang.String	PROPERTY_WIDTH
static java.lang.String	SELECTION_CHANGED_PROPERTY
static java.lang.String	SELECTION_MODEL_CHANGED_PROPERTY

Fields inherited from class nextapp.echo2.extras.app.menu.AbstractMenuComponent

INPUT_SELECT, MODEL_CHANGED_PROPERTY, STATE_MODEL_CHANGED_PROPERTY

Constructor Summary

DropDownMenu()
Creates a new DropDownMenu with an empty DefaultMenuModel as its model and a.

DropDownMenu(MenuModel model)
Creates a new DropDownMenu displaying the specified MenuModel and using a DefaultMenuStateModel to provide state information.

DropDownMenu(MenuModel model, MenuSelectionModel selectionModel)

DropDownMenu(MenuModel model, MenuStateModel stateModel)
Creates a new DropDownMenu displaying the specified MenuModel and using the specified MenuStateModel to provide state information.

Method Summary

FillImage	getBackgroundImage() Returns the background image that will be displayed in the DropDownMenu.
Border	getBorder() Returns the border that will be displayed around the DropDownMenu.
Color	getDisabledBackground() Returns the background color used to render disabled menu items.
FillImage	getDisabledBackgroundImage() Returns the background image used to render disabled menu items.
ImageReference	getDisabledExpandIcon() Returns the disabled expand icon.
Color	getDisabledForeground() Returns the foreground color used to render disabled menu items.
ImageReference	getExpandIcon() Returns the icon used to expand the drop down menu.
Extent	getHeight() Returns the height of the drop down menu.
Color	getMenuBackground() Returns the background color that will be displayed in pull-down menus.
FillImage	getMenuBackgroundImage() Returns the background image that will be displayed in pull-down menus.
Border	getMenuBorder() Returns the border that will be displayed around pull-down menus.
Color	getMenuForeground() Returns the foreground color that will be displayed in pull-down menus.
Color	getSelectionBackground() Returns the background color used to highlight the currently selected menu item.
FillImage	getSelectionBackgroundImage() Returns the background image used to highlight the currently selected menu item.
Color	getSelectionForeground() Returns the foreground color used to highlight the currently selected menu item.
MenuSelectionModel	getSelectionModel()
Extent	getWidth() Returns the width of the drop down menu.
void	setBackgroundImage(FillImage newValue) Sets the background image that will be displayed in the DropDownMenu.
void	setBorder(Border newValue) Sets the border that will be displayed around the DropDownMenu.
void	setDisabledBackground(Color newValue) Sets the background color used to render disabled menu items.
void	setDisabledBackgroundImage(FillImage newValue) Sets the background image used to render disabled menu items.
void	setDisabledExpandIcon(ImageReference newValue) Sets the disabled expand icon.
void	setDisabledForeground(Color newValue) Sets the foreground color used to render disabled menu items.
void	setExpandIcon(ImageReference newValue) Sets the icon used to expand the drop down menu.
void	setHeight(Extent newValue) Sets the height of the drop down menu.
void	setMenuBackground(Color newValue) Sets the background color that will be displayed in pull-down menus.
void	setMenuBackgroundImage(FillImage newValue) Sets the background image that will be displayed in pull-down menus.
void	setMenuBorder(Border newValue) Sets the border that will be displayed around pull-down menus.
void	setMenuForeground(Color newValue) Sets the foreground color that will be displayed in pull-down menus.
void	setSelectionBackground(Color newValue) Sets the background color used to highlight the currently selected menu item.
void	setSelectionBackgroundImage(FillImage newValue) Sets the background image used to highlight the currently selected menu item.
void	setSelectionForeground(Color newValue) Sets the foreground color used to highlight the currently selected menu item.
void	setSelectionModel(MenuSelectionModel newValue) Sets the selection model to use.
void	setWidth(Extent newValue) Sets the width of the drop down menu.

Methods inherited from class nextapp.echo2.extras.app.menu.AbstractMenuComponent

addActionListener, doAction, getModel, getStateModel, processInput, removeActionListener, setModel, setStateModel

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_BORDER

public static final java.lang.String PROPERTY_BORDER

See Also:

Constant Field Values

PROPERTY_DISABLED_BACKGROUND

public static final java.lang.String PROPERTY_DISABLED_BACKGROUND

See Also:

Constant Field Values

PROPERTY_DISABLED_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_DISABLED_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_DISABLED_FOREGROUND

public static final java.lang.String PROPERTY_DISABLED_FOREGROUND

See Also:

Constant Field Values

PROPERTY_DISABLED_EXPAND_ICON

public static final java.lang.String PROPERTY_DISABLED_EXPAND_ICON

See Also:

Constant Field Values

PROPERTY_EXPAND_ICON

public static final java.lang.String PROPERTY_EXPAND_ICON

See Also:

Constant Field Values

PROPERTY_HEIGHT

public static final java.lang.String PROPERTY_HEIGHT

See Also:

Constant Field Values

PROPERTY_MENU_BACKGROUND

public static final java.lang.String PROPERTY_MENU_BACKGROUND

See Also:

Constant Field Values

PROPERTY_MENU_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_MENU_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_MENU_BORDER

public static final java.lang.String PROPERTY_MENU_BORDER

See Also:

Constant Field Values

PROPERTY_MENU_FOREGROUND

public static final java.lang.String PROPERTY_MENU_FOREGROUND

See Also:

Constant Field Values

PROPERTY_SELECTION_BACKGROUND

public static final java.lang.String PROPERTY_SELECTION_BACKGROUND

See Also:

Constant Field Values

PROPERTY_SELECTION_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_SELECTION_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_SELECTION_FOREGROUND

public static final java.lang.String PROPERTY_SELECTION_FOREGROUND

See Also:

Constant Field Values

PROPERTY_WIDTH

public static final java.lang.String PROPERTY_WIDTH

See Also:

Constant Field Values

SELECTION_CHANGED_PROPERTY

public static final java.lang.String SELECTION_CHANGED_PROPERTY

See Also:

Constant Field Values

SELECTION_MODEL_CHANGED_PROPERTY

public static final java.lang.String SELECTION_MODEL_CHANGED_PROPERTY

See Also:

Constant Field Values

Constructor Detail

DropDownMenu

public DropDownMenu()

Creates a new DropDownMenu with an empty DefaultMenuModel as its model and a. DefaultMenuStateModel to provide state information.

DropDownMenu

public DropDownMenu(MenuModel model)

Creates a new DropDownMenu displaying the specified MenuModel and using a DefaultMenuStateModel to provide state information.

Parameters:

model - the model

DropDownMenu

public DropDownMenu(MenuModel model,
                    MenuStateModel stateModel)

Creates a new DropDownMenu displaying the specified MenuModel and using the specified MenuStateModel to provide state information.

Parameters:

model - the model

stateModel - the selection model

DropDownMenu

public DropDownMenu(MenuModel model,
                    MenuSelectionModel selectionModel)

Method Detail

getSelectionModel

public MenuSelectionModel getSelectionModel()

getBackgroundImage

public FillImage getBackgroundImage()

Returns the background image that will be displayed in the DropDownMenu. This background image will also be used around pull-down menus in the event that a menu background image is not specified.

Returns:

the default background image

getBorder

public Border getBorder()

Returns the border that will be displayed around the DropDownMenu. This border will also be used around pull-down menus in the event that a menu border is not specified.

Returns:

the default border

getDisabledBackground

public Color getDisabledBackground()

Returns the background color used to render disabled menu items.

Returns:

the disabled background

getDisabledBackgroundImage

public FillImage getDisabledBackgroundImage()

Returns the background image used to render disabled menu items.

Returns:

the disabled background image

getDisabledExpandIcon

public ImageReference getDisabledExpandIcon()

Returns the disabled expand icon.

Returns:

the disabled expand icon

getDisabledForeground

public Color getDisabledForeground()

Returns the foreground color used to render disabled menu items.

Returns:

the disabled foreground

getExpandIcon

public ImageReference getExpandIcon()

Returns the icon used to expand the drop down menu.

Returns:

the expand icon

getHeight

public Extent getHeight()

Returns the height of the drop down menu.

Returns:

the height

getMenuBackground

public Color getMenuBackground()

Returns the background color that will be displayed in pull-down menus. Use this property only if a color different from the one used for the menu bar is desired for pull-down menus (otherwise use only the "background" property").

Returns:

the menu background

getMenuBackgroundImage

public FillImage getMenuBackgroundImage()

Returns the background image that will be displayed in pull-down menus. Use this property only if an image different from the one used for the menu bar is desired for pull-down menus (otherwise use only the "backgroundImage" property").

Returns:

the menu background image

getMenuBorder

public Border getMenuBorder()

Returns the border that will be displayed around pull-down menus. Use this property only if a border different from the one used for the menu bar is desired for pull-down menus (otherwise use only the "border" property").

Returns:

the menu border

getMenuForeground

public Color getMenuForeground()

Returns the foreground color that will be displayed in pull-down menus. Use this property only if a color different from the one used for the menu bar is desired for pull-down menus (otherwise use only the "foreground" property").

Returns:

the menu foreground

getSelectionBackground

public Color getSelectionBackground()

Returns the background color used to highlight the currently selected menu item.

Returns:

the selection background

getSelectionBackgroundImage

public FillImage getSelectionBackgroundImage()

Returns the background image used to highlight the currently selected menu item.

Returns:

the selection background image

getSelectionForeground

public Color getSelectionForeground()

Returns the foreground color used to highlight the currently selected menu item.

Returns:

the selection foreground

getWidth

public Extent getWidth()

Returns the width of the drop down menu.

Returns:

the width

setBackgroundImage

public void setBackgroundImage(FillImage newValue)

Sets the background image that will be displayed in the DropDownMenu. This background image will also be used around pull-down menus in the event that a menu background image is not specified.

Parameters:

newValue - the new default background image

setBorder

public void setBorder(Border newValue)

Sets the border that will be displayed around the DropDownMenu. This border will also be used around pull-down menus in the event that a menu border is not specified.

Parameters:

newValue - the new default border

setDisabledBackground

public void setDisabledBackground(Color newValue)

Sets the background color used to render disabled menu items.

Parameters:

newValue - the new disabled background

setDisabledBackgroundImage

public void setDisabledBackgroundImage(FillImage newValue)

Sets the background image used to render disabled menu items.

Parameters:

newValue - the new disabled background image

setDisabledExpandIcon

public void setDisabledExpandIcon(ImageReference newValue)

Sets the disabled expand icon.

Parameters:

newValue - the new disabled expand icon

setDisabledForeground

public void setDisabledForeground(Color newValue)

Sets the foreground color used to render disabled menu items.

Parameters:

newValue - the new disabled foreground

setExpandIcon

public void setExpandIcon(ImageReference newValue)

Sets the icon used to expand the drop down menu.

Parameters:

newValue - the new expand icon

setHeight

public void setHeight(Extent newValue)

Sets the height of the drop down menu.

Parameters:

newValue - the new height

setMenuBackground

public void setMenuBackground(Color newValue)

Sets the background color that will be displayed in pull-down menus. Use this property only if a color different from the one used for the menu bar is desired for pull-down menus (otherwise use only the "background" property").

Parameters:

newValue - the new menu background

setMenuBackgroundImage

public void setMenuBackgroundImage(FillImage newValue)

Sets the background image that will be displayed in pull-down menus. Use this property only if an image different from the one used for the menu bar is desired for pull-down menus (otherwise use only the "backgroundImage" property").

Parameters:

newValue - the new menu background image

setMenuBorder

public void setMenuBorder(Border newValue)

Sets the border that will be displayed around pull-down menus. Use this property only if a border different from the one used for the menu bar is desired for pull-down menus (otherwise use only the "border" property").

Parameters:

newValue - the new menu border

setMenuForeground

public void setMenuForeground(Color newValue)

Sets the foreground color that will be displayed in pull-down menus. Use this property only if a color different from the one used for the menu bar is desired for pull-down menus (otherwise use only the "foreground" property").

Parameters:

newValue - the new menu foreground

setSelectionBackground

public void setSelectionBackground(Color newValue)

Sets the background color used to highlight the currently selected menu item.

Parameters:

newValue - the new selection background

setSelectionBackgroundImage

public void setSelectionBackgroundImage(FillImage newValue)

Sets the background image used to highlight the currently selected menu item.

Parameters:

newValue - the new selection background image

setSelectionForeground

public void setSelectionForeground(Color newValue)

Sets the foreground color used to highlight the currently selected menu item.

Parameters:

newValue - the new selection foreground

setSelectionModel

public void setSelectionModel(MenuSelectionModel newValue)

Sets the selection model to use.

Parameters:

newValue - the new selection model

setWidth

public void setWidth(Extent newValue)

Sets the width of the drop down menu.

Parameters:

newValue - the new width