Class DomainFolderOption


public class DomainFolderOption extends StringOption
An Option used to specify a DomainFolder
  • Constructor Details

    • DomainFolderOption

      public DomainFolderOption(String name, String value, String arg, String group, String stateKey, boolean hidden, String description)
      Creates a new DomainFolderOption
      Parameters:
      name - the name of the option
      value - the value of the option
      arg - the option's command line argument
      group - the name for group of options
      stateKey - the state key name
      hidden - true if this option should be hidden from the user; otherwise, false
      description - a description of the option
  • Method Details

    • getCustomEditorComponent

      public Component getCustomEditorComponent(AddressFactoryService addressFactoryService)
      Description copied from class: Option
      Override if you want to provide a custom widget for selecting your options.

      Important! If you override this you MUST also override the Option.copy() method so it returns a new instance of your custom editor.

      Overrides:
      getCustomEditorComponent in class StringOption
      Parameters:
      addressFactoryService - The AddressFactoryService
      Returns:
      the custom editor Component, or null if there isn't one
    • copy

      public DomainFolderOption copy()
      Description copied from class: Option
      Returns a copy of this Option object.

      NOTE: Option subclasses should always overwrite this method so they can return their exact type, instead of the more generic Option type.

      NOTE: When the deprecated constructors of this class get removed, this method should become abstract.

      Overrides:
      copy in class StringOption
      Returns:
      a copy of this Option object