nextapp.echo.extras.app
Class MenuBarPane

java.lang.Object
  nextapp.echo.app.Component
      nextapp.echo.extras.app.menu.AbstractMenuComponent
          nextapp.echo.extras.app.MenuBarPane

All Implemented Interfaces:

Serializable, Pane, RenderIdSupport

public class MenuBarPane
extends AbstractMenuComponent
implements Pane

MenuBarPane component: a menu bar containing "pull down" menus. This component is a Pane, and is generally best used as the first child of a SplitPane component whose autoPositioned property is set to true. May not contain child components.

See Also:

Serialized Form

Field Summary

static String	PROPERTY_BACKGROUND_IMAGE
static String	PROPERTY_BORDER
static String	PROPERTY_DISABLED_BACKGROUND
static String	PROPERTY_DISABLED_BACKGROUND_IMAGE
static String	PROPERTY_DISABLED_FOREGROUND
static String	PROPERTY_INSETS
static String	PROPERTY_MENU_BACKGROUND
static String	PROPERTY_MENU_BACKGROUND_IMAGE
static String	PROPERTY_MENU_BORDER
static String	PROPERTY_MENU_EXPAND_ICON
static String	PROPERTY_MENU_FOREGROUND
static String	PROPERTY_MENU_OPACITY
static String	PROPERTY_SELECTION_BACKGROUND
static String	PROPERTY_SELECTION_BACKGROUND_IMAGE
static String	PROPERTY_SELECTION_FOREGROUND

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

ACTION_LISTENERS_CHANGED_PROPERTY, DEFAULT_ANIMATION_TIME, INPUT_ACTION, MODEL_CHANGED_PROPERTY, PROPERTY_ANIMATION_TIME, STATE_MODEL_CHANGED_PROPERTY

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

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

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

MenuBarPane(MenuModel model, MenuStateModel stateModel)
Creates a new MenuBarPane 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 MenuBarPane.
Border	getBorder() Returns the border that will be displayed around the MenuBarPane.
Color	getDisabledBackground() Returns the background color used to render disabled menu items.
FillImage	getDisabledBackgroundImage() Returns the background image used to render disabled menu items.
Color	getDisabledForeground() Returns the foreground color used to render disabled menu items.
Insets	getInsets() Returns the inset margin around the menu bar.
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.
ImageReference	getMenuExpandIcon() Returns the icon used to expand pull-down menus.
Color	getMenuForeground() Returns the foreground color that will be displayed in pull-down menus.
int	getMenuOpacity() Returns the opacity setting (percent) that will be used for the background color/image displayed in pulldown 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.
boolean	isValidParent(Component c)
void	setBackgroundImage(FillImage newValue) Sets the background image that will be displayed in the MenuBarPane.
void	setBorder(Border newValue) Sets the border that will be displayed around the MenuBarPane.
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	setDisabledForeground(Color newValue) Sets the foreground color used to render disabled menu items.
void	setInsets(Insets newValue) Returns the inset margin around the menu bar.
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	setMenuExpandIcon(ImageReference newValue) Sets the icon used to expand pull-down menus.
void	setMenuForeground(Color newValue) Sets the foreground color that will be displayed in pull-down menus.
void	setMenuOpacity(int newValue) Sets the opacity (percent) that will be used for the background color/image displayed in pulldown 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.

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

addActionListener, doAction, fireActionPerformed, getAnimationTime, getModel, getStateModel, hasActionListeners, processInput, removeActionListener, setAnimationTime, setModel, setStateModel

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isVisible, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

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 String PROPERTY_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_BORDER

public static final String PROPERTY_BORDER

See Also:

Constant Field Values

PROPERTY_DISABLED_BACKGROUND

public static final String PROPERTY_DISABLED_BACKGROUND

See Also:

Constant Field Values

PROPERTY_DISABLED_BACKGROUND_IMAGE

public static final String PROPERTY_DISABLED_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_DISABLED_FOREGROUND

public static final String PROPERTY_DISABLED_FOREGROUND

See Also:

Constant Field Values

PROPERTY_INSETS

public static final String PROPERTY_INSETS

See Also:

Constant Field Values

PROPERTY_MENU_BACKGROUND

public static final String PROPERTY_MENU_BACKGROUND

See Also:

Constant Field Values

PROPERTY_MENU_BACKGROUND_IMAGE

public static final String PROPERTY_MENU_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_MENU_BORDER

public static final String PROPERTY_MENU_BORDER

See Also:

Constant Field Values

PROPERTY_MENU_EXPAND_ICON

public static final String PROPERTY_MENU_EXPAND_ICON

See Also:

Constant Field Values

PROPERTY_MENU_FOREGROUND

public static final String PROPERTY_MENU_FOREGROUND

See Also:

Constant Field Values

PROPERTY_MENU_OPACITY

public static final String PROPERTY_MENU_OPACITY

See Also:

Constant Field Values

PROPERTY_SELECTION_BACKGROUND

public static final String PROPERTY_SELECTION_BACKGROUND

See Also:

Constant Field Values

PROPERTY_SELECTION_BACKGROUND_IMAGE

public static final String PROPERTY_SELECTION_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_SELECTION_FOREGROUND

public static final String PROPERTY_SELECTION_FOREGROUND

See Also:

Constant Field Values

Constructor Detail

MenuBarPane

public MenuBarPane()

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

MenuBarPane

public MenuBarPane(MenuModel model)

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

Parameters:

model - the model

MenuBarPane

public MenuBarPane(MenuModel model,
                   MenuStateModel stateModel)

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

Parameters:

model - the model

stateModel - the selection model

Method Detail

getBackgroundImage

public FillImage getBackgroundImage()

Returns the background image that will be displayed in the MenuBarPane. 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 MenuBarPane. 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

getDisabledForeground

public Color getDisabledForeground()

Returns the foreground color used to render disabled menu items.

Returns:

the disabled foreground

getInsets

public Insets getInsets()

Returns the inset margin around the menu bar. This property is ignored unless the container is sizing itself to the menu bar.

Returns:

the inset margin around the menu bar

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

getMenuExpandIcon

public ImageReference getMenuExpandIcon()

Returns the icon used to expand pull-down menus.

Returns:

the menu expand icon

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

getMenuOpacity

public int getMenuOpacity()

Returns the opacity setting (percent) that will be used for the background color/image displayed in pulldown menus. Valid values are between 1 and 100. Some clients may not support this setting and will always render menus with 100% opacity.

Returns:

the opacity setting

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

isValidParent

public boolean isValidParent(Component c)

Overrides:

isValidParent in class Component

See Also:

Component.isValidParent(nextapp.echo.app.Component)

setBackgroundImage

public void setBackgroundImage(FillImage newValue)

Sets the background image that will be displayed in the MenuBarPane. 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 MenuBarPane. 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

setDisabledForeground

public void setDisabledForeground(Color newValue)

Sets the foreground color used to render disabled menu items.

Parameters:

newValue - the new disabled foreground

setInsets

public void setInsets(Insets newValue)

Returns the inset margin around the menu bar. This property is ignored unless the container is sizing itself to the menu bar.

Parameters:

newValue - the inset margin around the menu bar

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

setMenuExpandIcon

public void setMenuExpandIcon(ImageReference newValue)

Sets the icon used to expand pull-down menus.

Parameters:

newValue - the new menu expand icon

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

setMenuOpacity

public void setMenuOpacity(int newValue)

Sets the opacity (percent) that will be used for the background color/image displayed in pulldown menus. Valid values are between 1 and 100. Some clients may not support this setting and will always render menus with 100% opacity.

Parameters:

newValue - the new opacity setting

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