amber.server.panel
Class FileDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--amber.server.component.ComponentHandler
              |
              +--amber.server.component.PanelHandler
                    |
                    +--amber.server.panel.BasePanel
                          |
                          +--amber.server.panel.BaseFrame
                                |
                                +--amber.server.panel.ModalBaseFrame
                                      |
                                      +--amber.server.panel.FileDialog

All Implemented Interfaces:

java.awt.event.ActionListener, ApplicationInterface, java.awt.event.ComponentListener, ComponentWindowListener, ContainerHandler, java.util.EventListener, java.awt.image.ImageObserver, java.awt.event.ItemListener, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable

public class FileDialog

extends ModalBaseFrame

implements java.io.Serializable, java.awt.event.ActionListener, ComponentWindowListener, java.awt.event.ItemListener, java.awt.event.ComponentListener

This class allows a user to browse the file system. It allows the user to specify files for saving and opening. As there are major similarities between the two they are encapsulated in the one object.

See Also:

BaseFrame, Serialized Form

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

Field Summary

static int	BaseHeight The starting height of this dialog.
static int	BaseWidth The starting width of this dialog.
static java.lang.String	DefaultOpenTitle This is the default title for the dialog.
static java.lang.String	DefaultSaveTitle This is the default title for the dialog.
static long	FileDialogTimeout This constant defines how long the dialog will wait for the remote user.
static int	LOAD This constant defines the role the dialog will perform.
static int	SAVE This constant defines the role the dialog will perform.

Fields inherited from class amber.server.panel.BaseFrame

title

Fields inherited from class amber.server.panel.BasePanel

autoDoLayoutState, xOffset, yOffset

Fields inherited from class amber.server.component.PanelHandler

AddOperation, autoRedrawState, drawOperations, InsertOperation, PaintPanel, PanelNextAvailableCommand, postInPacketListeners, preInPacketListeners, RemoveAllOperations, RemoveOperation, ReplaceOperation, SetBorder, SetReDraw

Fields inherited from class amber.server.component.ComponentHandler

actionCommand, active, ApplicationId, CancelReturn, dataEncoder, DefaultTimeout, enabledState, encoderBytes, id, InvalidId, MaximumId, NoReturn, OkCancelType, OkReturn, OkType, OkYesReturn, parentPage, responsePackets, timeoutValue, UnchangeableInvalidId, visibleState, YesNoCancelType, YesNoType, YesReturn

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface amber.server.panel.ContainerHandler

AddComponent, AutoDoLayout, ForceDoLayout, GetInsets, GetInsetsResponse, NextAvailableCommand, RemoveAllComponents, RemoveComponent, SetBounds

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

FileDialog()
Default constructor.

FileDialog(ApplicationInterface appHandler)
The initialising constructor.

FileDialog(ApplicationInterface appHandler, java.lang.String title)
The initialising constructor.

FileDialog(ApplicationInterface appHandler, java.lang.String title, int role)
The initialising constructor.

