Module io.github.tonywasher.joceanus.tethys.core
Package io.github.tonywasher.joceanus.tethys.api.field

Interface TethysUIDataEditField<T>

Type Parameters:
T - the data type
All Superinterfaces:
OceanusEventRegistrar.OceanusEventProvider<TethysUIEvent>, TethysUIComponent
All Known Subinterfaces:
TethysUIDataEditField.TethysUICharArrayEditField, TethysUIDataEditField.TethysUICharArrayTextAreaField, TethysUIDataEditField.TethysUIColorButtonField, TethysUIDataEditField.TethysUICurrencyEditField<T>, TethysUIDataEditField.TethysUIDateButtonField, TethysUIDataEditField.TethysUIIconButtonField<T>, TethysUIDataEditField.TethysUIIntegerEditField, TethysUIDataEditField.TethysUIListButtonField<T>, TethysUIDataEditField.TethysUILongEditField, TethysUIDataEditField.TethysUIMoneyEditField, TethysUIDataEditField.TethysUIPriceEditField, TethysUIDataEditField.TethysUIRateEditField, TethysUIDataEditField.TethysUIRatioEditField, TethysUIDataEditField.TethysUIRawDecimalEditField, TethysUIDataEditField.TethysUIScrollButtonField<T>, TethysUIDataEditField.TethysUIShortEditField, TethysUIDataEditField.TethysUIStringEditField, TethysUIDataEditField.TethysUIStringTextAreaField, TethysUIDataEditField.TethysUIUnitsEditField, TethysUIDataEditField.TethysUIValidatedEditField<T>
All Known Implementing Classes:
TethysUICoreDataEditField
public interface TethysUIDataEditField<T> extends OceanusEventRegistrar.OceanusEventProvider<TethysUIEvent>, TethysUIComponent
Generic interface for displaying and editing a data field.

  • Method Details

    • setEditable

      void setEditable(boolean pEditable)
      Set Editable state.
      Parameters:
      pEditable - true/false.

    • isEditable

      boolean isEditable()
      Is the field editable?
      Returns:
      true/false.

    • setValue

      void setValue(T pValue)
      Set the value.
      Parameters:
      pValue - the value

    • getValue

      T getValue()
      Obtain the value.
      Returns:
      the value.

    • getCastValue

      T getCastValue(Object pValue)
      Obtain the cast value.
      Parameters:
      pValue - the value as object
      Returns:
      the value

    • showCmdButton

      void showCmdButton(boolean pShow)
      Show the command button.
      Parameters:
      pShow - true/false

    • setCmdMenuConfigurator

      void setCmdMenuConfigurator(Consumer<TethysUIScrollMenu<String>> pConfigurator)
      Set the command menu configurator.
      Parameters:
      pConfigurator - the configurator.

    • setTheAttributeState

      void setTheAttributeState(TethysUIFieldAttribute pAttr, boolean pState)
      Set the attribute state.
      Parameters:
      pAttr - the attribute
      pState - the state

    • setTheAttribute

      void setTheAttribute(TethysUIFieldAttribute pAttr)
      Set the attribute.
      Parameters:
      pAttr - the attribute

    • clearTheAttribute

      void clearTheAttribute(TethysUIFieldAttribute pAttr)
      Clear the attribute.
      Parameters:
      pAttr - the attribute

    • isAttributeSet

      boolean isAttributeSet(TethysUIFieldAttribute pAttr)
      Is the attribute set?
      Parameters:
      pAttr - the attribute
      Returns:
      true/false

    • adjustField

      void adjustField()
      Adjust data field.

    • getHeight

      Integer getHeight()
      Obtain the height.
      Returns:
      the height

    • setPreferredWidth

      void setPreferredWidth(Integer pWidth)
      Description copied from interface: TethysUIComponent
      Set the Preferred Width.
      Specified by:
      setPreferredWidth in interface TethysUIComponent
      Parameters:
      pWidth - the width

    • setPreferredHeight

      void setPreferredHeight(Integer pHeight)
      Description copied from interface: TethysUIComponent
      Set the Preferred Height.
      Specified by:
      setPreferredHeight in interface TethysUIComponent
      Parameters:
      pHeight - the height