mirror of https://github.com/FreeCol/freecol.git
55 lines
1.7 KiB
Java
55 lines
1.7 KiB
Java
/**
|
|
* Copyright (C) 2002-2022 The FreeCol Team
|
|
*
|
|
* This file is part of FreeCol.
|
|
*
|
|
* FreeCol is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* FreeCol 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with FreeCol. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package net.sf.freecol.client.gui.label;
|
|
|
|
import net.sf.freecol.client.gui.panel.CargoPanel;
|
|
import net.sf.freecol.common.model.Unit;
|
|
|
|
import java.awt.Component;
|
|
|
|
/**
|
|
* An interface used for updating a {@code CargoPanel} to add or
|
|
* remove a {@code Component}
|
|
*/
|
|
public interface CargoLabel {
|
|
|
|
/**
|
|
* The {@code Component} to add to a {@code CargoPanel}.
|
|
*
|
|
* @param comp The input Component to add.
|
|
* @param carrier The Carrier to add the component too.
|
|
* @param cargoPanel The CargoPanel to affect.
|
|
* @return True if the component was added.
|
|
*/
|
|
boolean addCargo(Component comp, Unit carrier, CargoPanel cargoPanel);
|
|
|
|
|
|
/**
|
|
* The {@code Component} to remove from a {@code CargoPanel}.
|
|
*
|
|
* @param comp The Component to remove.
|
|
* @param cargoPanel The {@link CargoPanel} to affect.
|
|
*/
|
|
default void removeCargo(Component comp, CargoPanel cargoPanel) {
|
|
cargoPanel.update();
|
|
}
|
|
|
|
}
|