TextualDisplayDevice.java

/*
 * Copyright 2014-2015 Cel Skeggs
 *
 * This file is part of the CCRE, the Common Chicken Runtime Engine.
 *
 * The CCRE 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.
 *
 * The CCRE 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 the CCRE.  If not, see <http://www.gnu.org/licenses/>.
 */
package ccre.frc.devices;

import ccre.frc.Device;
import ccre.frc.components.SpacingComponent;
import ccre.frc.components.TextComponent;

/**
 * A device to display modifiable text.
 *
 * @author skeggsc
 */
public class TextualDisplayDevice extends Device {

    private final int height;
    private final TextComponent text;

    /**
     * Create a new TextualDisplayDevice with an initial string and specified
     * height.
     *
     * @param string the initial string to display.
     * @param height the wanted height of the device.
     */
    public TextualDisplayDevice(String string, int height) {
        this.height = height;
        add(new SpacingComponent(20));
        text = new TextComponent(string);
        add(text);
    }

    /**
     * Change the displayed text.
     *
     * @param str the new text to display.
     */
    public void set(String str) {
        text.setLabel(str);
    }

    public int getHeight() {
        return height;
    }
}