maspack.widgets

Class FileNameField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

maspack.widgets.LabeledComponentBase

maspack.widgets.LabeledComponent

maspack.widgets.LabeledControl

maspack.widgets.LabeledTextField

maspack.widgets.StringField

maspack.widgets.FileNameField

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, HasProperties, Disposable, HasAlignableLabels, LabeledWidget

public class FileNameField
extends StringField

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class maspack.widgets.LabeledTextField

MAX_COLUMNS, myProps

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

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

Constructors

Constructor and Description
FileNameField(java.lang.String labelText, java.io.File file, int ncols) Creates a FileNameField with specified label text and initial value.
FileNameField(java.lang.String labelText, int ncols) Creates a FileNameField with specified label text and an empty file name.
FileNameField(java.lang.String labelText, java.lang.String initialValue, int ncols) Creates a FileNameField with specified label text and initial value.

Method Summary

Modifier and Type	Method and Description
javax.swing.JButton	getBrowseButton() Returns the JButton used to initiate file browsing on this control.
java.io.File	getChooserDirectory()
java.io.File	getFile() Returns the file associated with this widget's value, or null if no file is selected.
javax.swing.JFileChooser	getFileChooser() Returns the JFileChooser associated with this control.
boolean	getFileMustBeReadable()
boolean	getFileMustExist()
FileSearchPath	getSearchPath()
void	setChooserDirectory(java.io.File file)
void	setFile(java.io.File file) Sets the file associated with this widget's value.
void	setFileMustBeReadable(boolean enable)
void	setFileMustExist(boolean enable)
void	setSearchPath(FileSearchPath path) Sets a search path to use for finding files that don't have absolute path names.
void	setValue(java.lang.Object value) Sets a new value for this control.
java.lang.Object	validateValue(java.lang.Object value, StringHolder errMsg) Validates a specified value for this control.

Methods inherited from class maspack.widgets.StringField

getResultHolder, getStringValue, setResultHolder, valueIsEmpty

Methods inherited from class maspack.widgets.LabeledTextField

getAllPropertyInfo, getColumns, getDefaultFormat, getEnterValueOnFocusLost, getFormat, getFormatRange, getText, getTextField, lastEntryWasAccepted, setColumns, setEnterValueOnFocusLost, setFormat, setFormat

Methods inherited from class maspack.widgets.LabeledControl

addValueChangeListener, addValueCheckListener, clearValueChangeListeners, dispose, getGUIVoidEnabled, getNullValueEnabled, getValue, getValueChangeListeners, getValueCheckListeners, getVoidValueEnabled, isEnabledAll, maskValueChangeListeners, maskValueChecks, removeValueChangeListener, setBackgroundAll, setEnabledAll, setVoidValueEnabled, valueChangeListenersMasked, valueChecksMasked, valueIsNull, valueIsVoid

Methods inherited from class maspack.widgets.LabeledComponent

actionPerformed, addMajorComponent, addMajorComponent, getActions, getLabel, getLabelSpacing, getMainComponent, getMajorComponent, getMaximumSize, getMinimumSize, getPreferredLabelSpacing, getSpacing, indexOfMajor, isLabelStretchable, isStretchable, numMajorComponents, removeMajorComponent, setLabelSpacing, setLabelStretchable, setLabelText, setSpacing, setStretchable

Methods inherited from class maspack.widgets.LabeledComponentBase

getBackgroundColor, getLabelFontColor, getLabelText, getLeftInset, getProperty, isScanning, isSelected, setBackgroundColor, setLabelFontColor, setLabelFontColor, setScanning, setSelected

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface maspack.widgets.LabeledWidget

getToolTipText, setToolTipText

Constructor Detail

FileNameField

public FileNameField(java.lang.String labelText,
                     int ncols)

Creates a FileNameField with specified label text and an empty file name.

Parameters:

labelText - text for the control label

ncols - approximate width of the text field in columns

FileNameField

public FileNameField(java.lang.String labelText,
                     java.lang.String initialValue,
                     int ncols)

Creates a FileNameField with specified label text and initial value.

Parameters:

labelText - text for the control label

initialValue - initial value for the file name

ncols - approximate width of the text field in columns

FileNameField

public FileNameField(java.lang.String labelText,
                     java.io.File file,
                     int ncols)

Creates a FileNameField with specified label text and initial value.

Parameters:

labelText - text for the control label

file - initial file value

ncols - approximate width of the text field in columns

Method Detail

getSearchPath

public FileSearchPath getSearchPath()

setSearchPath

public void setSearchPath(FileSearchPath path)

Sets a search path to use for finding files that don't have absolute path names.

getFileMustBeReadable

public boolean getFileMustBeReadable()

setFileMustBeReadable

public void setFileMustBeReadable(boolean enable)

getFileMustExist

public boolean getFileMustExist()

setFileMustExist

public void setFileMustExist(boolean enable)

validateValue

public java.lang.Object validateValue(java.lang.Object value,
                                      StringHolder errMsg)

Description copied from class: LabeledControl

Validates a specified value for this control. If the value is valid, then it should be returned unchanged. If the value is invalid but can be replaced with a suitable corrected value, then that corrected value should be returned in an object different from the original value. If the value is invalid and no alternative value exists, then Property.IllegalValue should be returned. The optional variable errMsg is used to return an error message describing the problem with any invalid value. The errMsg setting is undefined for valid values.

Note in particularly that contract of this method provides that if the returned value is the same object as the supplied value, then the original value is valid. Implementations of this method may use support methods such as validateType and validateBasic

Parameters:

value - value to be tested

errMsg - optional argument for holding an error message

Returns:

the original value reference if it is valid, or a different object containing a corrected value, or Property.IllegalValue if no correction is possible.

getFileChooser

public javax.swing.JFileChooser getFileChooser()

Returns the JFileChooser associated with this control.

Returns:

file chooser for this control

getChooserDirectory

public java.io.File getChooserDirectory()

setChooserDirectory

public void setChooserDirectory(java.io.File file)

getBrowseButton

public javax.swing.JButton getBrowseButton()

Returns the JButton used to initiate file browsing on this control.

Returns:

file browsing button for this control

getFile

public java.io.File getFile()

Returns the file associated with this widget's value, or null if no file is selected.

Returns:

file associated with widget value

setFile

public void setFile(java.io.File file)

Sets the file associated with this widget's value. The value is set from the file's absolute path.

Parameters:

file - associated with widget value

setValue

public void setValue(java.lang.Object value)

Description copied from class: LabeledControl

Sets a new value for this control. This may include null or void if those values are enabled.

Overrides:

setValue in class LabeledControl

Parameters:

value - new value for this control