JDeveloper SCM API

oracle.ide.scm
Interface SCMControlItem

All Known Implementing Classes:
SCMControlItemObject

public interface SCMControlItem

Interface to holders for operation control (for example menu, toolbar) item information, as requested by the framework from client operations.


Method Summary
 javax.swing.KeyStroke getAccelerator()
          Deprecated.  
 javax.swing.Icon getIcon()
          Gets the icon for the operation, as will be shown on the source control widgets within the IDE.
 char getMnemonic()
          Gets the keyboard mnemonic (shortcut key or accelerator key) for invoking this control item.
 java.lang.String getName()
          Gets the name of the operation to appear on the source control widgets.
 boolean isContextItem()
          Asks whether this control item definition is suitable for context-only controls in addition to general ones.
 

Method Detail

getName

public java.lang.String getName()
Gets the name of the operation to appear on the source control widgets. This command description should be as short as possible, and usually no more than four words. As a guide, avoid names with over 20 characters.
Returns:
the menu name for an operation.

getMnemonic

public char getMnemonic()
Gets the keyboard mnemonic (shortcut key or accelerator key) for invoking this control item.
Returns:
an int specifying the mnemonic key.

getAccelerator

public javax.swing.KeyStroke getAccelerator()
Deprecated.  

Gets the keyboard accelerator, which can be a combination of keys, for invoking this control item.
Returns:
a keystroke representing the accelerator shortcut, or null.

getIcon

public javax.swing.Icon getIcon()
Gets the icon for the operation, as will be shown on the source control widgets within the IDE. The icon size should be no greater that 16 x 16 pixels and perhaps use a metaphor to communicate the purpose of the operation to the user.
Returns:
the control icon for an operation, or null.

isContextItem

public boolean isContextItem()
Asks whether this control item definition is suitable for context-only controls in addition to general ones. For example, whether the item may also appear on a 'popup' or context menu.
Returns:
a value for the item's acceptance of context controls.

Copyright © 2002 Oracle Corporation