wt.clients.beans.explorer
Class WTExplorerEvent

java.lang.Object
  java.util.EventObject
      wt.clients.beans.explorer.WTExplorerEvent

All Implemented Interfaces:

Serializable

public class WTExplorerEvent

extends EventObject

Windchill Technology Explorer Event Class (WTExplorerEvent)

This is a Event generated from the Explorer Browser.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static String	CLOSE The close event indicates that this WTObject has been deselected in the list view using a mouse double-click.
static String	COLLAPSE The collapse event indicates that a WTNode's children have been hidden in the WTExplorer tree view.
static String	COMMAND The command event indicates that a button on the toolbar has been depressed.
static String	DESELECT The deselect event indicates that this WTObject has been deselected in the list view.
static String	EXPAND The expand event indicates that a WTNode's children have been made visible in the WTExplorer tree view.
static String	EXPOSE The expose event indicates that a WTNode has been selected in the tree view and it's details shown in the WTExplorer list view.
static String	HIDE The hide event indicates that another WTNode has been selected in the tree view and that this WTNode's details are being hidden from the WTExplorer list view.
private String	myCommand
private Explorable	myDetail
private WTExplorer	myExplorer
private WTNode	myNode
private String	myType
static String	NULL NULL event is used to throw a null explorer event.
static String	OPEN The open event indicates that WTObject has been selected in the list view using a mouse double-click.
static String	SELECT The select event indicates that WTObject has been selected in the list view.

Fields inherited from class java.util.EventObject

source

Constructor Summary

WTExplorerEvent(WTExplorer aExplorer, String aType, Explorable aDetail)
Construct WTExplorerEvent of type list view.

WTExplorerEvent(WTExplorer aExplorer, String aType, String aCommand)
Construct WTExplorerEvent of type toolbar command.

WTExplorerEvent(WTExplorer aExplorer, String aType, WTNode aNode)
Construct WTExplorerEvent of type tree view.

Method Summary

String	getCommand() get the command string, such as "Cut", "Copy", "Paste".
Explorable	getDetail() get the Explorable for which their has been list type event.
WTExplorer	getExplorer() get the WTExplorer source of the event.
WTNode	getNode() get the WTNode for which their has been tree type event.
String	getType() get the event type.
void	setCommand(String aValue) set the command string to override the toolbar button command strings.
void	setDetail(Explorable aValue) set the Explorable which sourced the event.
void	setExplorer(WTExplorer aValue) set the source event to WTExplorer.
void	setNode(WTNode aValue) set the node which sourced the event.
void	setType(String aValue) set the event type.
String	toString() get the string represenation of the event.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final String NULL

NULL event is used to throw a null explorer event.

See Also:

Constant Field Values

COMMAND

public static final String COMMAND

The command event indicates that a button on the toolbar has been depressed. Use the getCommand() to retrieve the specific button command.

See Also:

getCommand(), Constant Field Values

EXPAND

public static final String EXPAND

The expand event indicates that a WTNode's children have been made visible in the WTExplorer tree view. The getNode() will indicate which WTNode has been activated.

See Also:

getNode(), Constant Field Values

COLLAPSE

public static final String COLLAPSE

The collapse event indicates that a WTNode's children have been hidden in the WTExplorer tree view. The getNode() will indicate which WTNode has been de-activated.

See Also:

getNode(), Constant Field Values

EXPOSE

public static final String EXPOSE

The expose event indicates that a WTNode has been selected in the tree view and it's details shown in the WTExplorer list view. The getNode() will indicate which WTNode has been exposed.

See Also:

getNode(), Constant Field Values

HIDE

public static final String HIDE

The hide event indicates that another WTNode has been selected in the tree view and that this WTNode's details are being hidden from the WTExplorer list view. The getNode() will indicate which WTNode has been hidden.

See Also:

getNode(), Constant Field Values

SELECT

public static final String SELECT

The select event indicates that WTObject has been selected in the list view. using a mouse single-click. The getDetail() will indicate which WTObject has been selected.

