IActionableItem
| com.pnfsoftware.jeb.core.output.IActionableItem |
 Known Indirect Subclasses
|
Class Overview
An active item has an item identifier. That id can be interpreted by the IUnit that
produced the item. Retrieving which actions are supported by an item can be done by querying the
owner unit. Several items may have the same id, for example, when they refer to the same
abstraction. Those implementation details are the responsibility of the unit.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | HAS_RELATED_ITEMS | This flag indicates that this item id is tied to one or more other related ids. | |||||||||
| long | ITEM_TYPE_IDENTITY | Identifier for opaque IDs | |||||||||
| long | ITEM_TYPE_MASK | Mask used to extract the item type | |||||||||
| int | ROLE_MASTER | This flag is used in the case where multiple items have the same id. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract int |
getItemFlags()
Retrieve the item flags.
| ||||||||||
| abstract long |
getItemId()
Retrieve the item id.
| ||||||||||
Constants
public static final int HAS_RELATED_ITEMS
This flag indicates that this item id is tied to one or more other related ids. The way to
retrieve additional ids is implementation dependent. If the owner object is an
IAddressableUnit, a client may use getRelatedItems(long) to
retrieve additional items.
public static final long ITEM_TYPE_IDENTITY
Identifier for opaque IDs
public static final long ITEM_TYPE_MASK
Mask used to extract the item type
public static final int ROLE_MASTER
This flag is used in the case where multiple items have the same id. Only one of those items may have this flag set. It is used to provide a hint to the client as of which of these items should be considered the "master", or root item. The official RCP client, for instance, uses this flag to implement jumps (or go-tos) from one item to the associated master item.
Public Methods
public abstract int getItemFlags ()
Retrieve the item flags. Currently, allowed flags are:
- ROLE_MASTER
- HAS_RELATED_ITEMS
For code nodes, this is not to be confused with the generic flags.
Returns
- the items flags
public abstract long getItemId ()
Retrieve the item id.
Returns
- the item id, 0 if none