001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.ui;
020
021import org.jdom2.Element;
022
023/**
024 * Implemented by UI components that need access to the parent {@link UI} controller.
025 * @since 1.4.7
026 * @author Alejandro Revilla
027 * <p>
028 * An action listener may optional implement this interface in order
029 * to have the UI framework push a reference to the UI instance as well
030 * as the action's configuration element.
031 * </p>
032 */
033public interface UIAware {
034    /**
035     * Configures this UI-aware component.
036     * @param ui the UI context
037     * @param config the XML configuration element
038     */
039    void setUI(UI ui, Element config);
040}
041