FileDialog(int id, ApplicationInterface appHandler, java.lang.String title, int role)
The initialising constructor.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
boolean	canClose() This function determines if the panel can be closed.
void	componentHidden(java.awt.event.ComponentEvent e)
void	componentMoved(java.awt.event.ComponentEvent e)
void	componentResized(java.awt.event.ComponentEvent e)
void	componentShown(java.awt.event.ComponentEvent e)
protected void	defineComponents() This function is called to define the components which are a part of this template.
void	fillControls() This function should be called at the end of recreatePanel.
protected void	fillLists(amber.server.panel.TreeNode parent) Fills the tree and list with information from the current directory.
protected amber.server.panel.TreeNode	findCurrentDirectoryTreeNode()
java.io.File	getBaseDirectory() This returns the base directory for this filter.
java.lang.String	getDirectory() Gets the directory of this file dialog.
java.lang.String	getFile() Gets the selected file of this file dialog.
FileFilter	getFileFilter() Determines this file dialog's extended filename filter.
java.io.FilenameFilter	getFilenameFilter() Determines this file dialog's filename filter.
int	getMode() Indicates whether this file dialog box is for loading from a file or for saving to a file.
boolean	isCancelPressed() Once the dialog returns from the show function this function indicates whether the Cancel button was pressed.
boolean	isOkPressed() Once the dialog returns from the show function this function indicates whether the OK button was pressed.
void	itemStateChanged(java.awt.event.ItemEvent e)
protected void	reSizeDialog(int width, int height) This dialog resizes all the internal components to match the new size.
void	saveData() This function is called to save any required information in the panel.
protected amber.server.panel.TreeNode	selectByDirectory()
void	setBaseDirectory(java.io.File directory) This sets the base directory for this dialog.
void	setBaseDirectory(java.lang.String directory) This sets the base directory for this dialog.
protected amber.server.panel.TreeNode	setBaseDirectoryTree() Recurses from the current directory to the base directory if exists or the top of the file system if not.
void	setDirectory(java.io.File dir) Sets the directory of this file dialog window to be the specified directory.
void	setDirectory(java.lang.String dir) Sets the directory of this file dialog window to be the specified directory.
void	setFile(java.lang.String file) Sets the selected file for this file dialog window to be the specified file.
void	setFileFilter(FileFilter filter) Sets the extended filename filter which contains the concept of multiple filters which can be selected by the user.
void	setFilenameFilter(java.io.FilenameFilter filter) Sets the filename filter for this file dialog window to the specified filter.
void	setMode(int mode) Sets the mode of the file dialog.
void	setVisible(boolean state) This function is required for the internal processing of the dialog.
void	windowActivated(ComponentWindowEvent e) This is called when a window is activated.
void	windowClosed(ComponentWindowEvent e) This is called when a window has been closed.
void	windowClosing(ComponentWindowEvent e) This is called when the window is in the process of being closed.
void	windowDeactivated(ComponentWindowEvent e) This is called when a window is de-activated.
void	windowDeiconified(ComponentWindowEvent e) This is called when a window is de-iconified.
void	windowIconified(ComponentWindowEvent e) This is called when a window is iconified.
void	windowOpened(ComponentWindowEvent e) This function is invoked when a window has been opened.

Methods inherited from class amber.server.panel.ModalBaseFrame

show

Methods inherited from class amber.server.panel.BaseFrame

getPanelType, getTitle, isVisible, setActive, setBounds, setBounds, setInternalBounds, setInternalBounds, setInternalLocation, setInternalLocation, setInternalSize, setInternalSize, setLocation, setLocation, setSize, setSize, setTitle, toBack, toFront

Methods inherited from class amber.server.panel.BasePanel

add, addComponent, addInPostPacketListener, addInPrePacketListener, buildComponent, buildComponent, doPanelLayout, fireInPostPacketPerformed, fireInPrePacketPerformed, forwardPacket, getAutoDoLayout, getComponents, getComponentStructure, getInsets, getPanelComponent, getPanelComponentAt, getPanelComponentAt, getPanelComponentAt, getPanelComponentAt, getPanelGroup, isMyId, isSelected, matchComponentToControl, matchIdToControl, processCurrentPacket, recreatePanel, remove, removeComponent, removeInPostPacketListener, removeInPrePacketListener, setAutoDoLayout, setBounds, setBounds, setComponentBaseOffset, setLocation, setLocation, setPanelGroup, setPanelLocation, setPanelLocation, setSelected, setSelectedInternal, setSize, setSize, setUpComponent

Methods inherited from class amber.server.component.PanelHandler

addComponent, addComponent, addDraw3DRect, addDrawArc, addDrawImage, addDrawImage, addDrawLine, addDrawOval, addDrawPolygon, addDrawPolyline, addDrawRect, addDrawRoundRect, addDrawString, addDrawString, addFill3DRect, addFillArc, addFillOval, addFillPolygon, addFillRect, addFillRoundRect, addOperation, addSetClip, addSetColour, addSetFont, addSetPaintMode, addSetXORMode, getDrawOperations, handleToIndex, insertDraw3DRect, insertDrawArc, insertDrawImage, insertDrawImage, insertDrawLine, insertDrawPolygon, insertDrawPolyline, insertDrawRect, insertDrawRoundRect, insertDrawString, insertDrawString, insertFill3DRect, insertFill3DRect, insertFillArc, insertFillOval, insertFillPolygon, insertFillRect, insertFillRoundRect, insertOperation, insertSetClip, insertSetColour, insertSetFont, insertSetPaintMode, insertSetXORMode, performSetBounds, performSetLocation, performSetSize, removeAllComponents, removeAllDrawOperations, removeDrawOperation, repaintPanel, replaceDraw3DRect, replaceDrawArc, replaceDrawImage, replaceDrawImage, replaceDrawLine, replaceDrawPolygon, replaceDrawPolyline, replaceDrawRect, replaceDrawRoundRect, replaceDrawString, replaceDrawString, replaceFill3DRect, replaceFill3DRect, replaceFillArc, replaceFillOval, replaceFillPolygon, replaceFillRect, replaceFillRoundRect, replaceOperation, replaceSetClip, replaceSetColour, replaceSetFont, replaceSetPaintMode, replaceSetXORMode, resetState, setAutoRepaint, setBorder

