[jvcard.git] / src / com / googlecode / lanterna / gui2 / Composite.java

/*
 * This file is part of lanterna (http://code.google.com/p/lanterna/).
 * 
 * lanterna 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.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * Copyright (C) 2010-2015 Martin
 */
package com.googlecode.lanterna.gui2;

/**
 * A Composite is a Container that contains only one (or zero) component. Normally it is a kind of decorator, like a
 * border, that wraps a single component for visualization purposes.
 * @author Martin
 */
public interface Composite {
    /**
     * Returns the component that this Composite is wrapping
     * @return Component the composite is wrapping
     */
    Component getComponent();
    
    /**
     * Sets the component which is inside this Composite. If you call this method with null, it removes the component
     * wrapped by this Composite.
     * @param component Component to wrap
     */
    void setComponent(Component component);
}
Commit	Line	Data
	1	/*
	2	* This file is part of lanterna (http://code.google.com/p/lanterna/).
	3	*
	4	* lanterna is free software: you can redistribute it and/or modify
	5	* it under the terms of the GNU Lesser General Public License as published by
	6	* the Free Software Foundation, either version 3 of the License, or
	7	* (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU Lesser General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU Lesser General Public License
	15	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	16	*
	17	* Copyright (C) 2010-2015 Martin
	18	*/
	19	package com.googlecode.lanterna.gui2;
	20
	21	/**
	22	* A Composite is a Container that contains only one (or zero) component. Normally it is a kind of decorator, like a
	23	* border, that wraps a single component for visualization purposes.
	24	* @author Martin
	25	*/
	26	public interface Composite {
	27	/**
	28	* Returns the component that this Composite is wrapping
	29	* @return Component the composite is wrapping
	30	*/
	31	Component getComponent();
	32
	33	/**
	34	* Sets the component which is inside this Composite. If you call this method with null, it removes the component
	35	* wrapped by this Composite.
	36	* @param component Component to wrap
	37	*/
	38	void setComponent(Component component);
	39	}