modules/cldc-compact/src/main/java/cc/squirreljme/jvm/mle/constants/UIItemPosition.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.jvm.mle.constants;
  11
  12 import cc.squirreljme.runtime.cldc.annotation.Exported;
  13
  14 /**
  15  * These indexes in this class are the special form indexes which specify that
  16  * certain form items be placed in a special position.
  17  *
  18  * All of these values are negative and there is {@link #MIN_VALUE} that
  19  * is permitted.
  20  *
  21  * @since 2020/06/30
  22  */
  23 @Exported
  24 public interface UIItemPosition
  25 {
  26         /** The left command button. */
  27         @Exported
  28         @Deprecated
  29         byte LEFT_COMMAND =
  30                 -1;
  31
  32         /** The right command button. */
  33         @Exported
  34         @Deprecated
  35         byte RIGHT_COMMAND =
  36                 -2;
  37
  38         /** The main title which is at the top of the form always. */
  39         @Exported
  40         @Deprecated
  41         byte TITLE =
  42                 -3;
  43
  44         /**
  45          * The ticker position which is always below the title, a scrolling effect
  46          * may happen on the item.
  47          */
  48         @Exported
  49         @Deprecated
  50         byte TICKER =
  51                 -4;
  52
  53         /** The body of the form, this acts as a "full-screen" view. */
  54         @Exported
  55         byte BODY =
  56                 -5;
  57
  58         /** The touch-screen control interface. */
  59         @Exported
  60         byte TOUCH_CONTROLS =
  61                 -6;
  62
  63         /** The lowest permitted value, no value can be lower than this. */
  64         @Exported
  65         byte MIN_VALUE =
  66                 -6;
  67
  68         /** The number of special items, for shifting. */
  69         @Exported
  70         byte SPECIAL_SHIFT =
  71                 6;
  72
  73         /** The item is not on the form. */
  74         @Exported
  75         int NOT_ON_FORM =
  76                 Integer.MIN_VALUE;
  77 }