oracle.alm.connector.data

Class ContextMenuItem

java.lang.Object

oracle.alm.connector.data.ContextMenuItem

public class ContextMenuItem
extends java.lang.Object

The ContextMenuItem defines a context menu item shown in the context menu of the query result table. ContextMenuItem can be defined declaratively in the tpc-config.xml in the connector as follows,

  <contextMenuDef>
      <menuItemDef label="${ctransBean.label}"
                      enabled="${ctransBean.enabled}"
                      listenerRef="ctransBean"/>
    </contextMenuDef>
 

Here ctransBean is a managed bean defined and implemented in the connector and registered in the tpc-config.xml. For more detail, please see the tpc conenctor development guideline.

Since:

11.1.1.2.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_ENABLED
static java.lang.String	ATTR_LABEL
static java.lang.String	ATTR_VISIBLE
static java.lang.String	NAME
static ContextMenuItem	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ContextMenuItem() Constructor
ContextMenuItem(java.lang.String name) Constuct the context menu item with name.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getActionListener()
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() The attribute map contains all attribtue setting on the context menu item object, currently, there are three published attributes: ContextMenuItem.ATTR_LABEL(of String type), ContextMenuItem.ATTR_VISIBLE (of boolean type), ContextMenuItem.ATTR_ENABLED (of boolean type)
java.lang.String	getName() Return the name of the context menu item.
void	release()
void	setActionListener(java.lang.Object listener) Set the listener object on the context menu item.
void	setName(java.lang.String name) Set the name of the context menu item.

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_LABEL

public static final java.lang.String ATTR_LABEL

See Also:

Constant Field Values

ATTR_ENABLED

public static final java.lang.String ATTR_ENABLED

See Also:

Constant Field Values

ATTR_VISIBLE

public static final java.lang.String ATTR_VISIBLE

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

SEPARATOR

public static final ContextMenuItem SEPARATOR

Constructor Detail

ContextMenuItem

public ContextMenuItem()

Constructor

ContextMenuItem

public ContextMenuItem(java.lang.String name)

Constuct the context menu item with name.

Parameters:

name - The name of the context menu item.

Method Detail

setName

public void setName(java.lang.String name)

Set the name of the context menu item.

Parameters:

name - the name of the context menu item.

getName

public java.lang.String getName()

Return the name of the context menu item.

Returns:

the name of the context menu item.

setActionListener

public void setActionListener(java.lang.Object listener)

Set the listener object on the context menu item. The current type of the listener object is of type java.awt.ActionListener.

Parameters:

listener - The corresponding listener object

getActionListener

public java.lang.Object getActionListener()

Returns:

the action listener object for current context menu item.

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()

The attribute map contains all attribtue setting on the context menu item object, currently, there are three published attributes: ContextMenuItem.ATTR_LABEL(of String type), ContextMenuItem.ATTR_VISIBLE (of boolean type), ContextMenuItem.ATTR_ENABLED (of boolean type)

Returns:

attribute name/value map set on current context menu item.

release

public void release()