nextapp.echo.extras.app
Class ContextMenu

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

All Implemented Interfaces:

Serializable, RenderIdSupport

public class ContextMenu
extends AbstractMenuComponent

A component that shows a menu when right-clicked, i.e. a context menu. This component supports at most one child which, when present, will be used as visible content. The component itself will not be visible.

Author:

n.beekman

See Also:

Serialized Form

Field Summary

static int	ACTIVATION_MODE_CLICK
static int	ACTIVATION_MODE_CONTEXT_CLICK
static String	PROPERTY_ACTIVATION_MODE
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_MENU_EXPAND_ICON
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

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

ContextMenu(Component applyTo)
Creates a new ContextMenu with an empty DefaultMenuModel as its model and a DefaultMenuStateModel to provide state information.

ContextMenu(Component applyTo, MenuModel model)
Creates a new ContextMenu displaying the specified MenuModel and using a DefaultMenuStateModel to provide state information.

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

Method Summary

int	getActivationMode() Returns the activation mode of the context menu.
Component	getApplyTo() Returns the component to apply the context menu to.
FillImage	getBackgroundImage() Returns the background image that will be displayed in pull-down menus.
Border	getBorder() Returns the border that will be displayed around pull-down menus.
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.
ImageReference	getMenuExpandIcon() Returns the icon used to expand 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.
boolean	isValidChild(Component child)
void	setActivationMode(int newValue) Sets the activation mode of the context menu.
void	setApplyTo(Component applyTo) Sets the component to apply the context menu to.
void	setBackgroundImage(FillImage newValue) Sets the background image that will be displayed in pull-down menus.
void	setBorder(Border newValue) Sets the border that will be displayed around pull-down menus.
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	setMenuExpandIcon(ImageReference newValue) Sets the icon used to expand 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.

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, isValidParent, 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

ACTIVATION_MODE_CLICK

public static final int ACTIVATION_MODE_CLICK

See Also:

Constant Field Values

ACTIVATION_MODE_CONTEXT_CLICK

public static final int ACTIVATION_MODE_CONTEXT_CLICK

See Also:

Constant Field Values

PROPERTY_ACTIVATION_MODE

public static final String PROPERTY_ACTIVATION_MODE

See Also:

Constant Field Values

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_MENU_EXPAND_ICON

public static final String PROPERTY_MENU_EXPAND_ICON

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

ContextMenu

public ContextMenu()

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

ContextMenu

public ContextMenu(Component applyTo)

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

Parameters:

applyTo - the component to apply the context menu to

ContextMenu

public ContextMenu(Component applyTo,
                   MenuModel model)

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

Parameters:

applyTo - the component to apply the context menu to

model - the model

ContextMenu

public ContextMenu(Component applyTo,
                   MenuModel model,
                   MenuStateModel stateModel)

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

Parameters:

applyTo - the component to apply the context menu to

model - the model

stateModel - the selection model

Method Detail

getActivationMode

public int getActivationMode()

Returns the activation mode of the context menu.

Returns:

the activation mode of the context menu, one of the following values:

• ACTIVATION_MODE_CONTEXT_CLICK
- context menu activates on context click (the default)
• ACTIVATION_MODE_CLICK
- context menu activates on primary click

getApplyTo

public Component getApplyTo()

Returns the component to apply the context menu to.

Returns:

the Component which the context menu is being applied to.

getBackgroundImage

public FillImage getBackgroundImage()

Returns the background image that will be displayed in pull-down menus.

Returns:

the default background image

getBorder

public Border getBorder()

Returns the border that will be displayed around pull-down menus.

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

getMenuExpandIcon

public ImageReference getMenuExpandIcon()

Returns the icon used to expand pull-down menus.

Returns:

the menu expand icon

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

setApplyTo

public void setApplyTo(Component applyTo)

Sets the component to apply the context menu to.

Parameters:

applyTo - the Component

setActivationMode

public void setActivationMode(int newValue)

Sets the activation mode of the context menu.

Parameters:

newValue - the new activation mode of the context menu, one of the following values:

• ACTIVATION_MODE_CONTEXT_CLICK
- context menu activates on context click (the default)
• ACTIVATION_MODE_CLICK
- context menu activates on primary click

setBackgroundImage

public void setBackgroundImage(FillImage newValue)

Sets the background image that will be displayed in pull-down menus.

Parameters:

newValue - the new background image

setBorder

public void setBorder(Border newValue)

Sets the border that will be displayed around pull-down menus.

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

setMenuExpandIcon

public void setMenuExpandIcon(ImageReference newValue)

Sets the icon used to expand pull-down menus.

Parameters:

newValue - the new menu expand icon

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

isValidChild

public boolean isValidChild(Component child)

Overrides:

isValidChild in class Component

See Also:

Component.isValidChild(Component)