Package de.xima.fc.interfaces.color

Interface IGuiColor

All Superinterfaces:
Serializable
All Known Implementing Classes:
CustomColor, EMrmrsColor, ENagixChartJsColor, EQuasarColor, EWebColors
public interface IGuiColor extends Serializable
Interface for the color entries provided by a color palette.
Since:
6.5.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getStyleBackground

      default String getStyleBackground()

    • getStyleClassBackground

      default String getStyleClassBackground()

    • getStyleClassTextOnWhite

      default String getStyleClassTextOnWhite()

    • getStyleTextOnWhite

      default String getStyleTextOnWhite(boolean whiteToBlack)

    • getField

      <T extends Serializable> T getField(IColorField<T> field) throws IllegalArgumentException
      Finds the value of the given color palette field.
      Type Parameters:
      T - Type of the field value.
      Parameters:
      field - A field to retrieve.
      Returns:
      The value of this color palette entry for the given field.
      Throws:
      IllegalArgumentException - If the given field is not supported, see EColorPalette#supportsField.

    • getSupportedFields

      com.google.common.collect.ImmutableSet<IColorField<?>> getSupportedFields()
      Returns:
      All fields supported by this color.
      See Also:

    • supportsField

      default boolean supportsField(IColorField<?> field)
      Checks whether the color field is supported by this color. When this returns false for a certain IColorField, getField(IColorField) will throw an exception when called with that field. Otherwise, when this returns true, a value is available.
      Parameters:
      field - A field to check.
      Returns:
      Whether the given color field is support by this color.
      See Also: