modules/cldc-compact/src/main/java/cc/squirreljme/jvm/mle/constants/UIWidgetProperty.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.jvm.mle.brackets.UIItemBracket;
  13 import cc.squirreljme.runtime.cldc.annotation.Exported;
  14
  15 /**
  16  * Integer and String properties for {@link UIItemBracket}.
  17  *
  18  * @since 2020/07/19
  19  */
  20 @Exported
  21 public interface UIWidgetProperty
  22 {
  23         /** Null property. */
  24         @Exported
  25         byte NULL =
  26                 0;
  27
  28         /** The label of the item. */
  29         @Exported
  30         byte STRING_LABEL =
  31                 1;
  32
  33         /** Widget width. */
  34         @Exported
  35         byte INT_WIDTH =
  36                 2;
  37
  38         /** Widget height. */
  39         @Exported
  40         byte INT_HEIGHT =
  41                 3;
  42
  43         /** Signals that a repaint should happen. */
  44         @Exported
  45         byte INT_SIGNAL_REPAINT =
  46                 4;
  47
  48         /** X position. */
  49         @Exported
  50         byte INT_X_POSITION =
  51                 5;
  52
  53         /** Y position. */
  54         @Exported
  55         byte INT_Y_POSITION =
  56                 6;
  57
  58         /** Is this shown? */
  59         @Exported
  60         byte INT_IS_SHOWN =
  61                 7;
  62
  63         /** Width and height in old+new. */
  64         @Exported
  65         byte INT_WIDTH_AND_HEIGHT =
  66                 8;
  67
  68         /** The type of {@link UIListType} to use. */
  69         @Exported
  70         byte INT_LIST_TYPE =
  71                 9;
  72
  73         /** The number of elements to appear on a list. */
  74         @Exported
  75         byte INT_NUM_ELEMENTS =
  76                 10;
  77
  78         /** Enable or get enabled for a given list item */
  79         @Exported
  80         byte INT_LIST_ITEM_DISABLED =
  81                 11;
  82
  83         /**
  84          * Select or get select for a given list item. If the locking code is not
  85          * the same, this is likely from another sequence.
  86          *
  87          * @squirreljme.uiwidgetparam 1 The locking code, to check which list
  88          * selection update sequence this is in.
  89          * @squirreljme.uiwidgetparam 2 The selection state of the item.
  90          */
  91         @Exported
  92         byte INT_LIST_ITEM_SELECTED =
  93                 12;
  94
  95         /** The dimension of the drawn icon image ({@code DxD}). */
  96         @Exported
  97         byte INT_LIST_ITEM_ICON_DIMENSION =
  98                 13;
  99
 100         /** The label for a list item. */
 101         @Exported
 102         byte STRING_LIST_ITEM_LABEL =
 103                 14;
 104
 105         /** The ID for a list entry, to detect changes. */
 106         @Exported
 107         byte INT_LIST_ITEM_ID_CODE =
 108                 15;
 109
 110         /** The font to use for the item ({@code pxsize|style|name}). */
 111         @Exported
 112         byte INT_LIST_ITEM_FONT =
 113                 16;
 114
 115         /** The {@link UIItemType} this item is. */
 116         @Exported
 117         byte INT_UIITEM_TYPE =
 118                 17;
 119
 120         /**
 121          * Select or get select for a given list item.
 122          *
 123          * @squirreljme.uiwidgetparam 1 The current locking code this is intended
 124          * for, for new codes this should be zero.
 125          * @squirreljme.uiwidgetparam 2 The new locking code, zero clears.
 126          */
 127         @Exported
 128         byte INT_UPDATE_LIST_SELECTION_LOCK =
 129                 18;
 130
 131         /** The form title. */
 132         @Exported
 133         byte STRING_FORM_TITLE =
 134                 19;
 135
 136         /** Signal focus on this item. */
 137         @Exported
 138         byte INT_SIGNAL_FOCUS =
 139                 20;
 140
 141         /** The number of properties. */
 142         @Exported
 143         byte NUM_PROPERTIES =
 144                 21;
 145 }