See Also:

getDetail(), Constant Field Values

DESELECT

public static final String DESELECT

The deselect event indicates that this WTObject has been deselected in the list view. The getDetail() will indicate which WTObject has been deselected.

See Also:

getDetail(), Constant Field Values

OPEN

public static final String OPEN

The open event indicates that WTObject has been selected in the list view using a mouse double-click. The getDetail() will indicate which WTObject has been selected.

See Also:

getDetail(), Constant Field Values

CLOSE

public static final String CLOSE

The close event indicates that this WTObject has been deselected in the list view using a mouse double-click. The getDetail() will indicate which WTObject has been selected.

See Also:

getDetail(), Constant Field Values

myExplorer

private WTExplorer myExplorer

myNode

private WTNode myNode

myDetail

private Explorable myDetail

myCommand

private String myCommand

myType

private String myType

Constructor Detail

WTExplorerEvent

public WTExplorerEvent(WTExplorer aExplorer,
                       String aType,
                       String aCommand)

Construct WTExplorerEvent of type toolbar command.

Parameters:

aExplorer - the event source.

aType - the event type: NULL or COMMAND.

aCommand - the command string of the button activated.

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

COMMAND

WTExplorerEvent

public WTExplorerEvent(WTExplorer aExplorer,
                       String aType,
                       WTNode aNode)

Construct WTExplorerEvent of type tree view.

Parameters:

aExplorer - the event source.

aType - the event type: EXPAND, COLLAPSE, EXPOSE, or HIDE.

aNode - the WTNode activated.

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

WTNode, EXPAND, COLLAPSE, EXPOSE, HIDE

WTExplorerEvent

public WTExplorerEvent(WTExplorer aExplorer,
                       String aType,
                       Explorable aDetail)

Construct WTExplorerEvent of type list view.

Parameters:

aExplorer - the event source.

aType - the event type: SELECT, DESELECT, OPEN, CLOSE.

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

Explorable, SELECT, DESELECT, OPEN, CLOSE

Method Detail

getExplorer

public WTExplorer getExplorer()

get the WTExplorer source of the event.

Returns:

WTExplorer

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

WTExplorer

setExplorer

public void setExplorer(WTExplorer aValue)

set the source event to WTExplorer.

Parameters:

aValue - the event source.

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

WTExplorer

getType

public String getType()

get the event type.

Returns:

String

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

COMMAND, EXPAND, COLLAPSE, EXPOSE, HIDE, SELECT, DESELECT, OPEN, CLOSE

setType

public void setType(String aValue)

set the event type.

Parameters:

aValue - the event type, see below.

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

COMMAND, EXPAND, COLLAPSE, EXPOSE, HIDE, SELECT, DESELECT, OPEN, CLOSE

getCommand

public String getCommand()

get the command string, such as "Cut", "Copy", "Paste".

Returns:

String

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

COMMAND

setCommand

public void setCommand(String aValue)

set the command string to override the toolbar button command strings.

Parameters:

aValue - the command string, such as "Cut"

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

COMMAND

getNode

public WTNode getNode()

get the WTNode for which their has been tree type event.

Returns:

WTNode

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

EXPAND, COLLAPSE, EXPOSE, HIDE

setNode

public void setNode(WTNode aValue)

set the node which sourced the event.

Parameters:

aValue - a WTNode.

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

EXPAND, COLLAPSE, EXPOSE, HIDE

getDetail

public Explorable getDetail()

get the Explorable for which their has been list type event.

Returns:

Explorable

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

SELECT, DESELECT, OPEN, CLOSE

setDetail

public void setDetail(Explorable aValue)

set the Explorable which sourced the event.

Parameters:

aValue - a Explorable.

Since:

Windchill Foundation 1.0: WTExplorer

See Also:

SELECT, DESELECT, OPEN, CLOSE

toString

public String toString()

get the string represenation of the event.

Returns:

String

Since:

Windchill Foundation 1.0: WTExplorer