Methods inherited from class amber.server.component.ComponentHandler

addActionListener, addComponentListener, addEventMask, addFocusListener, addItemListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addReceivedPacket, addTextListener, addWindowListener, booleanToInt, createDataInput, directPacket, displayMessageBox, fireWindowActivated, fireWindowClosed, fireWindowClosing, fireWindowDeactivated, fireWindowDeiconified, fireWindowEvent, fireWindowIconified, fireWindowOpened, forceComponentGetUrl, forceComponentGetUrl, forwardEventPacket, generateActionEvent, generateFocusEvent, generateItemEvent, generateKeyEvent, generateMouseEvent, getActionCommand, getBounds, getDefaultParameters, getEventMask, getFontCharacteristics, getFontCharacteristics, getFontCharacteristics, getFontCharacteristics, getFontStyle, getId, getLocation, getLog, getModalObject, getParentApplication, getParentContainer, getParentServer, getResponsePacket, getSelectedObjects, getSize, getTimeout, getValidId, getX, getY, handleMessages, handlePacket, internalForwardPacket, internalGetBounds, intToBoolean, isActive, isApplicationActive, isComponentModal, isConnected, isEnabled, processActionEvent, processComponentEvent, processEvent, processFocusEvent, processItemEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processNormalResponse, processTextEvent, queryMessageBox, removeActionListener, removeComponentListener, removeEventMask, removeFocusListener, removeItemListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removeTextListener, removeWindowListener, requestFocus, restart, sendPacket, sendPacketAndBlock, sendPendingPackets, setActionCommand, setBackground, setComponentModal, setConnectedState, setCursor, setEnabled, setEventMask, setFont, setFont, setFontStyle, setForeground, setForegroundBackground, setId, setLog, setModalObject, setParentApplication, setParentContainer, setParentServer, setTimeout, setX, setY, shutDown, shutDownClient, shutDownClient, start

Methods inherited from class java.awt.Component

action, add, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getInputContext, getInputMethodRequests, getListeners, getLocale, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getToolkit, getTreeLock, getWidth, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, remove, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, reshape, resize, resize, setComponentOrientation, setDropTarget, setLocale, setName, show, size, toString, transferFocus, update, validate

Methods inherited from class java.lang.Object

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

Field Detail

LOAD

public static final int LOAD

This constant defines the role the dialog will perform. In this case the dialog acts as a File open dialog.

SAVE

public static final int SAVE

This constant defines the role the dialog will perform. In this case the dialog acts as a File save dialog.

FileDialogTimeout

public static final long FileDialogTimeout

This constant defines how long the dialog will wait for the remote user. In this case 1,000 seconds

BaseWidth

public static final int BaseWidth

The starting width of this dialog.

BaseHeight

public static final int BaseHeight

The starting height of this dialog.

DefaultOpenTitle

public static final java.lang.String DefaultOpenTitle

This is the default title for the dialog.

DefaultSaveTitle

public static final java.lang.String DefaultSaveTitle

This is the default title for the dialog.

Constructor Detail

FileDialog

public FileDialog()

Default constructor.

FileDialog

public FileDialog(ApplicationInterface appHandler)

The initialising constructor.

Parameters:

appHandler - The handle to the main ApplicationInterface which handles the functions of page overall.

FileDialog

public FileDialog(ApplicationInterface appHandler,
                  java.lang.String title)

The initialising constructor.

Parameters:

appHandler - The handle to the main ApplicationInterface which handles the functions of page overall.

title - String title of the window.

FileDialog

public FileDialog(ApplicationInterface appHandler,
                  java.lang.String title,
                  int role)

The initialising constructor.

Parameters:

appHandler - The handle to the main ApplicationInterface which handles the functions of page overall.

title - String title of the window.

role - int containing the role the dialog will perform.

FileDialog

public FileDialog(int id,
                  ApplicationInterface appHandler,
                  java.lang.String title,
                  int role)

The initialising constructor.

Parameters:

id - The ID of the corresponding remote frame control.

appHandler - The handle to the main ApplicationInterface which handles the functions of page overall.

title - String title of the window.

role - int containing the role the dialog will perform.

Method Detail

fillControls

public void fillControls()

This function should be called at the end of recreatePanel. Its specific purpose is to set the controls to a known state once they are created.

Overrides:

fillControls in class ModalBaseFrame

Following copied from interface: amber.server.panel.ContainerHandler

See Also:

BasePanel.defineComponents()

canClose

public boolean canClose()

This function determines if the panel can be closed. The derived panels must determine if this panel can close. If this is not possible the function should return false.

Overrides:

canClose in class ModalBaseFrame

Returns:

boolean false if it is not possible to close this panel.

saveData

public void saveData()

This function is called to save any required information in the panel. This function is called externally when another panel wishes to take over the base panel or when closing the panel. This function need not actually do something.

Overrides:

saveData in class ModalBaseFrame

Following copied from interface: amber.server.panel.ContainerHandler

See Also:

PanelTemplateGroup

setVisible

public void setVisible(boolean state)

This function is required for the internal processing of the dialog. IT MUST NEVER BE CALLED DIRECTLY. Use show() instead.

Overrides:

setVisible in class BaseFrame

See Also:

ModalBaseFrame.show()

reSizeDialog

protected void reSizeDialog(int width,
                            int height)

This dialog resizes all the internal components to match the new size.

Parameters:

width - int width of the dialog.

height - int height of the dialog.

defineComponents

protected void defineComponents()

This function is called to define the components which are a part of this template. This function is called by the constructor to set up the normal static components and their location.

Overrides:

defineComponents in class ModalBaseFrame

getMode

public int getMode()

Indicates whether this file dialog box is for loading from a file or for saving to a file.

Returns:

the mode of this file dialog window.

setMode

public void setMode(int mode)

Sets the mode of the file dialog.

Parameters:

mode - the mode for this file dialog.

Throws:

java.lang.IllegalArgumentException - if an illegal file dialog mode is used.

getDirectory

public java.lang.String getDirectory()

Gets the directory of this file dialog.

Returns:

String containing the directory of this file dialog.

setDirectory

public void setDirectory(java.lang.String dir)

Sets the directory of this file dialog window to be the specified directory.

Parameters:

dir. - String directory to set.

setDirectory

public void setDirectory(java.io.File dir)

Sets the directory of this file dialog window to be the specified directory.

Parameters:

dir. - File directory to set.

getFile

public java.lang.String getFile()
                         throws java.io.IOException

Gets the selected file of this file dialog.

Returns:

String containing the currently selected file of this file dialog window, or null if none is selected.

Throws:

java.io.IOException - containing errors in the file system.

setFile

public void setFile(java.lang.String file)

Sets the selected file for this file dialog window to be the specified file. This file becomes the default file if it is set before the file dialog window is first shown.

Parameters:

file - String containing the file to set.

getFilenameFilter

public java.io.FilenameFilter getFilenameFilter()

Determines this file dialog's filename filter. A filename filter allows the user to specify which files appear in the file dialog window. This function is included for reverse compatibility with the java.awt.FileDialog. It is expected that the getFileFilter function will be used.

Returns:

FilenameFilter containing this file dialog's filename filter.

getFileFilter

public FileFilter getFileFilter()

Determines this file dialog's extended filename filter. The extended filename filter contains the concept of multiple filters which can be selected by the user.

Returns:

FileFilter containing this file dialog's filename filter.

setFilenameFilter

public void setFilenameFilter(java.io.FilenameFilter filter)

Sets the filename filter for this file dialog window to the specified filter. This function is included for reverse compatibility with the java.awt.FileDialog. It is expected that the setFileFilter function will be used.

Parameters:

filter - the specified filter.

setFileFilter

public void setFileFilter(FileFilter filter)
                   throws ComponentHandlerException

Sets the extended filename filter which contains the concept of multiple filters which can be selected by the user. This function is an extension to the functionality supported in setFilenameFilter. The FileFilter class supports multiple filters of which only one at a time is selected. The FileFilter class is created and the filters added to the internal list of filters. Each of these filters (FileFilterData) also contains a String which appears in a drop down Choice on the File Dialog.

Parameters:

filter - The FileFilter to use.

Throws:

ComponentHandlerException - containing messaging errors.

setBaseDirectory

public void setBaseDirectory(java.lang.String directory)

This sets the base directory for this dialog. ALL files higher than this directory will fail the accept function.

Parameters:

directory - String containing the base directory.

setBaseDirectory

public void setBaseDirectory(java.io.File directory)

This sets the base directory for this dialog. ALL files higher than this directory will fail the accept function.

Parameters:

directory - File containing the base directory.

getBaseDirectory

public java.io.File getBaseDirectory()

