TerminalProperties (text-io Documentation (2.8.0))

java.lang.Object
- org.beryx.textio.TerminalProperties<T>

Type Parameters:

T - the type of the TextTerminal.
```
public class TerminalProperties<T extends TextTerminal<T>>
extends Object
```
A map of properties associated with a TextTerminal.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TerminalProperties.BooleanChangeListener<TT extends TextTerminal<TT>>`
`static interface`	`TerminalProperties.ChangeListener<TT extends TextTerminal<TT>,V>`
`static interface`	`TerminalProperties.DoubleChangeListener<TT extends TextTerminal<TT>>`
`static interface`	`TerminalProperties.ExtendedChangeListener<TT extends TextTerminal<TT>>`
`static interface`	`TerminalProperties.IntChangeListener<TT extends TextTerminal<TT>>`
`static interface`	`TerminalProperties.LongChangeListener<TT extends TextTerminal<TT>>`
`static interface`	`TerminalProperties.StringChangeListener<TT extends TextTerminal<TT>>`

Constructor Summary

Constructors
Constructor and Description

TerminalProperties(T textTerminal)

Constructors
Constructor and Description
`TerminalProperties(T textTerminal)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBooleanListener(String key, boolean defaultValue, TerminalProperties.BooleanChangeListener<T> listener)` Convenience method that adds a listener for the boolean property with the specified key.
`void`	`addDoubleListener(String key, double defaultValue, TerminalProperties.DoubleChangeListener<T> listener)` Convenience method that adds a listener for the double property with the specified key.
`void`	`addIntListener(String key, int defaultValue, TerminalProperties.IntChangeListener<T> listener)` Convenience method that adds a listener for the int property with the specified key.
`void`	`addListener(TerminalProperties.ExtendedChangeListener<T> listener)` Adds a listener for this TerminalProperties instance.
`void`	`addLongListener(String key, long defaultValue, TerminalProperties.LongChangeListener<T> listener)` Convenience method that adds a listener for the long property with the specified key.
`void`	`addStringListener(String key, String defaultValue, TerminalProperties.StringChangeListener<T> listener)` Convenience method that adds a listener for the String property with the specified key.
`boolean`	`getBoolean(String key, boolean defaultValue)` Gets the boolean value of the property with the specified key.
`double`	`getDouble(String key, double defaultValue)` Gets the double value of the property with the specified key.
`int`	`getInt(String key, int defaultValue)` Gets the int value of the property with the specified key.
`List<TerminalProperties.ExtendedChangeListener>`	`getListeners()`
`long`	`getLong(String key, long defaultValue)` Gets the long value of the property with the specified key.
`String`	`getString(String key)`
`String`	`getString(String key, String defaultValue)` Gets the String value of the property with the specified key.
`Object`	`put(String key, Object value)` Sets the value associated with the specified key.
`void`	`putAll(Map<String,? extends Object> map)`
`Object`	`remove(String key)` Removes the property with the specified key.
`void`	`setInputBackgroundColor(javafx.scene.paint.Color bgcolor)` Convenience method that associates the hex representation of the specified `bgcolor` with the key
`void`	`setInputBackgroundColor(String bgcolor)` Convenience method that associates the specified `bgcolor` with the key
`void`	`setInputBold(boolean bold)` Convenience method that associates the boolean value `bold` with the key
`void`	`setInputColor(javafx.scene.paint.Color color)` Convenience method that associates the hex representation of the specified `color` with the key
`void`	`setInputColor(String color)` Convenience method that associates the specified `color` with the key
`void`	`setInputItalic(boolean italic)` Convenience method that associates the boolean value `italic` with the key
`void`	`setInputUnderline(boolean underline)` Convenience method that associates the boolean value `underline` with the key
`void`	`setPaneBackgroundColor(javafx.scene.paint.Color bgcolor)` Convenience method that associates the hex representation of the specified `bgcolor` with the key
`void`	`setPaneBackgroundColor(String bgcolor)` Convenience method that associates the specified `bgcolor` with the key
`void`	`setPromptBackgroundColor(javafx.scene.paint.Color bgcolor)` Convenience method that associates the hex representation of the specified `bgcolor` with the key
`void`	`setPromptBackgroundColor(String bgcolor)` Convenience method that associates the specified `bgcolor` with the key
`void`	`setPromptBold(boolean bold)` Convenience method that associates the boolean value `bold` with the key
`void`	`setPromptColor(javafx.scene.paint.Color color)` Convenience method that associates the hex representation of the specified `color` with the key
`void`	`setPromptColor(String color)` Convenience method that associates the specified `color` with the key
`void`	`setPromptItalic(boolean italic)` Convenience method that associates the boolean value `italic` with the key
`void`	`setPromptUnderline(boolean underline)` Convenience method that associates the boolean value `underline` with the key

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TerminalProperties
```
public TerminalProperties(T textTerminal)
```
- Method Detail
  - getListeners
```
public List<TerminalProperties.ExtendedChangeListener> getListeners()
```
    Returns:
    
    the list of TerminalProperties.ExtendedChangeListener for this instance of TerminalProperties.
  - remove
```
public Object remove(String key)
```
    Removes the property with the specified key.
    
    Parameters:
    
    key - the key whose associated value should be removed.
    
    Returns:
    
    the old value associated with the specified key.
  - put
```
public Object put(String key,
                  Object value)
