com.ibm.as400.vaccess
Class IFSFileDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--com.ibm.as400.vaccess.IFSFileDialog
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class IFSFileDialog
extends java.awt.Dialog

The IFSFileDialog class represents a file dialog for the IFS file classes. This dialog allows the user to traverse the file system and select a file. The text on the Cancel button and the OK button can be set by the calling application. A filter list can be provided by the caller. This dialog is designed to emulate the Windows file dialog. Usage:

      AS400 sys = new AS400("system1");
      IFSFileDialog fd = new IFSFileDialog(this, "File Open", sys);
      FileFilter[] filterList = {new FileFilter("All files (*.*)", "*.*"),
                                 new FileFilter("Executables (*.exe)", "*.exe"),
                                 new FileFilter("HTML files (*.html)", "*.html"),
                                 new FileFilter("HTML files (*.htm)", "*.htm"),
                                 new FileFilter("Images (*.gif)", "*.gif"),
                                 new FileFilter("Text files (*.txt)", "*.txt")};
      fd.setFileFilter(filterList, 2);
      if (fd.show() == IFSFileDialog.OK)
      {
         String s = fd.getFileName();        // get file name
         String p = fd.getPath();            // get path
         String a = fd.getAbsolutePath();    // get fully qualified file
      }
 

See Also:
Serialized Form

Inner classes inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
Inner classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
Field Summary
static int ACTIVE
          Dialog still active.
static int CANCEL
          Dialog was dismissed with the Cancel button.
static int OK
          Dialog was dismissed with the Ok button.
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
IFSFileDialog(java.awt.Frame parent, java.lang.String title, AS400 system)
          Constructs an IFSFileDialog object.
 
Method Summary
protected  void add(java.awt.Component component, java.awt.GridBagLayout layout, java.awt.GridBagConstraints constraints, int x, int y, int width, int height)
          This methods adds a user interface component to the specified GridBagLayout manager using the specified constraints.
 java.lang.String getAbsolutePath()
          Returns the absolute path for the file that was selected.
 java.lang.String getCancelButtonText()
          Returns the text for the Cancel button.
 java.lang.String getDirectory()
          Returns the path for the file selected.
 FileFilter getFileFilter()
          Returns the filter that was selected.
 java.lang.String getFileName()
          Returns the selected file name.
 java.lang.String getOkButtonText()
          Returns the text for the Ok button.
 AS400 getSystem()
          Returns the system for this dialog.
 void setCancelButtonText(java.lang.String buttonText)
          Sets the text for the Cancel button.
 void setDirectory(java.lang.String path)
          Sets the path to be used.
 void setFileFilter(FileFilter[] filterList, int defaultFilter)
          Sets the filter list.
 void setFileName(java.lang.String filename)
          Sets the file name field.
 void setOkButtonText(java.lang.String buttonText)
          Sets the button text for the Ok button.
 void setVisible()
          Shows the dialog.
 int showDialog()
          Shows the dialog and returns the current state.
 
Methods inherited from class java.awt.Dialog
addNotify, dispose, getAccessibleContext, getTitle, hide, isModal, isResizable, paramString, setModal, setResizable, setTitle, show
 
Methods inherited from class java.awt.Window
addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, processWindowEvent, removeWindowListener, setCursor, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFont, setLayout, update, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ACTIVE

public static final int ACTIVE
Dialog still active.

OK

public static final int OK
Dialog was dismissed with the Ok button.

CANCEL

public static final int CANCEL
Dialog was dismissed with the Cancel button.
Constructor Detail

IFSFileDialog

public IFSFileDialog(java.awt.Frame parent,
                     java.lang.String title,
                     AS400 system)
Constructs an IFSFileDialog object.
Parameters:
parent - The parent.
title - The title of the dialog.
system - The AS/400 system.
Method Detail

add

protected void add(java.awt.Component component,
                   java.awt.GridBagLayout layout,
                   java.awt.GridBagConstraints constraints,
                   int x,
                   int y,
                   int width,
                   int height)
This methods adds a user interface component to the specified GridBagLayout manager using the specified constraints.
Parameters:
component - the user interface component to add
layout - the GridBagLayout manager
constraints - the constraints for the component
x - the x coordinate of the leftmost cell of the component
y - the y coordinate of the topmost cell of the component
width - the horizontal measurement of the component in cells
height - the vertical measurement of the component in cells
Returns:
none

getAbsolutePath

public java.lang.String getAbsolutePath()
Returns the absolute path for the file that was selected.
Returns:
The fully qualified path, including the file name.

getCancelButtonText

public java.lang.String getCancelButtonText()
Returns the text for the Cancel button.
Returns:
The text for the Cancel button.

getFileName

public java.lang.String getFileName()
Returns the selected file name.
Returns:
The file name.

getFileFilter

public FileFilter getFileFilter()
Returns the filter that was selected.
Returns:
The file filter that was selected.

getOkButtonText

public java.lang.String getOkButtonText()
Returns the text for the Ok button.
Returns:
The text for the Ok button.

getDirectory

public java.lang.String getDirectory()
Returns the path for the file selected. The file name is not part of the path.
Returns:
The path for the selected file.

getSystem

public AS400 getSystem()
Returns the system for this dialog.
Returns:
The object that represents the system.

setCancelButtonText

public void setCancelButtonText(java.lang.String buttonText)
Sets the text for the Cancel button.
Parameters:
buttonText - The text to use for the Cancel button.

setFileName

public void setFileName(java.lang.String filename)
Sets the file name field.
Parameters:
filename - The name of the file.

setFileFilter

public void setFileFilter(FileFilter[] filterList,
                          int defaultFilter)
Sets the filter list.
Parameters:
filterList - The list of filters to be listed in the choice control.
defaultFilter - The index into the list that is to be used as the default (zero-based).

setOkButtonText

public void setOkButtonText(java.lang.String buttonText)
Sets the button text for the Ok button.
Parameters:
buttonText - The text to use for the Ok button.

setDirectory

public void setDirectory(java.lang.String path)
Sets the path to be used.
Parameters:
path - The path to use.

setVisible

public void setVisible()
Shows the dialog.

showDialog

public int showDialog()
Shows the dialog and returns the current state.
Returns:
The current state of the dialog.