Package org.opennms.features.topology.app.internal.menu

Class OperationMenuItem

java.lang.Object

org.opennms.features.topology.app.internal.menu.OperationMenuItem

All Implemented Interfaces:

java.lang.Comparable<MenuItem>, MenuItem

public class OperationMenuItem
extends java.lang.Object
implements MenuItem

Constructor Summary

Constructors

Constructor	Description
OperationMenuItem(OperationServiceWrapper operationServiceWrapper)

Method Summary

Modifier and Type	Method	Description
void	addChildren(MenuItem menuItem)	Adds a children to the current MenuItem
java.util.List<MenuItem>	getChildren()	The MenuItems can be cascaded (allowing a tree).
MenuCommand	getCommand()	Returns the command to execute if the MenuItem is selected.
java.lang.String	getLabel()	The Label of the menu item.
int	getOrder()
boolean	isCheckable()	Defines if the current MenuItem is a checkable item.
boolean	isChecked(java.util.List<VertexRef> targets, OperationContext operationContext)	Defines if the current MenuItem is checked.
boolean	isEnabled(java.util.List<VertexRef> targets, OperationContext operationContext)	Defines if the current MenuItem is enabled.
boolean	isVisible(java.util.List<VertexRef> targets, OperationContext operationContext)	Defines if the current MenuItem is visible.
void	setOrder(int order)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opennms.features.topology.app.internal.menu.MenuItem

compareTo

Constructor Detail

OperationMenuItem

public OperationMenuItem(OperationServiceWrapper operationServiceWrapper)

Method Detail

getLabel

public java.lang.String getLabel()

Description copied from interface: MenuItem

The Label of the menu item.

Specified by:

getLabel in interface MenuItem

Returns:

The label of the menu item.

isVisible

public boolean isVisible(java.util.List<VertexRef> targets,
                         OperationContext operationContext)

Description copied from interface: MenuItem

Defines if the current MenuItem is visible.

Specified by:

isVisible in interface MenuItem

Parameters:

targets - The current targets (e.g. the selection)

operationContext - The current OperationContext.

Returns:

True if visible, false otherwise.

isEnabled

public boolean isEnabled(java.util.List<VertexRef> targets,
                         OperationContext operationContext)

Description copied from interface: MenuItem

Defines if the current MenuItem is enabled. If MenuItem.isVisible(List, OperationContext) returns false, this is never called.

Specified by:

isEnabled in interface MenuItem

Parameters:

targets - The current targets (e.g. the selection)

operationContext - The current OperationContext.

Returns:

True if enabled, false otherwise.

getChildren

public java.util.List<MenuItem> getChildren()

Description copied from interface: MenuItem

The MenuItems can be cascaded (allowing a tree).

Specified by:

getChildren in interface MenuItem

Returns:

the children, or an empty list if no children exits. Must not be null.

addChildren

public void addChildren(MenuItem menuItem)

Description copied from interface: MenuItem

Adds a children to the current MenuItem

Specified by:

addChildren in interface MenuItem

Parameters:

menuItem - the child to add.

getCommand

public MenuCommand getCommand()

Description copied from interface: MenuItem

Returns the command to execute if the MenuItem is selected. Please Note, that it MUST return null if MenuItem.getChildren() is NOT empty.

Specified by:

getCommand in interface MenuItem

Returns:

the command to execute if the MenuItem is selected, or null if MenuItem.getChildren() is NOT empty.

setOrder

public void setOrder(int order)

Specified by:

setOrder in interface MenuItem

getOrder

public int getOrder()

Specified by:

getOrder in interface MenuItem

isCheckable

public boolean isCheckable()

Description copied from interface: MenuItem

Defines if the current MenuItem is a checkable item.

Specified by:

isCheckable in interface MenuItem

Returns:

true if checkable, false otherwise

See Also:

MenuBar.MenuItem.isCheckable()

isChecked

public boolean isChecked(java.util.List<VertexRef> targets,
                         OperationContext operationContext)

Description copied from interface: MenuItem

Defines if the current MenuItem is checked. If MenuItem.isCheckable() returns false, this is never called.

Specified by:

isChecked in interface MenuItem

Parameters:

targets - The current targets (e.g. the selection)

operationContext - The current OperationContext.

Returns:

True if it is checked, false otherwise.