fr.cnes.genius.main

Class GEvent

java.lang.Object

fr.cnes.genius.main.GEvent

public class GEvent
extends Object

Class representing the Genius events. The sources of the event is the hierarchical list of ancestors of the widget launching the event. The list of sources is build in the GComponent::processEvent method. The class keeps track of the level of processing so the getSource method returns the component in the scope of the call with read to the ancestors hierarchy.

Author:

jjct

Constructor Summary

Constructors

Constructor and Description
GEvent() Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(GComponent source) Adds a GComponent to the list of sources.
boolean	contains(GComponent... componentList) Checks if any of the components in componentList is already in the source list.
GComponent	getFinalSource() Gets the component origin of the event.
GComponent	getLocalSource() Gets the source corresponding to the immediate child of the caller component..
String	getSourceListAsString() Returns the source list as an string.
boolean	isEntryType() Getter for the event type.
boolean	isOrigin(GComponent... componentList) Deprecated.
boolean	isSource(GComponent... componentList) Deprecated.
void	setEntryType(boolean inputType) Setter for the event type.
void	setRank(int rank) Sets the rank of the source being currently treated with regard to the sourceList.

Methods inherited from class java.lang.Object

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

Constructor Detail

GEvent

public GEvent()

Constructor. The source list is created empty.

Method Detail

add

public void add(GComponent source)

Adds a GComponent to the list of sources.

Parameters:

source - component to add to the list of sources.

setRank

public void setRank(int rank)

Sets the rank of the source being currently treated with regard to the sourceList.

Parameters:

rank - to set.

getLocalSource

public GComponent getLocalSource()

Gets the source corresponding to the immediate child of the caller component..

Returns:

Source GComponent source corresponding to the immediate child of the caller component.

isSource

public boolean isSource(GComponent... componentList)

Deprecated.

Checks if any of the components in componentList in the source of the event within the immediate child of the component where the invocation is done.

Parameters:

componentList - list of components to check if any of them is source of the event within the immediate child of the component where the invocation is done.

Returns:

true if any of the components in componentList in the source of the event within the immediate child of the component where the invocation is done, false otherwise.

getFinalSource

public GComponent getFinalSource()

Gets the component origin of the event.

Returns:

GComponent origin of the event.

isOrigin

public boolean isOrigin(GComponent... componentList)

Deprecated.

Checks if any of the components in componentList in the origin of the event.

Parameters:

componentList - list of components to check if any of them is the origin of the event.

Returns:

true if any of the components in componentList in the origin of the event, false otherwise.

contains

public boolean contains(GComponent... componentList)

Checks if any of the components in componentList is already in the source list.

Parameters:

componentList - list of components to check if it is already in the source list.

Returns:

true if any of the components is already in the source list, false otherwise.

getSourceListAsString

public String getSourceListAsString()

Returns the source list as an string.

Returns:

the source list as an string.

isEntryType

public boolean isEntryType()

Getter for the event type.

Returns:

true if the event is an entry (f.i.: changing a numeric value of a GEntryReal), false otherwise (f.i.: changing just the unit in a GEntryReal)

setEntryType

public void setEntryType(boolean inputType)

Setter for the event type.

Parameters:

inputType - true if the event is an entry (f.i.: changing a numeric value of a GEntryReal), false otherwise (f.i.: changing the unit in a GEntryReal)