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    
020    package org.crsh.io;
021    
022    /**
023     * The screen context extends the pipe and add information about the screen.
024     *
025     * @param <E> the element generic type
026     */
027    public interface ScreenContext<E> extends Pipe<E> {
028    
029      /**
030       * Returns the screen width in chars. When the value is not positive it means
031       * the value could not be determined.
032       *
033       * @return the term width
034       */
035      int getWidth();
036    
037      /**
038       * Returns the screen height in chars. When the value is not positive it means
039       * the value could not be determined.
040       *
041       * @return the term height
042       */
043      int getHeight();
044    
045    }