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

InputField
==========


.. type:: public class InputField

   An input field.
   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:: String getValue()

   .. method:: void setValue(String value)

      The value of the input field.

   

   .. method:: Text getText()


      The text component of the input field.

   

      .. note::

         Use :meth:`InputField.getValue()` to get and set the value in the field.
         This object can be used to alter the style of the input field's text.

   .. method:: Text getPlaceholder()


      The placeholder text component of the input field.

   

      .. note::

         Set its :meth:`Text.getContent()` to the hint to show while the field is empty.
         The hint is hidden as soon as the field has a value.

   .. method:: InputContentType getContentType()

   .. method:: void setContentType(InputContentType value)

      The content the field accepts from the user. Keystrokes that do not fit are
      ignored as they are typed, so a numeric field only ever shows a number.

   

      .. note::

         The filter applies to typing alone. A value set by a client is shown as it is
         given.

   .. method:: int getCharacterLimit()

   .. method:: void setCharacterLimit(int value)

      The most characters the user can type into the field, or 0 for no limit.

   

   .. method:: boolean getReadOnly()

   .. method:: void setReadOnly(boolean value)

      Whether the user is stopped from editing the field. The value can still be
      selected and copied, and a client can still set it.

   

      .. note::

         A read-only field is drawn as normal. Make the field not interactable instead
         to gray it out and stop the user selecting it.

   .. method:: boolean getChanged()

   .. method:: void setChanged(boolean value)

      Whether the input field has been changed.

   

      .. note::

         This property is set to true when the user modifies the value of the input field,
         and not when a client sets it.
         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.

   



.. type:: public enum InputContentType

   What an input field lets the user type into it.


   .. field:: public InputContentType STANDARD

      Any text.


   .. field:: public InputContentType INTEGER

      A whole number: digits, with a leading minus sign.


   .. field:: public InputContentType DECIMAL

      A number: digits, with a decimal separator and a leading minus sign.


   .. field:: public InputContentType ALPHANUMERIC

      Letters and digits.


   .. field:: public InputContentType PASSWORD

      Any text, drawn as asterisks so that it cannot be read off the screen.