Class FileDialogRequest<T extends FileDialogRequest<T>>

java.lang.Object
com.codename1.io.filechooser.FileDialogRequest<T>
Direct Known Subclasses:
OpenFileRequest, SaveFileRequest
public abstract class FileDialogRequest<T extends FileDialogRequest<T>> extends Object

The settings shared by OpenFileRequest and SaveFileRequest.

Every setter returns the request, so a dialog is described in one chain. Settings a platform cannot honour are ignored rather than failing, and com.codename1.ui.Display#isFileDialogFeatureSupported(int) says up front which ones apply. Platform specific tuning goes through #hint(String, Object).

Parameters
  • <T>: the concrete request type, so chained setters keep it

  • Field Details

    • HINT_MAC_SHOWS_TAG_FIELD

      public static final String HINT_MAC_SHOWS_TAG_FIELD
      Boolean: show the Finder tag field in a macOS save panel.
      See Also:

    • HINT_MAC_CAN_CREATE_DIRECTORIES

      public static final String HINT_MAC_CAN_CREATE_DIRECTORIES
      Boolean: allow creating folders from a macOS panel. Defaults to true.
      See Also:

    • HINT_MAC_SHOWS_HIDDEN_FILES

      public static final String HINT_MAC_SHOWS_HIDDEN_FILES
      Boolean: show hidden files in a macOS panel.
      See Also:

    • HINT_MAC_CAN_SELECT_HIDDEN_EXTENSION

      public static final String HINT_MAC_CAN_SELECT_HIDDEN_EXTENSION
      Boolean: let the user hide the extension in a macOS save panel.
      See Also:

    • HINT_MAC_TREATS_PACKAGES_AS_DIRECTORIES

      public static final String HINT_MAC_TREATS_PACKAGES_AS_DIRECTORIES
      Boolean: treat packages (.app, .bundle) as folders in a macOS open panel.
      See Also:

    • HINT_IOS_SHOWS_FILE_EXTENSIONS

      public static final String HINT_IOS_SHOWS_FILE_EXTENSIONS
      Boolean: show file extensions in the iOS document picker.
      See Also:

    • HINT_IOS_EXPORT_AS_MOVE

      public static final String HINT_IOS_EXPORT_AS_MOVE
      Boolean: move rather than copy the exported file on iOS. Defaults to copy.
      See Also:

    • HINT_ANDROID_INITIAL_URI

      public static final String HINT_ANDROID_INITIAL_URI
      String: a content:// URI the Android picker starts in.
      See Also:

    • HINT_ANDROID_PERSIST_PERMISSION

      public static final String HINT_ANDROID_PERSIST_PERMISSION
      Boolean: keep persistable read/write permission to the picked Android document across restarts.
      See Also:

    • HINT_WIN_CLIENT_GUID

      public static final String HINT_WIN_CLIENT_GUID
      String: a GUID string; Windows remembers the last folder and size separately per GUID, so different dialogs of one app do not share state.
      See Also:

    • HINT_WIN_DEFAULT_FOLDER

      public static final String HINT_WIN_DEFAULT_FOLDER
      String: the folder Windows shows when the user has no recent folder, as opposed to FileDialogRequest#initialDirectory, which always wins.
      See Also:

    • HINT_DESKTOP_SHOW_HIDDEN

      public static final String HINT_DESKTOP_SHOW_HIDDEN
      Boolean: show hidden files in the GTK chooser and the simulator.
      See Also:

  • Method Details

    • title

      public T title(String title)

      Sets the window title. Ignored by the mobile pickers.

      Parameters
      • title: the title
      Returns

      this request

    • message

      public T message(String message)

      Sets an explanatory line shown in the dialog (NSSavePanel.message on macOS, the fallback dialog's header elsewhere).

      Parameters
      • message: the text
      Returns

      this request

    • acceptLabel

      public T acceptLabel(String label)

      Replaces the text of the Open or Save button on desktops.

      Parameters
      • label: the button text
      Returns

      this request

    • initialDirectory

      public T initialDirectory(String path)

      Sets the folder the dialog starts in, as a FileSystemStorage path.

      Parameters
      • path: the folder
      Returns

      this request

    • addFilter

      public T addFilter(FileTypeFilter filter)

      Adds a file type filter. The first one added is selected unless #selectedFilter(int) says otherwise.

      Parameters
      • filter: the filter
      Returns

      this request

    • selectedFilter

      public T selectedFilter(int index)

      Selects the filter shown initially.

      Parameters
      • index: an index into the filters added so far
      Returns

      this request

    • hint

      public T hint(String key, Object value)

      Sets a platform specific hint; see the HINT_ constants. Unknown hints are ignored.

      Parameters
      • key: the hint name
      • value: its value
      Returns

      this request

    • addOption

      public T addOption(FileDialogOption option)

      Adds a portable control to the dialog; see FileDialogOption.

      Parameters
      • option: the control
      Returns

      this request

    • accessory

      public T accessory(Component accessory)

      Embeds a Codename One component in the dialog, such as a format and quality panel for an export. Only shown where FileDialogFeatures#ACCESSORY_COMPONENT is supported (today only the Codename One fallback save form); use #addOption(FileDialogOption) for controls that must appear on every desktop. The component is still reachable from the callback, so its state can be read after the dialog closes.

      Parameters
      • accessory: the component
      Returns

      this request

    • getTitle

      public String getTitle()

      The window title, or null.

      Returns

      the title

    • getMessage

      public String getMessage()

      The explanatory message, or null.

      Returns

      the message

    • getAcceptLabel

      public String getAcceptLabel()

      The accept button text, or null for the platform default.

      Returns

      the label

    • getInitialDirectory

      public String getInitialDirectory()

      The starting folder, or null.

      Returns

      the folder path

    • getFilters

      public FileTypeFilter[] getFilters()

      The filters in the order they were added.

      Returns

      a copy of the filters

    • getSelectedFilter

      public int getSelectedFilter()

      The initially selected filter index, clamped to the filters present.

      Returns

      the index, or -1 when there are no filters

    • getHint

      public Object getHint(String key)

      Reads a hint.

      Parameters
      • key: the hint name
      Returns

      the value, or null

    • getBooleanHint

      public boolean getBooleanHint(String key, boolean def)

      Reads a boolean hint.

      Parameters
      • key: the hint name
      • def: the value when the hint is absent or not a boolean
      Returns

      the value

    • getStringHint

      public String getStringHint(String key)

      Reads a string hint.

      Parameters
      • key: the hint name
      Returns

      the value as a string, or null

    • getOptions

      public FileDialogOption[] getOptions()

      The portable controls in the order they were added.

      Returns

      a copy of the options

    • getAccessory

      public Component getAccessory()

      The accessory component, or null.

      Returns

      the accessory

    • toAcceptString

      public String toAcceptString()

      Joins every filter's extensions and MIME types into the comma separated form com.codename1.ui.Display#openFileChooser takes.

      Returns

      the accept string, or null when nothing is filtered