Class SimpleTheme.Definition

java.lang.Object
com.googlecode.lanterna.graphics.SimpleTheme.Definition
All Implemented Interfaces:
ThemeDefinition
Enclosing class:
SimpleTheme
public static class SimpleTheme.Definition extends Object implements ThemeDefinition
Internal class inside SimpleTheme used to allow basic editing of the default style and the optional overrides.

  • Field Details

  • Constructor Details

    • Definition

      private Definition(ThemeStyle normal)

  • Method Details

    • getNormal

      public ThemeStyle getNormal()
      Description copied from interface: ThemeDefinition
      The normal style of the definition, which can be considered the default to be used.
      Specified by:
      getNormal in interface ThemeDefinition
      Returns:
      ThemeStyle representation for the normal style

    • getPreLight

      public ThemeStyle getPreLight()
      Description copied from interface: ThemeDefinition
      The pre-light style of this definition, which can be used when a component has input focus but isn't active or selected, similar to mouse-hoovering in modern GUIs
      Specified by:
      getPreLight in interface ThemeDefinition
      Returns:
      ThemeStyle representation for the pre-light style

    • setPreLight

      public SimpleTheme.Definition setPreLight(TextColor foreground, TextColor background, SGR... styles)
      Sets the theme definition style "prelight"
      Parameters:
      foreground - Foreground color for this style
      background - Background color for this style
      styles - SGR styles to use
      Returns:
      Itself

    • getSelected

      public ThemeStyle getSelected()
      Description copied from interface: ThemeDefinition
      The "selected" style of this definition, which can used when a component has been actively selected in some way.
      Specified by:
      getSelected in interface ThemeDefinition
      Returns:
      ThemeStyle representation for the selected style

    • setSelected

      public SimpleTheme.Definition setSelected(TextColor foreground, TextColor background, SGR... styles)
      Sets the theme definition style "selected"
      Parameters:
      foreground - Foreground color for this style
      background - Background color for this style
      styles - SGR styles to use
      Returns:
      Itself

    • getActive

      public ThemeStyle getActive()
      Description copied from interface: ThemeDefinition
      The "active" style of this definition, which can be used when a component is being directly interacted with
      Specified by:
      getActive in interface ThemeDefinition
      Returns:
      ThemeStyle representation for the active style

    • setActive

      public SimpleTheme.Definition setActive(TextColor foreground, TextColor background, SGR... styles)
      Sets the theme definition style "active"
      Parameters:
      foreground - Foreground color for this style
      background - Background color for this style
      styles - SGR styles to use
      Returns:
      Itself

    • getInsensitive

      public ThemeStyle getInsensitive()
      Description copied from interface: ThemeDefinition
      The insensitive style of this definition, which can be used when a component has been disabled or in some other way isn't able to be interacted with.
      Specified by:
      getInsensitive in interface ThemeDefinition
      Returns:
      ThemeStyle representation for the insensitive style

    • setInsensitive

      public SimpleTheme.Definition setInsensitive(TextColor foreground, TextColor background, SGR... styles)
      Sets the theme definition style "insensitive"
      Parameters:
      foreground - Foreground color for this style
      background - Background color for this style
      styles - SGR styles to use
      Returns:
      Itself

    • getCustom

      public ThemeStyle getCustom(String name)
      Description copied from interface: ThemeDefinition
      Retrieves a custom ThemeStyle, if one is available by this name. You can use this if you need more categories than the ones available above.
      Specified by:
      getCustom in interface ThemeDefinition
      Parameters:
      name - Name of the style to look up
      Returns:
      The ThemeStyle associated with the name

    • getCustom

      public ThemeStyle getCustom(String name, ThemeStyle defaultValue)
      Description copied from interface: ThemeDefinition
      Retrieves a custom ThemeStyle, if one is available by this name. Will return a supplied default value if no such style could be found within this ThemeDefinition. You can use this if you need more categories than the ones available above.
      Specified by:
      getCustom in interface ThemeDefinition
      Parameters:
      name - Name of the style to look up
      defaultValue - What to return if the there is no custom style by the given name
      Returns:
      The ThemeStyle associated with the name, or defaultValue if there was no such style

    • setCustom

      public SimpleTheme.Definition setCustom(String name, TextColor foreground, TextColor background, SGR... styles)
      Adds a custom definition style to the theme using the supplied name. This will be returned using the matching call to getCustom(String).
      Parameters:
      name - Name of the custom style
      foreground - Foreground color for this style
      background - Background color for this style
      styles - SGR styles to use
      Returns:
      Itself

    • getBooleanProperty

      public boolean getBooleanProperty(String name, boolean defaultValue)
      Description copied from interface: ThemeDefinition
      Retrieves a custom boolean property, if one is available by this name. Will return a supplied default value if no such property could be found within this ThemeDefinition.
      Specified by:
      getBooleanProperty in interface ThemeDefinition
      Parameters:
      name - Name of the boolean property to look up
      defaultValue - What to return if the there is no property with this name
      Returns:
      The property value stored in this theme definition, parsed as a boolean

    • setBooleanProperty

      public SimpleTheme.Definition setBooleanProperty(String name, boolean value)
      Attaches a boolean value property to this SimpleTheme that will be returned if calling getBooleanProperty(String, boolean) with the same name.
      Parameters:
      name - Name of the property
      value - Value to attach to the property name
      Returns:
      Itself

    • isCursorVisible

      public boolean isCursorVisible()
      Description copied from interface: ThemeDefinition
      Asks the theme definition for this component if the theme thinks that the text cursor should be visible or not. Note that certain components might have a visible state depending on the context and the current data set, in those cases it can use ThemeDefinition.getBooleanProperty(String, boolean) to allow themes more fine-grained control over when cursor should be visible or not.
      Specified by:
      isCursorVisible in interface ThemeDefinition
      Returns:
      A hint to the renderer as to if this theme thinks the cursor should be visible (returns true) or not (returns false)

    • setCursorVisible

      public SimpleTheme.Definition setCursorVisible(boolean cursorVisible)
      Sets the value that suggests if the cursor should be visible or not (it's still up to the component renderer if it's going to honour this or not).
      Parameters:
      cursorVisible - If true then this theme definition would like the text cursor to be displayed, false if not.
      Returns:
      Itself

    • getCharacter

      public char getCharacter(String name, char fallback)
      Description copied from interface: ThemeDefinition
      Retrieves a character from this theme definition by the specified name. This method cannot return null so you need to give a fallback in case the definition didn't have any character by this name.
      Specified by:
      getCharacter in interface ThemeDefinition
      Parameters:
      name - Name of the character to look up
      fallback - Character to return if there was no character by the name supplied in this definition
      Returns:
      The character from this definition by the name entered, or fallback if the definition didn't have any character defined with this name

    • setCharacter

      public SimpleTheme.Definition setCharacter(String name, char character)
      Stores a character value in this definition under a specific name. This is used to customize the appearance of certain components. It is returned with call to getCharacter(String, char) with the same name.
      Parameters:
      name - Symbolic name for the character
      character - Character to attach to the symbolic name
      Returns:
      Itself

    • getRenderer

      public <T extends Component> ComponentRenderer<T> getRenderer(Class<T> type)
      Description copied from interface: ThemeDefinition
      Returns a ComponentRenderer attached to this definition for the specified type. Generally one theme definition is linked to only one component type so it wouldn't need the type parameter to figure out what to return. unlike the other methods of this interface, it will not traverse up in the theme hierarchy if this field is not defined, instead the component will use its default component renderer.
      Specified by:
      getRenderer in interface ThemeDefinition
      Type Parameters:
      T - Type of component
      Parameters:
      type - Component class to get the theme's renderer for
      Returns:
      Renderer to use for the type component or null to use the default

    • setRenderer

      public <T extends Component> SimpleTheme.Definition setRenderer(Class<T> type, SimpleTheme.RendererProvider<T> rendererProvider)
      Registered a callback to get a custom ComponentRenderer for a particular class. Use this to make a certain component (built-in or external) to use a custom renderer.
      Type Parameters:
      T - Type of class
      Parameters:
      type - Class for which to invoke the callback and return the ComponentRenderer
      rendererProvider - Callback to invoke when getting a ComponentRenderer
      Returns:
      Itself