Package ghidra.util.table.field

# Class ByteCountSettingsDefinition

java.lang.Object
ghidra.util.table.field.ByteCountSettingsDefinition

All Implemented Interfaces:
  `EnumSettingsDefinition`, `SettingsDefinition`

public class ByteCountSettingsDefinition extends Object implements EnumSettingsDefinition

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final ByteCountSettingsDefinition`
  `DEF`
  `static final int`
  `DEFAULT`
  `static final int`
  `MAX_BYTE_COUNT`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `clear(Settings settings)`
  Removes any values in the given settings object assocated with this settings definition
  `void`
  `copySetting(Settings settings, Settings destSettings)`
  Copies any setting value associated with this settings definition from the srcSettings settings to the destSettings.
  `int`
  `getChoice(Settings settings)`
  Returns the current value for this settings
  `String`
  `getDescription()`
  Returns a description of this settings definition
  `String`
  `getDisplayChoice(int value, Settings s1)`
  Returns the String for the given enum value
  `String[]`
  `getDisplayChoices(Settings settings)`
  Gets the list of choices as strings based on the current settings
  `String`
  `getName()`
  Returns the display name of this SettingsDefinition
  `String`
  `getStorageKey()`
  Get the `Settings` key which is used when storing a key/value entry.
  `String`
  `getValueString(Settings settings)`
  Get the setting value as a string which corresponds to this definition.
  `boolean`
  `hasValue(Settings setting)`
  Determine if a setting value has been stored
  `void`
  `setChoice(Settings settings, int value)`
  Sets the given value into the settings object using this definition as a key

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

  ### Methods inherited from interface ghidra.docking.settings.EnumSettingsDefinition

  `hasSameValue`

- ## Field Details

  - ### DEF

    public static final ByteCountSettingsDefinition DEF

  - ### DEFAULT

    public static final int DEFAULT
    See Also:
      - Constant Field Values

  - ### MAX_BYTE_COUNT

    public static final int MAX_BYTE_COUNT
    See Also:
      - Constant Field Values

- ## Method Details

  - ### getChoice

    public int getChoice(Settings settings)
    Description copied from interface: `EnumSettingsDefinition`
    Returns the current value for this settings
    Specified by:
      `getChoice` in interface `EnumSettingsDefinition`
    Parameters:
      `settings` - The settings to search
    Returns:
      the value for the settingsDefintions

  - ### getValueString

    public String getValueString(Settings settings)
    Description copied from interface: `SettingsDefinition`
    Get the setting value as a string which corresponds to this definition. A default value string will be returned if a setting has not been stored.
    Specified by:
      `getValueString` in interface `SettingsDefinition`
    Parameters:
      `settings` - settings
    Returns:
      value string or null if not set and default has not specified by this definition

  - ### setChoice

    public void setChoice(Settings settings, int value)
    Description copied from interface: `EnumSettingsDefinition`
    Sets the given value into the settings object using this definition as a key
    Specified by:
      `setChoice` in interface `EnumSettingsDefinition`
    Parameters:
      `settings` - the settings to store the value.
      `value` - the settings value to be stored.

  - ### getDisplayChoices

    public String[] getDisplayChoices(Settings settings)
    Description copied from interface: `EnumSettingsDefinition`
    Gets the list of choices as strings based on the current settings
    Specified by:
      `getDisplayChoices` in interface `EnumSettingsDefinition`
    Parameters:
      `settings` - the instance settings
    Returns:
      an array of strings which represent valid choices based on the current settings.

  - ### getName

    public String getName()
    Description copied from interface: `SettingsDefinition`
    Returns the display name of this SettingsDefinition
    Specified by:
      `getName` in interface `SettingsDefinition`
    Returns:
      display name for setting

  - ### getStorageKey

    public String getStorageKey()
    Description copied from interface: `SettingsDefinition`
    Get the `Settings` key which is used when storing a key/value entry.
    Specified by:
      `getStorageKey` in interface `SettingsDefinition`
    Returns:
      settings storage key

  - ### getDescription

    public String getDescription()
    Description copied from interface: `SettingsDefinition`
    Returns a description of this settings definition
    Specified by:
      `getDescription` in interface `SettingsDefinition`
    Returns:
      setting description

  - ### getDisplayChoice

    public String getDisplayChoice(int value, Settings s1)
    Description copied from interface: `EnumSettingsDefinition`
    Returns the String for the given enum value
    Specified by:
      `getDisplayChoice` in interface `EnumSettingsDefinition`
    Parameters:
      `value` - the value to get a display string for
      `s1` - the instance settings which may affect the results
    Returns:
      the display string for the given settings.

  - ### clear

    public void clear(Settings settings)
    Description copied from interface: `SettingsDefinition`
    Removes any values in the given settings object assocated with this settings definition
    Specified by:
      `clear` in interface `SettingsDefinition`
    Parameters:
      `settings` - the settings object to be cleared.

  - ### copySetting

    public void copySetting(Settings settings, Settings destSettings)
    Description copied from interface: `SettingsDefinition`
    Copies any setting value associated with this settings definition from the srcSettings settings to the destSettings.
    Specified by:
      `copySetting` in interface `SettingsDefinition`
    Parameters:
      `settings` - the settings to be copied
      `destSettings` - the settings to be updated.

  - ### hasValue

    public boolean hasValue(Settings setting)
    Description copied from interface: `SettingsDefinition`
    Determine if a setting value has been stored
    Specified by:
      `hasValue` in interface `SettingsDefinition`
    Parameters:
      `setting` - stored settings
    Returns:
      true if a value has been stored, else false