```
    Sets the value associated with the specified key.
    
    Parameters:
    
    key - the key with which the specified value should be associated.
    
    value - the value to be associated with the specified key.
    
    Returns:
  - putAll
```
public void putAll(Map<String,? extends Object> map)
```
  - getString
```
public String getString(String key)
```
    Returns:
    
    the value associated with the specified key.
  - getString
```
public String getString(String key,
                        String defaultValue)
```
    Gets the String value of the property with the specified key.
    
    Parameters:
    
    key - the key whose associated value should be retrieved.
    
    defaultValue - the value to be returned if no value is associated with the specified key or the associated value is null or empty.
    
    Returns:
    
    the string value of the property with the specified key.
  - getInt
```
public int getInt(String key,
                  int defaultValue)
```
    Gets the int value of the property with the specified key.
    
    Parameters:
    
    key - the key whose associated value should be retrieved.
    
    defaultValue - the value to be returned if no value is associated with the specified key or the string representation of the value cannot be converted to int.
    
    Returns:
    
    the int value of the property with the specified key.
  - getLong
```
public long getLong(String key,
                    long defaultValue)
```
    Gets the long value of the property with the specified key.
    
    Parameters:
    
    key - the key whose associated value should be retrieved.
    
    defaultValue - the value to be returned if no value is associated with the specified key or the string representation of the value cannot be converted to long.
    
    Returns:
    
    the long value of the property with the specified key.
  - getDouble
```
public double getDouble(String key,
                        double defaultValue)
```
    Gets the double value of the property with the specified key.
    
    Parameters:
    
    key - the key whose associated value should be retrieved.
    
    defaultValue - the value to be returned if no value is associated with the specified key or the string representation of the value cannot be converted to double.
    
    Returns:
    
    the double value of the property with the specified key.
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean defaultValue)
```
    Gets the boolean value of the property with the specified key.
    
    Parameters:
    
    key - the key whose associated value should be retrieved.
    
    defaultValue - the value to be returned if no value is associated with the specified key.
    
    Returns:
    
    the boolean value of the property with the specified key.
  - addListener
```
public void addListener(TerminalProperties.ExtendedChangeListener<T> listener)
```
    Adds a listener for this TerminalProperties instance.
    
    Parameters:
    
    listener - the listener to be added.
  - addStringListener
```
public void addStringListener(String key,
                              String defaultValue,
                              TerminalProperties.StringChangeListener<T> listener)
```
    Convenience method that adds a listener for the String property with the specified key.
    
    Parameters:
    
    key - the key of the property for which the listener is added.
    
    defaultValue - the value to be used if the new value is null.
    
    listener - the listener to be added.
  - addIntListener
```
public void addIntListener(String key,
                           int defaultValue,
                           TerminalProperties.IntChangeListener<T> listener)
```
    Convenience method that adds a listener for the int property with the specified key.
    
    Parameters:
    
    key - the key of the property for which the listener is added.
    
    defaultValue - the value to be used if the new value cannot be converted to an int.
    
    listener - the listener to be added.
  - addLongListener
