Class FileArgument

All Implemented Interfaces:
java.io.Serializable, javax.swing.ListModel

public class FileArgument
extends Argument
Represents an argument that expects a file path.
See Also:
Serialized Form
  • Constructor Details

    • FileArgument

      public FileArgument​(ArgumentDescription argDescr, java.lang.Boolean optional, java.lang.Object defaultValue, java.lang.Boolean advanced, java.lang.Integer displayWidth, java.lang.String filterFileSuffixes)
      Constructor.
      Parameters:
      argDescr - argument description
      optional - true if argument is optional, otherwise false
      defaultValue - default value
      advanced - true if an advanced argument (displayed in advanced section), otherwise false
      displayWidth - the width of the argument when displayed
      filterFileSuffixes - the file suffixes to use when filtering files to select
    • FileArgument

      public FileArgument​(FileArgument arg)
      Constructor that copies the input file argument.
      Parameters:
      arg - the file argument to copy
  • Method Details

    • copyArgument

      public FileArgument copyArgument()
      Description copied from class: Argument
      Make a copy of the argument.
      Specified by:
      copyArgument in class Argument
      Returns:
      the argument copy
    • getFileFilterComponents

      public java.lang.String[] getFileFilterComponents()
      Get components for file filters (for example ['*.txt', '*.gor']).
      Returns:
      array of file filter components