modules/midp-lcdui/src/main/java/javax/microedition/lcdui/CommandLayoutPolicy.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 javax.microedition.lcdui;
  11
  12 import cc.squirreljme.runtime.cldc.annotation.Api;
  13 import cc.squirreljme.runtime.lcdui.SerializedEvent;
  14
  15 /**
  16  * This interface is called when commands need to be laid out onto the display.
  17  *
  18  * This allows the use of:
  19  *  - {@link Displayable#setCommand(Command, int)}.
  20  *  - {@link Displayable#setMenu(Menu, int)}.
  21  *  - {@link Displayable#removeCommandOrMenu(int)}.
  22  *
  23  * @since 2020/09/27
  24  */
  25 @SuppressWarnings("InterfaceWithOnlyOneDirectInheritor")
  26 @Api
  27 public interface CommandLayoutPolicy
  28 {
  29         /**
  30          * Callback for when the policy is being updated.
  31          *
  32          * @param __d The displayable getting the policy set.
  33          * @since 2020/09/27
  34          */
  35         @Api
  36         @SerializedEvent
  37         void onCommandLayout(Displayable __d);
  38 }
  39