This returns the base directory for this filter. ALL files higher than this directory will fail the accept function.

Returns:

File containing the base directory.

isOkPressed

public boolean isOkPressed()

Once the dialog returns from the show function this function indicates whether the OK button was pressed. The state is undefined until show has returned.

Returns:

boolean true if the OK button was pressed.

isCancelPressed

public boolean isCancelPressed()

Once the dialog returns from the show function this function indicates whether the Cancel button was pressed. The state is undefined until show has returned.

Returns:

boolean true if the Cancel button was pressed.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

windowOpened

public void windowOpened(ComponentWindowEvent e)

Description copied from interface: ComponentWindowListener

This function is invoked when a window has been opened.

Specified by:

windowOpened in interface ComponentWindowListener

Following copied from interface: amber.awt.event.ComponentWindowListener

Parameters:

e - ComponentWindowEvent which contains information on what happened.

windowClosing

public void windowClosing(ComponentWindowEvent e)

Description copied from interface: ComponentWindowListener

This is called when the window is in the process of being closed.

Specified by:

windowClosing in interface ComponentWindowListener

Following copied from interface: amber.awt.event.ComponentWindowListener

Parameters:

e - ComponentWindowEvent which contains information on what happened.

windowClosed

public void windowClosed(ComponentWindowEvent e)

Description copied from interface: ComponentWindowListener

This is called when a window has been closed.

Specified by:

windowClosed in interface ComponentWindowListener

Following copied from interface: amber.awt.event.ComponentWindowListener

Parameters:

e - ComponentWindowEvent which contains information on what happened.

windowIconified

public void windowIconified(ComponentWindowEvent e)

Description copied from interface: ComponentWindowListener

This is called when a window is iconified.

Specified by:

windowIconified in interface ComponentWindowListener

Following copied from interface: amber.awt.event.ComponentWindowListener

Parameters:

e - ComponentWindowEvent which contains information on what happened.

windowDeiconified

public void windowDeiconified(ComponentWindowEvent e)

Description copied from interface: ComponentWindowListener

This is called when a window is de-iconified.

Specified by:

windowDeiconified in interface ComponentWindowListener

Following copied from interface: amber.awt.event.ComponentWindowListener

Parameters:

e - ComponentWindowEvent which contains information on what happened.

windowActivated

public void windowActivated(ComponentWindowEvent e)

Description copied from interface: ComponentWindowListener

This is called when a window is activated.

Specified by:

windowActivated in interface ComponentWindowListener

Following copied from interface: amber.awt.event.ComponentWindowListener

Parameters:

e - ComponentWindowEvent which contains information on what happened.

windowDeactivated

public void windowDeactivated(ComponentWindowEvent e)

Description copied from interface: ComponentWindowListener

This is called when a window is de-activated.

Specified by:

windowDeactivated in interface ComponentWindowListener

Following copied from interface: amber.awt.event.ComponentWindowListener

Parameters:

e - ComponentWindowEvent which contains information on what happened.

fillLists

protected void fillLists(amber.server.panel.TreeNode parent)
                  throws java.io.IOException,
                         ComponentHandlerException

Fills the tree and list with information from the current directory.

Parameters:

parent - TreeNode parent which will contain the new directories.

Throws:

java.io.IOException - containing file based errors.

ComponentHandlerException - containing amber messaging errors.

setBaseDirectoryTree

protected amber.server.panel.TreeNode setBaseDirectoryTree()
                                                    throws java.io.IOException,
                                                           ComponentHandlerException

Recurses from the current directory to the base directory if exists or the top of the file system if not. It uses this information to fill the directory tree with the directories.

Returns:

TreeNode which corresponds to the current directory.

Throws:

java.io.IOException - containing file based errors.

ComponentHandlerException - containing amber messaging errors.

selectByDirectory

protected amber.server.panel.TreeNode selectByDirectory()

findCurrentDirectoryTreeNode

protected amber.server.panel.TreeNode findCurrentDirectoryTreeNode()

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

componentResized

public void componentResized(java.awt.event.ComponentEvent e)

Specified by:

componentResized in interface java.awt.event.ComponentListener

componentMoved

public void componentMoved(java.awt.event.ComponentEvent e)

Specified by:

componentMoved in interface java.awt.event.ComponentListener

componentShown

public void componentShown(java.awt.event.ComponentEvent e)

Specified by:

componentShown in interface java.awt.event.ComponentListener

componentHidden

public void componentHidden(java.awt.event.ComponentEvent e)

Specified by:

componentHidden in interface java.awt.event.ComponentListener