.. default-domain:: java
.. highlight:: java
.. package:: krpc.client.services.UI

Dropdown
========


.. type:: public class Dropdown

   A control for choosing one of a list of options, which are shown when it is clicked.
   Added to a :type:`Canvas` or a :type:`Panel`.

   .. method:: RectTransform getRectTransform()


      The rect transform for the UI object.

   

   .. method:: LayoutElement getLayoutElement()


      How much space the UI object asks a layout for.

   

      .. note::

         Only has an effect when the object is in a panel that has a layout. A canvas is
         not inside a layout and does not have one.

   .. method:: boolean getVisible()

   .. method:: void setVisible(boolean value)

      Whether the UI object is visible.

   

      .. note::

         This is the object's own setting, which is what it was last set to. An object is
         only drawn when everything it is inside is visible as well, so an interface can
         be built with its parts visible, inside a panel that is not, and shown all at
         once by making that panel visible.

   .. method:: java.util.List<String> getOptions()

   .. method:: void setOptions(java.util.List<String> value)

      The options that the dropdown offers.

   

      .. note::

         Setting the options resets the selection to the first of them, or to nothing
         when the list is empty.

   .. method:: int getSelectedIndex()

   .. method:: void setSelectedIndex(int value)

      The position in :meth:`Dropdown.getOptions()` of the option that is chosen.

   

      .. note::

         Zero while the dropdown has no options, as there is nothing to choose.

   .. method:: boolean getChanged()

   .. method:: void setChanged(boolean value)

      Whether the chosen option has been changed.

   

      .. note::

         This property is set to true when the user chooses an option, and not when a
         client chooses one.
         A client script should reset the property to false in order to detect subsequent changes.

   .. method:: boolean getInteractable()

   .. method:: void setInteractable(boolean value)

      Whether the control responds to the user.

   

      .. note::

         A control that is not interactable is drawn grayed out and ignores the user,
         but is still visible. Set its visibility to false to hide it instead.

   .. method:: StdLib.ColorRGBA getColor()

   .. method:: void setColor(StdLib.ColorRGBA value)

      The color the control is tinted with. White, the default, leaves the control drawn
      as the skin has it.

   

      .. note::

         The tint multiplies the sprite the control is drawn with, in every state, so
         a control can show a state of its own, an engaged autopilot for instance, by
         color. It is applied to the part of the control that responds to the user:
         the body of a button, dropdown or input field, the box of a toggle, and the
         handle of a slider. A control's label is tinted through the color of its
         text.

   .. method:: String getTooltip()

   .. method:: void setTooltip(String value)

      A short piece of text shown beside the pointer while it rests on the
      control. Empty, the default, shows nothing.

   

   .. method:: void remove()

      Remove the UI object.