org.openbp.guiclient.model.item.itemtree
Class ItemTreeEvent

java.lang.Object
  org.openbp.guiclient.model.item.itemtree.ItemTreeEvent

public class ItemTreeEvent
extends java.lang.Object

Editing event. Fired whenever an event during editing of a property editor occurs that may require interaction with the component that hosts the editor.

Author:

Heiko Erhardt

Field Summary

boolean	cancel Cancel flag
int	eventType Event code (see the constants of this class)
static int	IS_SELECTABLE An object that has been selected by the user shall be added to the list of selected items.
static int	IS_SUPPORTED An object shall be added to the tree.
ItemTree	itemTree Item tree that caused the event
java.awt.event.KeyEvent	keyEvent Key event associated with the event.
java.awt.event.MouseEvent	mouseEvent Mouse event associated with the event.
ModelObject	object Object that is associated with this event, if any
static int	OPEN A tree node was doubleclicked or ENTER was pressed
static int	POPUP A tree node was right-clicked
static int	SELECTION_CHANGED The current selection has changed
ItemTree.ItemTreeNode	treeNode Tree node that is associated with this event, if any

Constructor Summary

ItemTreeEvent(ItemTree itemTree, int eventType)
Default constructor.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SELECTION_CHANGED

public static final int SELECTION_CHANGED

The current selection has changed

See Also:

Constant Field Values

OPEN

public static final int OPEN

A tree node was doubleclicked or ENTER was pressed

See Also:

Constant Field Values

POPUP

public static final int POPUP

A tree node was right-clicked

See Also:

Constant Field Values

IS_SUPPORTED

public static final int IS_SUPPORTED

An object shall be added to the tree. The event handler may check if this particular object should appear in the tree. Set the cancel flag to prevent adding the object.

See Also:

Constant Field Values

IS_SELECTABLE

public static final int IS_SELECTABLE

An object that has been selected by the user shall be added to the list of selected items. The event handler may check if this particular object should appear in the list. Set the cancel flag to prevent adding the object to the list.

See Also:

Constant Field Values

itemTree

public ItemTree itemTree

Item tree that caused the event

eventType

public int eventType

Event code (see the constants of this class)

treeNode

public ItemTree.ItemTreeNode treeNode

Tree node that is associated with this event, if any

object

public ModelObject object

Object that is associated with this event, if any

mouseEvent

public java.awt.event.MouseEvent mouseEvent

Mouse event associated with the event. If the event was not caused by a mouse interaction, this member will be null.

keyEvent

public java.awt.event.KeyEvent keyEvent

Key event associated with the event. If a key code is not applicable or the event was caused by e. g. a mouse interaction, this member will be null.

cancel

public boolean cancel

Cancel flag

Constructor Detail

ItemTreeEvent

public ItemTreeEvent(ItemTree itemTree,
                     int eventType)

Default constructor.

Parameters:

itemTree - Property editor

eventType - Event code (see the constants of this class)