src/jexer/EditMenuUser.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2019 Kevin Lamonte
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the "Software"),
  10  * to deal in the Software without restriction, including without limitation
  11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12  * and/or sell copies of the Software, and to permit persons to whom the
  13  * Software is furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24  * DEALINGS IN THE SOFTWARE.
  25  *
  26  * @author Kevin Lamonte [kevin.lamonte@gmail.com]
  27  * @version 1
  28  */
  29 package jexer;
  30
  31 /**
  32  * EditMenuUser is used by TApplication to enable/disable edit menu items.  A
  33  * widget that supports these functions should define an onCommand method
  34  * that operates on cmCut, cmCopy, cmPaste, and cmClear.
  35  */
  36 public interface EditMenuUser {
  37
  38     /**
  39      * Check if the cut menu item should be enabled.
  40      *
  41      * @return true if the cut menu item should be enabled
  42      */
  43     public boolean isEditMenuCut();
  44
  45     /**
  46      * Check if the copy menu item should be enabled.
  47      *
  48      * @return true if the copy menu item should be enabled
  49      */
  50     public boolean isEditMenuCopy();
  51
  52     /**
  53      * Check if the paste menu item should be enabled.
  54      *
  55      * @return true if the paste menu item should be enabled
  56      */
  57     public boolean isEditMenuPaste();
  58
  59     /**
  60      * Check if the clear menu item should be enabled.
  61      *
  62      * @return true if the clear menu item should be enabled
  63      */
  64     public boolean isEditMenuClear();
  65
  66 }