```
public void addLongListener(String key,
                            long defaultValue,
                            TerminalProperties.LongChangeListener<T> listener)
```
    Convenience method that adds a listener for the long property with the specified key.
    
    Parameters:
    
    key - the key of the property for which the listener is added.
    
    defaultValue - the value to be used if the new value cannot be converted to a long.
    
    listener - the listener to be added.
  - addDoubleListener
```
public void addDoubleListener(String key,
                              double defaultValue,
                              TerminalProperties.DoubleChangeListener<T> listener)
```
    Convenience method that adds a listener for the double property with the specified key.
    
    Parameters:
    
    key - the key of the property for which the listener is added.
    
    defaultValue - the value to be used if the new value cannot be converted to a double.
    
    listener - the listener to be added.
  - addBooleanListener
```
public void addBooleanListener(String key,
                               boolean defaultValue,
                               TerminalProperties.BooleanChangeListener<T> listener)
```
    Convenience method that adds a listener for the boolean property with the specified key.
    
    Parameters:
    
    key - the key of the property for which the listener is added.
    
    defaultValue - the value to be used if the new value is null.
    
    listener - the listener to be added.
  - setPromptColor
```
public void setPromptColor(String color)
```
    Convenience method that associates the specified color with the key
  - setPromptColor
```
public void setPromptColor(javafx.scene.paint.Color color)
```
    Convenience method that associates the hex representation of the specified color with the key
  - setPromptBackgroundColor
```
public void setPromptBackgroundColor(String bgcolor)
```
    Convenience method that associates the specified bgcolor with the key
  - setPromptBackgroundColor
```
public void setPromptBackgroundColor(javafx.scene.paint.Color bgcolor)
```
    Convenience method that associates the hex representation of the specified bgcolor with the key
  - setPromptBold
```
public void setPromptBold(boolean bold)
```
    Convenience method that associates the boolean value bold with the key
  - setPromptItalic
```
public void setPromptItalic(boolean italic)
```
    Convenience method that associates the boolean value italic with the key
  - setPromptUnderline
```
public void setPromptUnderline(boolean underline)
```
    Convenience method that associates the boolean value underline with the key
  - setInputColor
```
public void setInputColor(String color)
```
    Convenience method that associates the specified color with the key
  - setInputColor
```
public void setInputColor(javafx.scene.paint.Color color)
```
    Convenience method that associates the hex representation of the specified color with the key
  - setInputBackgroundColor
```
public void setInputBackgroundColor(String bgcolor)
```
    Convenience method that associates the specified bgcolor with the key
  - setInputBackgroundColor
```
public void setInputBackgroundColor(javafx.scene.paint.Color bgcolor)
```
    Convenience method that associates the hex representation of the specified bgcolor with the key
  - setInputBold
```
public void setInputBold(boolean bold)
```
    Convenience method that associates the boolean value bold with the key
  - setInputItalic
```
public void setInputItalic(boolean italic)
```
    Convenience method that associates the boolean value italic with the key
  - setInputUnderline
```
public void setInputUnderline(boolean underline)
```
    Convenience method that associates the boolean value underline with the key
  - setPaneBackgroundColor
```
public void setPaneBackgroundColor(String bgcolor)
```
    Convenience method that associates the specified bgcolor with the key
  - setPaneBackgroundColor
```
public void setPaneBackgroundColor(javafx.scene.paint.Color bgcolor)
```
    Convenience method that associates the hex representation of the specified bgcolor with the key

Class TerminalProperties<T extends TextTerminal<T>>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TerminalProperties

Method Detail

getListeners

remove

put

putAll

getString

getString

getInt

getLong

getDouble

getBoolean

addListener

addStringListener

addIntListener

addLongListener

addDoubleListener

addBooleanListener

setPromptColor

setPromptColor

setPromptBackgroundColor

setPromptBackgroundColor

setPromptBold

setPromptItalic

setPromptUnderline

setInputColor

setInputColor

setInputBackgroundColor

setInputBackgroundColor

setInputBold

setInputItalic

setInputUnderline

setPaneBackgroundColor

setPaneBackgroundColor