io.github.palexdev.virtualizedfx.events.VFXContainerEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of virtualizedfx Show documentation
Alternative VirtualFlows for JavaFX
The newest version!
/*
 * Copyright (C) 2024 Parisi Alessandro - [email protected]
 * This file is part of VirtualizedFX (https://github.com/palexdev/VirtualizedFX)
 *
 * VirtualizedFX is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of the License,
 * or (at your option) any later version.
 *
 * VirtualizedFX is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with VirtualizedFX. If not, see .
 */

package io.github.palexdev.virtualizedfx.events;

import io.github.palexdev.virtualizedfx.base.VFXContainer;
import io.github.palexdev.virtualizedfx.cells.base.VFXCell;
import javafx.event.Event;
import javafx.event.EventTarget;
import javafx.event.EventType;
import javafx.scene.Node;

/**
 * Custom event implementation to be used with {@link VFXContainer}s. Event-based systems are very useful for loose coupling,
 * because it allows components to communicate with each other without needing to know the specifics of their implementations.
 * 
 * This mechanism should be used only when there are no other reasonable ways as the performance implications of this system
 * are not very clear.
 */
public class VFXContainerEvent extends Event {
    //================================================================================
    // Event Types
    //================================================================================

    /**
     * This event type can be used to tell cells to forcefully update. Especially useful when the model's data does not
     * use JavaFX's properties.
     *
     * @see VFXContainer#update(int...)
     */
    public static final EventType UPDATE = new EventType<>("UPDATE");

    //================================================================================
    // Constructors
    //================================================================================
    public VFXContainerEvent(Object source, EventTarget target, EventType eventType) {
        super(source, target, eventType);
    }

    //================================================================================
    // Static Methods
    //================================================================================
    public static  void update(VFXCell cell) {
        if (cell == null) return; // Avoid null targets
        Node node = cell.toNode();
        fireEvent(node, new VFXContainerEvent(null, node, UPDATE));
    }
}