Class MultiColumnListView.MultiColumnListViewEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

com.dlsc.gemsfx.MultiColumnListView.MultiColumnListViewEvent

All Implemented Interfaces:

Serializable, Cloneable

Enclosing class:

MultiColumnListView<T>

public static class MultiColumnListView.MultiColumnListViewEvent
extends javafx.event.Event

Represents an event specific to the MultiColumnListView component. This event is triggered during user interactions such as drag and drop activities or changes in the state of the list view.

The class provides a set of predefined event types to handle common scenarios, such as item movement, drag operations, and drop validation.

Event Types: - ANY: Represents a generic MultiColumnListViewEvent. - ITEM_MOVED: Indicates that an item has been moved to a new location. - DRAG_NOT_POSSIBLE: Signifies a rejected drag operation, see MultiColumnListView.dragPossibleCallbackProperty(). - DROP_NOT_POSSIBLE: Signifies a failed drop operation due to validation failures. - DRAG_OVER: Fired when a drag operation hovers over the target area. - DRAG_STARTED: Specifies the start of a drag operation. - DRAG_ENDED: Fired when a drag operation has completed.

This event also provides access to the dragged item and the associated column where the interaction occurs.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent>	ANY	The common super type for all multi-column list view events.
static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent>	DRAG_ENDED	Event type representing the end of a drag operation.
static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent>	DRAG_NOT_POSSIBLE	Event type fired when the drag validation callback rejects a drag.
static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent>	DRAG_OVER	Event type fired while a valid dragged item is over a drop target.
static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent>	DRAG_STARTED	Event type fired when a drag operation starts.
static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent>	DROP_NOT_POSSIBLE	Event type fired when the drop validation callback rejects a drop target.
static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent>	ITEM_MOVED	Event type fired after an item was moved to a new column or index.

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class EventObject

source

Constructor Summary

Constructors

Constructor	Description
MultiColumnListViewEvent(javafx.event.EventType<? extends javafx.event.Event> eventType, Object draggedItem, MultiColumnListView.ListViewColumn column, int index)	Creates a new multi-column list view event.

Method Summary

Modifier and Type	Method	Description
MultiColumnListView.ListViewColumn	getColumn()	Returns the column involved in the event.
Object	getDraggedItem()	Returns the item associated with the event.
int	getIndex()	Returns the item index involved in the event.
String	toString()

Methods inherited from class javafx.event.Event

clone, consume, copyFor, fireEvent, getEventType, getTarget, isConsumed

Methods inherited from class EventObject

getSource

Methods inherited from class Object

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

Field Details

ANY

public static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent> ANY

The common super type for all multi-column list view events.

ITEM_MOVED

public static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent> ITEM_MOVED

Event type fired after an item was moved to a new column or index.

DRAG_NOT_POSSIBLE

public static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent> DRAG_NOT_POSSIBLE

Event type fired when the drag validation callback rejects a drag.

DROP_NOT_POSSIBLE

public static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent> DROP_NOT_POSSIBLE

Event type fired when the drop validation callback rejects a drop target.

DRAG_OVER

public static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent> DRAG_OVER

Event type fired while a valid dragged item is over a drop target.

DRAG_STARTED

public static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent> DRAG_STARTED

Event type fired when a drag operation starts.

DRAG_ENDED

public static final javafx.event.EventType<MultiColumnListView.MultiColumnListViewEvent> DRAG_ENDED

Event type representing the end of a drag operation.

Constructor Details

MultiColumnListViewEvent

public MultiColumnListViewEvent(javafx.event.EventType<? extends javafx.event.Event> eventType,
 Object draggedItem,
 MultiColumnListView.ListViewColumn column,
 int index)

Creates a new multi-column list view event.

Parameters:

eventType - the specific event type

draggedItem - the item associated with the event

column - the column involved in the event

index - the item index involved in the event

Method Details

getDraggedItem

public Object getDraggedItem()

Returns the item associated with the event.

Returns:

the event item

getColumn

public MultiColumnListView.ListViewColumn getColumn()

Returns the column involved in the event.

Returns:

the column involved in the event

getIndex

public int getIndex()

Returns the item index involved in the event.

Returns:

the item index

toString

public String toString()

Overrides:

toString in class EventObject