001/*
002 * Copyright (C) 2012 eXo Platform SAS.
003 *
004 * This is free software; you can redistribute it and/or modify it
005 * under the terms of the GNU Lesser General Public License as
006 * published by the Free Software Foundation; either version 2.1 of
007 * the License, or (at your option) any later version.
008 *
009 * This software is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * You should have received a copy of the GNU Lesser General Public
015 * License along with this software; if not, write to the Free
016 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
017 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
018 */
019
020package org.crsh.shell;
021
022import org.crsh.text.Chunk;
023
024import java.io.Flushable;
025import java.io.IOException;
026
027/**
028 * The screen context extends the consumer and add information about the screen.
029 */
030public interface ScreenContext extends Flushable {
031
032  /**
033   * Returns the screen width in chars. When the value is not positive it means
034   * the value could not be determined.
035   *
036   * @return the term width
037   */
038  int getWidth();
039
040  /**
041   * Returns the screen height in chars. When the value is not positive it means
042   * the value could not be determined.
043   *
044   * @return the term height
045   */
046  int getHeight();
047
048  /**
049   * Write a chunk to the screen.
050   *
051   * @param chunk the chunk
052   * @throws IOException any io exception
053   */
054  void write(Chunk chunk) throws IOException;
055
056}